Updated API from documentation release

commercetools · Jul 10, 2024 · d74a87f · d74a87f
1 parent efca8fe
commit d74a87f
Show file tree

Hide file tree

Showing 21 changed files with 90 additions and 0 deletions.
diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml
@@ -13,3 +13,7 @@ properties:
   value:
     type: CustomFieldValue
     description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) to which the Custom Field was added.
diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml
@@ -18,3 +18,7 @@ properties:
     type: CustomFieldValue
     description: |
       [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) of which the Custom Field was changed.
diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       Name of the Custom Field that was removed.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Field was removed.
diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Type was removed.
diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml
@@ -13,3 +13,7 @@ properties:
     type: string
     description: |
       `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) on which the Custom Field was set.
diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml
@@ -14,3 +14,7 @@ properties:
   value:
     type: CustomFieldValue
     description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) to which the Custom Field was added.
diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml
@@ -19,3 +19,7 @@ properties:
     description: |
       [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
       When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) of which the Custom Field was changed.
diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       Name of the Custom Field that was removed.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Field was removed.
diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Type was removed.
diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml
@@ -13,3 +13,7 @@ properties:
     type: string
     description: |
       `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) on which the Custom Field was set.
diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml
@@ -13,3 +13,7 @@ properties:
   value:
     type: CustomFieldValue
     description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) to which the Custom Field was added.
diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml
@@ -18,3 +18,7 @@ properties:
     type: CustomFieldValue
     description: |
       [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) of which the Custom Field was changed.
diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       Name of the Custom Field that was removed.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Field was removed.
diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Type was removed.
diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml
@@ -13,3 +13,7 @@ properties:
     type: string
     description: |
       `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) on which the Custom Field was set.
diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml
@@ -14,3 +14,7 @@ properties:
   value:
     type: CustomFieldValue
     description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) to which the Custom Field was added.
diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml
@@ -19,3 +19,7 @@ properties:
     description: |
       [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
       When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) of which the Custom Field was changed.
diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       Name of the Custom Field that was removed.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Field was removed.
diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml
@@ -10,3 +10,7 @@ properties:
     type: string
     description: |
       `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) from which the Custom Type was removed.
diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml
@@ -13,3 +13,7 @@ properties:
     type: string
     description: |
       `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
+  addressId?:
+    type: string
+    description: |
+      `id` of the [Address](ctp:api:type:Address) on which the Custom Field was set.
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -1380,29 +1380,34 @@ type BusinessUnitAddressChanged implements MessagePayload {
 type BusinessUnitAddressCustomFieldAdded implements MessagePayload {
   name: String!
   value: Json!
+  addressId: String
   type: String!
 }
 
 type BusinessUnitAddressCustomFieldChanged implements MessagePayload {
   name: String!
   value: Json!
   oldValue: Json
+  addressId: String
   type: String!
 }
 
 type BusinessUnitAddressCustomFieldRemoved implements MessagePayload {
   name: String!
+  addressId: String
   type: String!
 }
 
 type BusinessUnitAddressCustomTypeRemoved implements MessagePayload {
   oldTypeId: String
+  addressId: String
   type: String!
 }
 
 type BusinessUnitAddressCustomTypeSet implements MessagePayload {
   customFields: CustomFieldsType!
   oldTypeId: String
+  addressId: String
   type: String!
 }
 
@@ -3417,29 +3422,34 @@ type CustomerAddressChanged implements MessagePayload {
 type CustomerAddressCustomFieldAdded implements MessagePayload {
   name: String!
   value: Json!
+  addressId: String
   type: String!
 }
 
 type CustomerAddressCustomFieldChanged implements MessagePayload {
   name: String!
   value: Json!
   previousValue: Json
+  addressId: String
   type: String!
 }
 
 type CustomerAddressCustomFieldRemoved implements MessagePayload {
   name: String!
+  addressId: String
   type: String!
 }
 
 type CustomerAddressCustomTypeRemoved implements MessagePayload {
   previousTypeId: String
+  addressId: String
   type: String!
 }
 
 type CustomerAddressCustomTypeSet implements MessagePayload {
   customFields: CustomFieldsType!
   previousTypeId: String
+  addressId: String
   type: String!
 }