Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
Auto Mation committed Sep 8, 2023
1 parent b8bfc5f commit 0d72adb
Show file tree
Hide file tree
Showing 36 changed files with 423 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: BusinessUnitUpdateAction
displayName: BusinessUnitSetAddressCustomFieldAction
discriminatorValue: setAddressCustomField
example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json
description: |
Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message.
properties:
addressId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: BusinessUnitUpdateAction
displayName: BusinessUnitSetAddressCustomTypeAction
discriminatorValue: setAddressCustomType
example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json
description: |
Adding or updating a Custom Type on an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message.
properties:
type?:
type: TypeResourceIdentifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ type: BusinessUnitUpdateAction
displayName: BusinessUnitSetCustomFieldAction
discriminatorValue: setCustomField
example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json
description: |
Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message.
properties:
name:
type: string
description: |
Name of the [Custom Field](/../api/projects/custom-fields).
Name of the [Custom Field](/../api/projects/custom-fields) to add, update, or remove.
value?:
type: CustomFieldValue
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: BusinessUnitUpdateAction
displayName: BusinessUnitSetCustomTypeAction
discriminatorValue: setCustomType
example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json
description: |
Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message.
properties:
type?:
type: TypeResourceIdentifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: MyBusinessUnitUpdateAction
displayName: MyBusinessUnitSetAddressCustomFieldAction
example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json
discriminatorValue: setAddressCustomField
description: |
Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message.
properties:
addressId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: MyBusinessUnitUpdateAction
displayName: MyBusinessUnitSetAddressCustomTypeAction
example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json
discriminatorValue: setAddressCustomType
description: |
Adding or updating a Custom Type to an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message.
properties:
type?:
type: TypeResourceIdentifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: MyBusinessUnitUpdateAction
displayName: MyBusinessUnitSetCustomFieldAction
example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json
discriminatorValue: setCustomField
description: |
Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message.
properties:
name:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ type: MyBusinessUnitUpdateAction
displayName: MyBusinessUnitSetCustomTypeAction
example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json
discriminatorValue: setCustomType
description: |
Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message.
properties:
type?:
type: TypeResourceIdentifier
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-added
type: Message
displayName: BusinessUnitAddressCustomFieldAddedMessage
discriminatorValue: BusinessUnitAddressCustomFieldAdded
description: |
Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field exists already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead.
properties:
name:
type: string
description: |
Name of the Custom Field that has been added.
value:
type: CustomFieldValue
description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-changed
type: Message
displayName: BusinessUnitAddressCustomFieldChangedMessage
discriminatorValue: BusinessUnitAddressCustomFieldChanged
description: |
Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) 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:BusinessUnitSetAddressCustomFieldAction) 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:BusinessUnitSetAddressCustomFieldAction) update action.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-removed
type: Message
displayName: BusinessUnitAddressCustomFieldRemovedMessage
discriminatorValue: BusinessUnitAddressCustomFieldRemoved
description: |
Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
properties:
name:
type: string
description: |
Name of the Custom Field that was removed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-removed
type: Message
displayName: BusinessUnitAddressCustomTypeRemovedMessage
discriminatorValue: BusinessUnitAddressCustomTypeRemoved
description: |
Generated after removing a Custom Type from an address of a Business Unit using the [Set CustomType in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-set
type: Message
displayName: BusinessUnitAddressCustomTypeSetMessage
discriminatorValue: BusinessUnitAddressCustomTypeSet
description: |
Generated after adding a Custom Type to an address of a Business Unit using the [Set CustomType in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
properties:
customFields:
type: CustomFields
description: The Custom Fields that were set.
oldTypeId?:
type: string
description: |
`id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-added
type: Message
displayName: BusinessUnitCustomFieldAddedMessage
discriminatorValue: BusinessUnitCustomFieldAdded
description: |
Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field exists already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) 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).
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-changed
type: Message
displayName: BusinessUnitCustomFieldChangedMessage
discriminatorValue: BusinessUnitCustomFieldChanged
description: |
Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) 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:BusinessUnitSetCustomFieldAction) 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:BusinessUnitSetCustomFieldAction) update action.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-removed
type: Message
displayName: BusinessUnitCustomFieldRemovedMessage
discriminatorValue: BusinessUnitCustomFieldRemoved
description: |
Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
properties:
name:
type: string
description: |
Name of the Custom Field that was removed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-removed
type: Message
displayName: BusinessUnitCustomTypeRemovedMessage
discriminatorValue: BusinessUnitCustomTypeRemoved
description: |
Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
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.
16 changes: 16 additions & 0 deletions api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-set
type: Message
displayName: BusinessUnitCustomTypeSetMessage
discriminatorValue: BusinessUnitCustomTypeSet
description: |
Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
properties:
customFields:
type: CustomFields
description: The Custom Fields that were set.
oldTypeId?:
type: string
description: |
`id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ properties:
value:
type: CustomFieldValue
description: |
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set Custom Field](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
previousValue?:
type: CustomFieldValue
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ properties:
value:
type: CustomFieldValue
description: |
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set Custom Field](ctp:api:type:CustomerSetCustomFieldAction) update action.
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
previousValue?:
type: CustomFieldValue
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ properties:
value:
type: CustomFieldValue
description: |
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set Custom Field](ctp:api:type:OrderSetCustomFieldAction) update action.
[CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action.
previousValue?:
type: CustomFieldValue
description: |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-added
type: MessagePayload
displayName: BusinessUnitAddressCustomFieldAddedMessagePayload
discriminatorValue: BusinessUnitAddressCustomFieldAdded
description: |
Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field exists already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead.
properties:
name:
type: string
description: |
Name of the Custom Field that has been added.
value:
type: CustomFieldValue
description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType).
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-changed
type: MessagePayload
displayName: BusinessUnitAddressCustomFieldChangedMessagePayload
discriminatorValue: BusinessUnitAddressCustomFieldChanged
description: |
Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) 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:BusinessUnitSetAddressCustomFieldAction) 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:BusinessUnitSetAddressCustomFieldAction) update action.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-removed
type: MessagePayload
displayName: BusinessUnitAddressCustomFieldRemovedMessagePayload
discriminatorValue: BusinessUnitAddressCustomFieldRemoved
description: |
Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
properties:
name:
type: string
description: |
Name of the Custom Field that was removed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-removed
type: MessagePayload
displayName: BusinessUnitAddressCustomTypeRemovedMessagePayload
discriminatorValue: BusinessUnitAddressCustomTypeRemoved
description: |
Generated after removing a Custom Type from an address of a Business Unit using the [Set CustomType in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-set
type: MessagePayload
displayName: BusinessUnitAddressCustomTypeSetMessagePayload
discriminatorValue: BusinessUnitAddressCustomTypeSet
description: |
Generated after adding a Custom Type to an address of a Business Unit using the [Set CustomType in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
properties:
customFields:
type: CustomFields
description: The Custom Fields that were set.
oldTypeId?:
type: string
description: |
`id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#%RAML 1.0 DataType
(package): Message
(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-added
type: MessagePayload
displayName: BusinessUnitCustomFieldAddedMessagePayload
discriminatorValue: BusinessUnitCustomFieldAdded
description: |
Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field exists already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) 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).
Loading

0 comments on commit 0d72adb

Please sign in to comment.