From d74a87f613d9efd31448c3b11f505f7bf6bf57c0 Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Wed, 10 Jul 2024 08:20:15 +0000 Subject: [PATCH] Updated API from documentation release --- .../BusinessUnitAddressCustomFieldAddedMessage.raml | 4 ++++ .../BusinessUnitAddressCustomFieldChangedMessage.raml | 4 ++++ .../BusinessUnitAddressCustomFieldRemovedMessage.raml | 4 ++++ .../BusinessUnitAddressCustomTypeRemovedMessage.raml | 4 ++++ .../BusinessUnitAddressCustomTypeSetMessage.raml | 4 ++++ .../CustomerAddressCustomFieldAddedMessage.raml | 4 ++++ .../CustomerAddressCustomFieldChangedMessage.raml | 4 ++++ .../CustomerAddressCustomFieldRemovedMessage.raml | 4 ++++ .../CustomerAddressCustomTypeRemovedMessage.raml | 4 ++++ .../message/CustomerAddressCustomTypeSetMessage.raml | 4 ++++ ...inessUnitAddressCustomFieldAddedMessagePayload.raml | 4 ++++ ...essUnitAddressCustomFieldChangedMessagePayload.raml | 4 ++++ ...essUnitAddressCustomFieldRemovedMessagePayload.raml | 4 ++++ ...nessUnitAddressCustomTypeRemovedMessagePayload.raml | 4 ++++ ...BusinessUnitAddressCustomTypeSetMessagePayload.raml | 4 ++++ .../CustomerAddressCustomFieldAddedMessagePayload.raml | 4 ++++ ...ustomerAddressCustomFieldChangedMessagePayload.raml | 4 ++++ ...ustomerAddressCustomFieldRemovedMessagePayload.raml | 4 ++++ ...CustomerAddressCustomTypeRemovedMessagePayload.raml | 4 ++++ .../CustomerAddressCustomTypeSetMessagePayload.raml | 4 ++++ api-specs/graphql/schema.sdl | 10 ++++++++++ 21 files changed, 90 insertions(+) diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml index 77a150ce5..0b3612fbe 100644 --- 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 index de24bbf0f..d920d144b 100644 --- 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 index f0374235b..db5440f69 100644 --- 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 index cc3ca056d..94588be03 100644 --- 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 index 7244528ef..938587eaf 100644 --- 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 index f38655011..29c6572a0 100644 --- 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 index 9f8e661b6..edd4648c3 100644 --- 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 index 008ad307a..93a6830f0 100644 --- 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 index 836e52e3d..c74df7b29 100644 --- 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 index cb25cdb20..f2e56969a 100644 --- 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 index bf6d4d91e..dcb9e2fee 100644 --- 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 index 62a0e1680..598bf53a9 100644 --- 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 index bf1ed4f4b..8a106f200 100644 --- 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 index 6541708b2..e9884bf6f 100644 --- 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 index 149a724ec..95ee8ed00 100644 --- 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 index b292fea01..4252ca4ef 100644 --- 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 index 29de751f1..23c7222e1 100644 --- 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 index 6ce87affd..15a91eb96 100644 --- 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 index e07488a01..ed34323d4 100644 --- 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 index b9b24b948..4a1cf791d 100644 --- 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 index 5d645c269..95e4127fa 100644 --- a/api-specs/graphql/schema.sdl +++ b/api-specs/graphql/schema.sdl @@ -1380,6 +1380,7 @@ type BusinessUnitAddressChanged implements MessagePayload { type BusinessUnitAddressCustomFieldAdded implements MessagePayload { name: String! value: Json! + addressId: String type: String! } @@ -1387,22 +1388,26 @@ 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,6 +3422,7 @@ type CustomerAddressChanged implements MessagePayload { type CustomerAddressCustomFieldAdded implements MessagePayload { name: String! value: Json! + addressId: String type: String! } @@ -3424,22 +3430,26 @@ 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! }