Skip to content

Commit 48dc5d5

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 91a462d commit 48dc5d5

11 files changed

+111
-0
lines changed

‎api-specs/api/types/customer/updates/CustomerSetDefaultBillingAddressAction.raml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ example: !include ../../../examples/Customer/CustomerSetDefaultBillingAddressAct
77
description: |
88
Sets the default billing address from `addresses`.
99
The action adds the `id` of the specified Address to the `billingAddressIds` if not contained already. Either `addressId` or `addressKey` is required.
10+
11+
This action generates the [CustomerDefaultBillingAddressSet](ctp:api:type:CustomerDefaultBillingAddressSetMessage) Message.
1012
properties:
1113
addressId?:
1214
type: string

‎api-specs/api/types/customer/updates/CustomerSetDefaultShippingAddressAction.raml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ description: |
88
Sets the default shipping address from `addresses`.
99
The action adds the `id` of the specified address to the `shippingAddressIds` if not contained already. Either `addressId` or `addressKey` is required.
1010
11+
This action generates the [CustomerDefaultShippingAddressSet](ctp:api:type:CustomerDefaultShippingAddressSetMessage) Message.
1112
properties:
1213
addressId?:
1314
type: string

‎api-specs/api/types/customer/updates/CustomerSetStoresAction.raml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ example: !include ../../../examples/Customer/CustomerSetStoresAction.json
77
description: |
88
Sets the Stores the Customer account is associated with.
99
If no Stores are specified, the Customer becomes a [global Customer](/../api/customers-overview#global-versus-store-specific-customers).
10+
11+
This action generates the [CustomerStoresSet](ctp:api:type:CustomerStoresSetMessage) Message.
1012
properties:
1113
stores:
1214
type: StoreResourceIdentifier[]

‎api-specs/api/types/message/CustomerDefaultBillingAddressSetMessage.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: CustomerDefaultBillingAddressSetMessage
5+
discriminatorValue: CustomerDefaultBillingAddressSet
6+
description: |
7+
Generated after a successful [Set Default Billing Address](ctp:api:type:CustomerSetDefaultBillingAddressAction) update action.
8+
properties:
9+
address?:
10+
type: Address
11+
description: |
12+
The address that was set as the default billing address.

‎api-specs/api/types/message/CustomerDefaultShippingAddressSetMessage.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: CustomerDefaultShippingAddressSetMessage
5+
discriminatorValue: CustomerDefaultShippingAddressSet
6+
description: |
7+
Generated after a successful [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction) update action.
8+
properties:
9+
address?:
10+
type: Address
11+
description: |
12+
The address that was set as the default shipping address.

‎api-specs/api/types/message/CustomerStoresSetMessage.raml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: CustomerStoresSetMessage
5+
discriminatorValue: CustomerStoresSet
6+
description: |
7+
Generated after a successful [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.
8+
properties:
9+
stores:
10+
type: StoreKeyReference[]
11+
description: |
12+
The [Stores](ctp:api:type:Store) the [Customer](ctp:api:type:Customer) is associated with after the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.
13+
oldStores:
14+
type: StoreKeyReference[]
15+
description: |
16+
The [Stores](ctp:api:type:Store) the [Customer](ctp:api:type:Customer) was associated with before the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.

‎api-specs/api/types/message/payload/CustomerDefaultBillingAddressSetMessagePayload.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: CustomerDefaultBillingAddressSetMessagePayload
5+
discriminatorValue: CustomerDefaultBillingAddressSet
6+
description: |
7+
Generated after a successful [Set Default Billing Address](ctp:api:type:CustomerSetDefaultBillingAddressAction) update action.
8+
properties:
9+
address?:
10+
type: Address
11+
description: |
12+
The address that was set as the default billing address.

‎api-specs/api/types/message/payload/CustomerDefaultShippingAddressSetMessagePayload.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: CustomerDefaultShippingAddressSetMessagePayload
5+
discriminatorValue: CustomerDefaultShippingAddressSet
6+
description: |
7+
Generated after a successful [Set Default Shipping Address](ctp:api:type:CustomerSetDefaultShippingAddressAction) update action.
8+
properties:
9+
address?:
10+
type: Address
11+
description: |
12+
The address that was set as the default shipping address.

‎api-specs/api/types/message/payload/CustomerStoresSetMessagePayload.raml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: CustomerStoresSetMessagePayload
5+
discriminatorValue: CustomerStoresSet
6+
description: |
7+
Generated after a successful [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.
8+
properties:
9+
stores:
10+
type: StoreKeyReference[]
11+
description: |
12+
The [Stores](ctp:api:type:Store) the [Customer](ctp:api:type:Customer) is associated with after the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.
13+
oldStores:
14+
type: StoreKeyReference[]
15+
description: |
16+
The [Stores](ctp:api:type:Store) the [Customer](ctp:api:type:Customer) was associated with before the [Set Stores](ctp:api:type:CustomerSetStoresAction) update action.

‎api-specs/api/types/types.raml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,8 @@ CustomerCustomFieldRemovedMessage: !include message/CustomerCustomFieldRemovedMe
977977
CustomerCustomTypeRemovedMessage: !include message/CustomerCustomTypeRemovedMessage.raml
978978
CustomerCustomTypeSetMessage: !include message/CustomerCustomTypeSetMessage.raml
979979
CustomerDateOfBirthSetMessage: !include message/CustomerDateOfBirthSetMessage.raml
980+
CustomerDefaultBillingAddressSetMessage: !include message/CustomerDefaultBillingAddressSetMessage.raml
981+
CustomerDefaultShippingAddressSetMessage: !include message/CustomerDefaultShippingAddressSetMessage.raml
980982
CustomerDeletedMessage: !include message/CustomerDeletedMessage.raml
981983
CustomerEmailChangedMessage: !include message/CustomerEmailChangedMessage.raml
982984
CustomerEmailTokenCreatedMessage: !include message/CustomerEmailTokenCreatedMessage.raml
@@ -994,6 +996,7 @@ CustomerGroupSetMessage: !include message/CustomerGroupSetMessage.raml
994996
CustomerLastNameSetMessage: !include message/CustomerLastNameSetMessage.raml
995997
CustomerPasswordTokenCreatedMessage: !include message/CustomerPasswordTokenCreatedMessage.raml
996998
CustomerPasswordUpdatedMessage: !include message/CustomerPasswordUpdatedMessage.raml
999+
CustomerStoresSetMessage: !include message/CustomerStoresSetMessage.raml
9971000
CustomerTitleSetMessage: !include message/CustomerTitleSetMessage.raml
9981001
DeliveryAddedMessage: !include message/DeliveryAddedMessage.raml
9991002
DeliveryAddressSetMessage: !include message/DeliveryAddressSetMessage.raml
@@ -1297,6 +1300,10 @@ CustomerCustomFieldRemovedMessagePayload: !include message/payload/CustomerCusto
12971300
CustomerCustomTypeRemovedMessagePayload: !include message/payload/CustomerCustomTypeRemovedMessagePayload.raml
12981301
CustomerCustomTypeSetMessagePayload: !include message/payload/CustomerCustomTypeSetMessagePayload.raml
12991302
CustomerDateOfBirthSetMessagePayload: !include message/payload/CustomerDateOfBirthSetMessagePayload.raml
1303+
# yamllint disable-line rule:line-length
1304+
CustomerDefaultBillingAddressSetMessagePayload: !include message/payload/CustomerDefaultBillingAddressSetMessagePayload.raml
1305+
# yamllint disable-line rule:line-length
1306+
CustomerDefaultShippingAddressSetMessagePayload: !include message/payload/CustomerDefaultShippingAddressSetMessagePayload.raml
13001307
CustomerDeletedMessagePayload: !include message/payload/CustomerDeletedMessagePayload.raml
13011308
CustomerEmailChangedMessagePayload: !include message/payload/CustomerEmailChangedMessagePayload.raml
13021309
CustomerEmailTokenCreatedMessagePayload: !include message/payload/CustomerEmailTokenCreatedMessagePayload.raml
@@ -1316,6 +1323,7 @@ CustomerGroupSetMessagePayload: !include message/payload/CustomerGroupSetMessage
13161323
CustomerLastNameSetMessagePayload: !include message/payload/CustomerLastNameSetMessagePayload.raml
13171324
CustomerPasswordTokenCreatedMessagePayload: !include message/payload/CustomerPasswordTokenCreatedMessagePayload.raml
13181325
CustomerPasswordUpdatedMessagePayload: !include message/payload/CustomerPasswordUpdatedMessagePayload.raml
1326+
CustomerStoresSetMessagePayload: !include message/payload/CustomerStoresSetMessagePayload.raml
13191327
CustomerTitleSetMessagePayload: !include message/payload/CustomerTitleSetMessagePayload.raml
13201328
DeliveryAddedMessagePayload: !include message/payload/DeliveryAddedMessagePayload.raml
13211329
DeliveryAddressSetMessagePayload: !include message/payload/DeliveryAddressSetMessagePayload.raml

0 commit comments

Comments
 (0)