Updated API from documentation release

commercetools · Apr 5, 2024 · a9d748d · a9d748d
1 parent a374474
commit a9d748d
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 0 deletions.
diff --git a/api-specs/api/types/common/Attribution.raml b/api-specs/api/types/common/Attribution.raml
@@ -0,0 +1,14 @@
+#%RAML 1.0 DataType
+(package): Common
+displayName: Attribution
+type: object
+description: Indicates the source and method that indirectly created or modified the resource. This is present on resources created or updated after 1 April 2024.
+properties:
+  clientId?:
+    type: string
+    description: |
+      `id` of the [API Client](ctp:api:type:ApiClient) that created or modified the resource.
+  source:
+    type: AttributionSource
+    description: |
+      Method used to initiate the creation or modification of the resource.
diff --git a/api-specs/api/types/common/AttributionSource.raml b/api-specs/api/types/common/AttributionSource.raml
@@ -0,0 +1,10 @@
+#%RAML 1.0 DataType
+(package): Common
+displayName: AttributionSource
+type: string
+enum:
+  - Import
+  - Export
+(enumDescriptions):
+  Import: Resource was created or updated during import.
+  Export: Resource was created or updated during export.
diff --git a/api-specs/api/types/common/CreatedBy.raml b/api-specs/api/types/common/CreatedBy.raml
@@ -21,6 +21,10 @@ properties:
     type: string
     description: |
       Indicates the [anonymous session](ctp:api:type:AnonymousSession) during which the resource was created.
+  attributedTo?:
+    type: Attribution
+    description: |
+      Indicates if the resource was created indirectly.
   associate?:
     type: CustomerReference
     description: |

diff --git a/api-specs/api/types/common/LastModifiedBy.raml b/api-specs/api/types/common/LastModifiedBy.raml
@@ -21,6 +21,10 @@ properties:
     type: string
     description: |
       Indicates the [anonymous session](ctp:api:type:AnonymousSession) during which the resource was modified.
+  attributedTo?:
+    type: Attribution
+    description: |
+      Indicates if the resource was modified indirectly.
   associate?:
     type: CustomerReference
     description: |

diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -350,6 +350,8 @@ Asset: !include common/Asset.raml
 AssetDimensions: !include common/AssetDimensions.raml
 AssetDraft: !include common/AssetDraft.raml
 AssetSource: !include common/AssetSource.raml
+Attribution: !include common/Attribution.raml
+AttributionSource: !include common/AttributionSource.raml
 BaseAddress: !include common/BaseAddress.raml
 BaseResource: !include common/BaseResource.raml
 CentPrecisionMoney: !include common/CentPrecisionMoney.raml

diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -1213,6 +1213,17 @@ input AttributeTypeDraft {
   ltext: SimpleAttributeTypeDraft
 }
 
+type Attribution {
+  clientId: String
+  source: AttributionSource!
+  userRef: Reference
+}
+
+enum AttributionSource {
+  Export
+  Import
+}
+
 "AuthenticationMode values."
 enum AuthenticationMode {
   ExternalAuth
@@ -4672,6 +4683,7 @@ type Initiator {
   isPlatformClient: Boolean
   externalUserId: String
   anonymousId: String
+  attributedTo: Attribution
   clientId: String
   customerRef: Reference
   userRef: Reference