From 36d17839ce02e3e2ea0c79cfbd418d3e009db3f5 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Mon, 18 Sep 2023 09:01:31 +0000 Subject: [PATCH] Updated API from documentation release --- ...essUnitAddressCustomFieldAddedMessage.raml | 2 +- ...ustomerAddressCustomFieldAddedMessage.raml | 2 +- ...tomerAddressCustomFieldChangedMessage.raml | 2 +- ...tomerAddressCustomFieldRemovedMessage.raml | 2 +- ...stomerAddressCustomTypeRemovedMessage.raml | 4 +-- .../CustomerAddressCustomTypeSetMessage.raml | 4 +-- .../CustomerCustomFieldAddedMessage.raml | 2 +- .../CustomerCustomFieldChangedMessage.raml | 2 +- .../CustomerCustomFieldRemovedMessage.raml | 4 +-- .../CustomerCustomTypeRemovedMessage.raml | 6 ++-- .../message/CustomerCustomTypeSetMessage.raml | 6 ++-- .../CustomerGroupCustomFieldAddedMessage.raml | 17 +++++++++++ ...ustomerGroupCustomFieldChangedMessage.raml | 21 ++++++++++++++ ...ustomerGroupCustomFieldRemovedMessage.raml | 13 +++++++++ ...CustomerGroupCustomTypeRemovedMessage.raml | 13 +++++++++ .../CustomerGroupCustomTypeSetMessage.raml | 16 ++++++++++ .../message/OrderCustomFieldAddedMessage.raml | 2 +- .../OrderCustomFieldChangedMessage.raml | 2 +- .../OrderCustomFieldRemovedMessage.raml | 2 +- .../OrderCustomTypeRemovedMessage.raml | 4 +-- .../message/OrderCustomTypeSetMessage.raml | 4 +-- ...AddressCustomFieldAddedMessagePayload.raml | 2 +- ...AddressCustomFieldAddedMessagePayload.raml | 2 +- ...dressCustomFieldChangedMessagePayload.raml | 2 +- ...dressCustomFieldRemovedMessagePayload.raml | 2 +- ...ddressCustomTypeRemovedMessagePayload.raml | 4 +-- ...merAddressCustomTypeSetMessagePayload.raml | 4 +-- ...ustomerCustomFieldAddedMessagePayload.raml | 2 +- ...tomerCustomFieldChangedMessagePayload.raml | 2 +- ...tomerCustomFieldRemovedMessagePayload.raml | 4 +-- ...stomerCustomTypeRemovedMessagePayload.raml | 6 ++-- .../CustomerCustomTypeSetMessagePayload.raml | 6 ++-- ...erGroupCustomFieldAddedMessagePayload.raml | 17 +++++++++++ ...GroupCustomFieldChangedMessagePayload.raml | 21 ++++++++++++++ ...GroupCustomFieldRemovedMessagePayload.raml | 13 +++++++++ ...rGroupCustomTypeRemovedMessagePayload.raml | 13 +++++++++ ...tomerGroupCustomTypeSetMessagePayload.raml | 16 ++++++++++ .../OrderCustomFieldAddedMessagePayload.raml | 2 +- ...OrderCustomFieldChangedMessagePayload.raml | 2 +- ...OrderCustomFieldRemovedMessagePayload.raml | 2 +- .../OrderCustomTypeRemovedMessagePayload.raml | 4 +-- .../OrderCustomTypeSetMessagePayload.raml | 4 +-- api-specs/api/types/types.raml | 12 ++++++++ api-specs/graphql/schema.sdl | 29 +++++++++++++++++++ 44 files changed, 239 insertions(+), 62 deletions(-) create mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml create mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml create mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml create mode 100644 api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml create mode 100644 api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml create mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml create mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml create mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml create mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml create mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml index 8aa5edeec..2aab22491 100644 --- a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml +++ b/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml index 772297c65..b61f8425b 100644 --- a/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml +++ b/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml @@ -11,7 +11,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml index e5af78d84..93d241c44 100644 --- a/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml +++ b/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml index c4b1bcad8..05b48911c 100644 --- a/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml +++ b/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml index 77a4e3174..555631e1f 100644 --- a/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml +++ b/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml @@ -10,6 +10,4 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml index 4b608c627..76ce4ea82 100644 --- a/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml +++ b/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml index a0a561895..59b8fa7da 100644 --- a/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml +++ b/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml @@ -11,7 +11,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml index 88522c73e..2bf2370a7 100644 --- a/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml +++ b/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml index c7d3a252f..9c2e0a873 100644 --- a/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml +++ b/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml @@ -5,9 +5,9 @@ type: Message displayName: CustomerCustomFieldRemovedMessage discriminatorValue: CustomerCustomFieldRemoved description: | - Generated after removing a Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. + Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml index 66349c49e..b4d100537 100644 --- a/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml +++ b/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml @@ -5,11 +5,9 @@ type: Message displayName: CustomerCustomTypeRemovedMessage discriminatorValue: CustomerCustomTypeRemoved description: | - Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. + Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml index 12ea06594..251c31d75 100644 --- a/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml +++ b/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml @@ -5,7 +5,7 @@ type: Message displayName: CustomerCustomTypeSetMessage discriminatorValue: CustomerCustomTypeSet description: | - Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. + Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. properties: customFields: type: CustomFields @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml new file mode 100644 index 000000000..b49ce41d0 --- /dev/null +++ b/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml @@ -0,0 +1,17 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-added +type: Message +displayName: CustomerGroupCustomFieldAddedMessage +discriminatorValue: CustomerGroupCustomFieldAdded +description: | + Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. + If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. +properties: + name: + type: string + description: | + Name of the Custom Field that was added. + value: + type: CustomFieldValue + description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml new file mode 100644 index 000000000..0c60d2bb8 --- /dev/null +++ b/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml @@ -0,0 +1,21 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-changed +type: Message +displayName: CustomerGroupCustomFieldChangedMessage +discriminatorValue: CustomerGroupCustomFieldChanged +description: | + Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. +properties: + name: + type: string + description: | + Name of the Custom Field that changed. + value: + type: CustomFieldValue + description: | + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. + oldValue?: + type: CustomFieldValue + description: | + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml new file mode 100644 index 000000000..374cb3258 --- /dev/null +++ b/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml @@ -0,0 +1,13 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-removed +type: Message +displayName: CustomerGroupCustomFieldRemovedMessage +discriminatorValue: CustomerGroupCustomFieldRemoved +description: | + Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. +properties: + name: + type: string + description: | + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml new file mode 100644 index 000000000..cd5d79ec2 --- /dev/null +++ b/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml @@ -0,0 +1,13 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-removed +type: Message +displayName: CustomerGroupCustomTypeRemovedMessage +discriminatorValue: CustomerGroupCustomTypeRemoved +description: | + Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. +properties: + oldTypeId?: + type: string + description: | + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml new file mode 100644 index 000000000..e66673fc5 --- /dev/null +++ b/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml @@ -0,0 +1,16 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-set +type: Message +displayName: CustomerGroupCustomTypeSetMessage +discriminatorValue: CustomerGroupCustomTypeSet +description: | + Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. +properties: + customFields: + type: CustomFields + description: The Custom Fields that have been set. + oldTypeId?: + type: string + description: | + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml b/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml index cf4123158..e366b6ded 100644 --- a/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml b/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml index afd1e7079..f5f11be50 100644 --- a/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml b/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml index d1cad716b..17bbfe66c 100644 --- a/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml b/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml index c4552b69f..197515d86 100644 --- a/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml +++ b/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml @@ -10,6 +10,4 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/OrderCustomTypeSetMessage.raml b/api-specs/api/types/message/OrderCustomTypeSetMessage.raml index c14f03fc7..acd09d3d0 100644 --- a/api-specs/api/types/message/OrderCustomTypeSetMessage.raml +++ b/api-specs/api/types/message/OrderCustomTypeSetMessage.raml @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml index d72048b70..1316a5a6d 100644 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml index 012022121..9a93f08d1 100644 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml @@ -11,7 +11,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml index 8e65676c1..cb350337e 100644 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml index e0f80729a..04ed4b061 100644 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml index bf0910f82..78342f733 100644 --- a/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml @@ -10,6 +10,4 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml index 554ab3d51..8165ce87c 100644 --- a/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml index 6f9440d88..debf60895 100644 --- a/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml @@ -11,7 +11,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml index 65a721357..c60b6c75c 100644 --- a/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml index f1f08d0ff..dbf88426b 100644 --- a/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml @@ -5,9 +5,9 @@ type: MessagePayload displayName: CustomerCustomFieldRemovedMessagePayload discriminatorValue: CustomerCustomFieldRemoved description: | - Generated after removing a Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. + Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml index 06781863b..4aa20c901 100644 --- a/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml @@ -5,11 +5,9 @@ type: MessagePayload displayName: CustomerCustomTypeRemovedMessagePayload discriminatorValue: CustomerCustomTypeRemoved description: | - Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. + Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml index 1c06c413d..d0cbd6658 100644 --- a/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml @@ -5,7 +5,7 @@ type: MessagePayload displayName: CustomerCustomTypeSetMessagePayload discriminatorValue: CustomerCustomTypeSet description: | - Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. + Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. properties: customFields: type: CustomFields @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml new file mode 100644 index 000000000..ba9327ded --- /dev/null +++ b/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml @@ -0,0 +1,17 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-added +type: MessagePayload +displayName: CustomerGroupCustomFieldAddedMessagePayload +discriminatorValue: CustomerGroupCustomFieldAdded +description: | + Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. + If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. +properties: + name: + type: string + description: | + Name of the Custom Field that was added. + value: + type: CustomFieldValue + description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml new file mode 100644 index 000000000..a8c297215 --- /dev/null +++ b/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml @@ -0,0 +1,21 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-changed +type: MessagePayload +displayName: CustomerGroupCustomFieldChangedMessagePayload +discriminatorValue: CustomerGroupCustomFieldChanged +description: | + Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. +properties: + name: + type: string + description: | + Name of the Custom Field that changed. + value: + type: CustomFieldValue + description: | + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. + oldValue?: + type: CustomFieldValue + description: | + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml new file mode 100644 index 000000000..951f29275 --- /dev/null +++ b/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml @@ -0,0 +1,13 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-removed +type: MessagePayload +displayName: CustomerGroupCustomFieldRemovedMessagePayload +discriminatorValue: CustomerGroupCustomFieldRemoved +description: | + Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. +properties: + name: + type: string + description: | + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml new file mode 100644 index 000000000..3f74c664e --- /dev/null +++ b/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml @@ -0,0 +1,13 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-removed +type: MessagePayload +displayName: CustomerGroupCustomTypeRemovedMessagePayload +discriminatorValue: CustomerGroupCustomTypeRemoved +description: | + Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. +properties: + oldTypeId?: + type: string + description: | + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml new file mode 100644 index 000000000..a31aedd7f --- /dev/null +++ b/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml @@ -0,0 +1,16 @@ +#%RAML 1.0 DataType +(package): Message +(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-set +type: MessagePayload +displayName: CustomerGroupCustomTypeSetMessagePayload +discriminatorValue: CustomerGroupCustomTypeSet +description: | + Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. +properties: + customFields: + type: CustomFields + description: The Custom Fields that have been set. + oldTypeId?: + type: string + description: | + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml index 37105207c..3fa4cb18e 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been added. + Name of the Custom Field that was added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml index 9360f30e7..7dd05fe1c 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that has been changed. + Name of the Custom Field that changed. value: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml index 0fb2fd6f6..9083a9d6e 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that has been removed. + Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml index fd2a3fe84..1b02b12eb 100644 --- a/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml @@ -10,6 +10,4 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that has been removed. - - Absent when there has not been a Custom Type before. + `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml index a746363a9..31d102db3 100644 --- a/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml @@ -13,6 +13,4 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). - - Absent when there has not been a Custom Type before. + `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml index 0370120c0..b1a48e9d3 100644 --- a/api-specs/api/types/types.raml +++ b/api-specs/api/types/types.raml @@ -833,6 +833,11 @@ CustomerDeletedMessage: !include message/CustomerDeletedMessage.raml CustomerEmailChangedMessage: !include message/CustomerEmailChangedMessage.raml CustomerEmailVerifiedMessage: !include message/CustomerEmailVerifiedMessage.raml CustomerFirstNameSetMessage: !include message/CustomerFirstNameSetMessage.raml +CustomerGroupCustomFieldAddedMessage: !include message/CustomerGroupCustomFieldAddedMessage.raml +CustomerGroupCustomFieldChangedMessage: !include message/CustomerGroupCustomFieldChangedMessage.raml +CustomerGroupCustomFieldRemovedMessage: !include message/CustomerGroupCustomFieldRemovedMessage.raml +CustomerGroupCustomTypeRemovedMessage: !include message/CustomerGroupCustomTypeRemovedMessage.raml +CustomerGroupCustomTypeSetMessage: !include message/CustomerGroupCustomTypeSetMessage.raml CustomerGroupSetMessage: !include message/CustomerGroupSetMessage.raml CustomerLastNameSetMessage: !include message/CustomerLastNameSetMessage.raml CustomerPasswordUpdatedMessage: !include message/CustomerPasswordUpdatedMessage.raml @@ -1051,6 +1056,13 @@ CustomerDeletedMessagePayload: !include message/payload/CustomerDeletedMessagePa CustomerEmailChangedMessagePayload: !include message/payload/CustomerEmailChangedMessagePayload.raml CustomerEmailVerifiedMessagePayload: !include message/payload/CustomerEmailVerifiedMessagePayload.raml CustomerFirstNameSetMessagePayload: !include message/payload/CustomerFirstNameSetMessagePayload.raml +CustomerGroupCustomFieldAddedMessagePayload: !include message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml +# yamllint disable-line rule:line-length +CustomerGroupCustomFieldChangedMessagePayload: !include message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml +# yamllint disable-line rule:line-length +CustomerGroupCustomFieldRemovedMessagePayload: !include message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml +CustomerGroupCustomTypeRemovedMessagePayload: !include message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml +CustomerGroupCustomTypeSetMessagePayload: !include message/payload/CustomerGroupCustomTypeSetMessagePayload.raml CustomerGroupSetMessagePayload: !include message/payload/CustomerGroupSetMessagePayload.raml CustomerLastNameSetMessagePayload: !include message/payload/CustomerLastNameSetMessagePayload.raml CustomerPasswordUpdatedMessagePayload: !include message/payload/CustomerPasswordUpdatedMessagePayload.raml diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl index 462494326..88797b66b 100644 --- a/api-specs/graphql/schema.sdl +++ b/api-specs/graphql/schema.sdl @@ -3246,6 +3246,35 @@ type CustomerGroup implements Versioned & ReferenceExpandable { lastModifiedBy: Initiator } +type CustomerGroupCustomFieldAdded implements MessagePayload { + name: String! + value: Json! + type: String! +} + +type CustomerGroupCustomFieldChanged implements MessagePayload { + name: String! + value: Json! + oldValue: Json + type: String! +} + +type CustomerGroupCustomFieldRemoved implements MessagePayload { + name: String! + type: String! +} + +type CustomerGroupCustomTypeRemoved implements MessagePayload { + oldTypeId: String + type: String! +} + +type CustomerGroupCustomTypeSet implements MessagePayload { + customFields: CustomFieldsType! + oldTypeId: String + type: String! +} + input CustomerGroupDraft { groupName: String! key: String