-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated API from documentation release
- Loading branch information
Auto Mation
committed
Sep 8, 2023
1 parent
b8bfc5f
commit 0d72adb
Showing
36 changed files
with
423 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
21 changes: 21 additions & 0 deletions
21
api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/BusinessUnitCustomFieldAddedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
21 changes: 21 additions & 0 deletions
21
api-specs/api/types/message/BusinessUnitCustomFieldChangedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/BusinessUnitCustomFieldRemovedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/BusinessUnitCustomTypeRemovedMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
16
api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
21 changes: 21 additions & 0 deletions
21
api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
13 changes: 13 additions & 0 deletions
13
api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
16 changes: 16 additions & 0 deletions
16
api-specs/api/types/message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
Oops, something went wrong.