Updated API from documentation release

commercetools · Aug 21, 2023 · 8aae112 · 8aae112
1 parent 1fc1e9c
commit 8aae112
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 42 deletions.
diff --git a/api-specs/history/api.raml b/api-specs/history/api.raml
@@ -206,16 +206,24 @@ resourceTypes:
           [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
 
           Can be used to query changes made by a Merchant Center user.
+      clientId?:
+        type: string
+        description: |
+          [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change.
+      customerId?:
+        type: string
+        description: |
+          [ID](/general-concepts#identifier) of the [Customer](ctp:api:type:Customer) who made the change using a token from the [password flow](/authorization#password-flow).
+      associateId?:
+        type: string
+        description: |
+          [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered.
       type?:
         type: string
         description: |
           Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`.
 
           Can be used to filter for a specific type of change (creation, update, or deletion).
-      clientId?:
-        type: string
-        description: |
-          [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change.
       resourceId?:
         type: string
         description: |
@@ -237,10 +245,6 @@ resourceTypes:
         type: string[]
         description: |
           `key` of the [Store](ctp:api:type:Store) linked to the Change.
-      customerId?:
-        type: string
-        description: |
-          [ID](/general-concepts#identifier) of the [Customer](ctp:api:type:Customer) who made the change using a token from the [password flow](/authorization#password-flow).
       excludePlatformInitiatedChanges?:
         description: |
           Excludes [Changes](ctp:history:type:Change) initiated by background processes by passing the values of the `change` field.
@@ -352,15 +356,23 @@ resourceTypes:
           description: |
             [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
             Can be used to query changes made by a Merchant Center user.
+        clientId?:
+          type: string
+          description: |
+            [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change.
+        customerId?:
+          type: string
+          description: |
+            [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow).
+        associateId?:
+          type: string
+          description: |
+            [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered.
         type?:
           type: string
           description: |
             Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`.
             Can be used to filter for a specific type of change.
-        clientId?:
-          type: string
-          description: |
-            [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change.
         resourceKey?:
           type: string
           description: |
@@ -378,10 +390,6 @@ resourceTypes:
           type: string[]
           description: |
             `key` of the [Store](/api/projects/stores#store) linked to the Change.
-        customerId?:
-          type: string
-          description: |
-            [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow).
         excludePlatformInitiatedChanges?:
           description: |
             Exclude [Changes](/history/change-types#change) initiated by background processes by passing the values of the `change` field.
@@ -460,15 +468,23 @@ resourceTypes:
             description: |
               [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
               Can be used to query changes made by a Merchant Center user.
+          clientId?:
+            type: string
+            description: |
+              [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change.
+          customerId?:
+            type: string
+            description: |
+              [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow).
+          associateId?:
+            type: string
+            description: |
+              [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered.
           type?:
             type: string
             description: |
               Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`.
               Can be used to filter for a specific type of change.
-          clientId?:
-            type: string
-            description: |
-              [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change.
           source?:
             type: string
             description: |
@@ -482,10 +498,6 @@ resourceTypes:
             type: string[]
             description: |
               `key` of the [Store](/api/projects/stores#store) linked to the Change.
-          customerId?:
-            type: string
-            description: |
-              [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow).
           excludePlatformInitiatedChanges?:
             description: |
               Exclude [Changes](/history/change-types#change) initiated by background processes by passing the values of the `change` field.

diff --git a/api-specs/history/examples/ModifiedBy.json b/api-specs/history/examples/ModifiedBy.json
@@ -5,7 +5,5 @@
   "customer": {
     "id": "test1",
     "typeId": "customer"
-  },
-  "anonymousId": "",
-  "clientId": ""
+  }
 }
diff --git a/api-specs/history/examples/Record.json b/api-specs/history/examples/Record.json
@@ -10,9 +10,7 @@
     "customer": {
       "id": "test1",
       "typeId": "customer"
-    },
-    "anonymousId": "",
-    "clientId": ""
+    }
   },
   "resource": {
     "id": "some_entity_id_123",

diff --git a/api-specs/history/examples/RecordPagedQueryResponse.json b/api-specs/history/examples/RecordPagedQueryResponse.json
@@ -16,9 +16,7 @@
         "customer": {
           "id": "test1",
           "typeId": "customer"
-        },
-        "anonymousId": "",
-        "clientId": ""
+        }
       },
       "resource": {
         "id": "some_entity_id_123",
@@ -34,7 +32,7 @@
         "type": "StringLabel"
       },
       "withoutChanges": false,
-      "stores":[{ "key": "store-1", "typeId": "store" }],
+      "stores": [{ "key": "store-1", "typeId": "store" }],
       "changes": [
         {
           "change": "setKey",

diff --git a/api-specs/history/types/ModifiedBy.raml b/api-specs/history/types/ModifiedBy.raml
@@ -19,22 +19,27 @@ properties:
 
       - If the change was made by a user, the value is `"user"`.
       - If the change was made by an API Client with or without an [external user ID](/client-logging#external-user-ids), the value is `"external-user"`.
-  customer?:
-    type: Reference
+      - If the change was made by an [Associate](ctp:api:type:Associate), the value is `"associate"`.
+  clientId?:
+    type: string
     description: |
-      [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who made the change.
+      [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change.
 
-      Present only if the change was made using a token from the [password flow](/authorization#password-flow).
+      Present only if the change was made using an API Client.
   anonymousId?:
     type: string
     description: |
       Present only if the change was made using a token from an [anonymous session](/authorization#tokens-for-anonymous-sessions).
-  clientId?:
-    type: string
+  customer?:
+    type: Reference
     description: |
-      [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change.
+      The [Customer](ctp:api:type:Customer) who made the change.
 
-      Present only if the change was made using an API Client.
+      Present only if the change was made using a token from the [password flow](/authorization#password-flow).
+  associate?:
+    type: Reference
+    description: |
+      The [Associate](ctp:api:type:Associate) who made the change in the context of a [Business Unit](ctp:api:type:BusinessUnit). Present only if the Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints).
   isPlatformClient:
     type: boolean
     description: |