Updated API from documentation release

commercetools · Sep 18, 2023 · 36d1783 · 36d1783
1 parent 32305f5
commit 36d1783
Show file tree

Hide file tree

Showing 44 changed files with 239 additions and 62 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -5,14 +5,12 @@ 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
     description: The Custom Fields that have been set.
   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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -5,14 +5,12 @@ 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
     description: The Custom Fields that have been set.
   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
@@ -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
@@ -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
@@ -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.