Skip to content

Commit 02f8c7b

Browse files
committed
build(codegen): updating SDK
1 parent a27acdb commit 02f8c7b

File tree

8 files changed

+609
-16
lines changed

8 files changed

+609
-16
lines changed

.changeset/changes_api.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,25 @@
99

1010
- added type `CartMergeMode`
1111
- added type `MergeCartDraft`
12+
- added type `AddressRole`
1213
- added type `RecurringOrderFailureError`
1314
- added type `GraphQLRecurringOrderFailureError`
1415
- added type `CartFrozenMessage`
1516
- added type `CartUnfrozenMessage`
17+
- added type `CustomerBillingAddressAddedMessage`
18+
- added type `CustomerBillingAddressRemovedMessage`
19+
- added type `CustomerExternalIdSetMessage`
20+
- added type `CustomerShippingAddressAddedMessage`
21+
- added type `CustomerShippingAddressRemovedMessage`
1622
- added type `OrderPaymentRemovedMessage`
1723
- added type `RecurringOrderFailedMessage`
1824
- added type `CartFrozenMessagePayload`
1925
- added type `CartUnfrozenMessagePayload`
26+
- added type `CustomerBillingAddressAddedMessagePayload`
27+
- added type `CustomerBillingAddressRemovedMessagePayload`
28+
- added type `CustomerExternalIdSetMessagePayload`
29+
- added type `CustomerShippingAddressAddedMessagePayload`
30+
- added type `CustomerShippingAddressRemovedMessagePayload`
2031
- added type `OrderPaymentRemovedMessagePayload`
2132
- added type `RecurringOrderFailedMessagePayload`
2233
</details>
@@ -34,6 +45,13 @@
3445
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
3546
</details>
3647

48+
<details>
49+
<summary>Required Property(s)</summary>
50+
51+
- :warning: changed property `customerGroupAssignments` of type `CustomerGroupAssignmentsSetMessage` to be required
52+
- :warning: changed property `customerGroupAssignments` of type `CustomerGroupAssignmentsSetMessagePayload` to be required
53+
</details>
54+
3755
<details>
3856
<summary>Removed Property(s)</summary>
3957

@@ -45,8 +63,22 @@
4563
<details>
4664
<summary>Added Property(s)</summary>
4765

66+
- added property `addressRoles` to type `BusinessUnitAddressChangedMessage`
67+
- added property `addressRoles` to type `BusinessUnitAddressRemovedMessage`
68+
- added property `addressRoles` to type `CustomerAddressChangedMessage`
69+
- added property `addressRoles` to type `CustomerAddressRemovedMessage`
70+
- added property `email` to type `CustomerDeletedMessage`
71+
- added property `oldEmail` to type `CustomerEmailChangedMessage`
72+
- added property `oldCustomerGroupAssignments` to type `CustomerGroupAssignmentsSetMessage`
4873
- added property `sku` to type `InventoryEntryQuantitySetMessage`
4974
- added property `paymentRef` to type `OrderPaymentAddedMessage`
75+
- added property `addressRoles` to type `BusinessUnitAddressChangedMessagePayload`
76+
- added property `addressRoles` to type `BusinessUnitAddressRemovedMessagePayload`
77+
- added property `addressRoles` to type `CustomerAddressChangedMessagePayload`
78+
- added property `addressRoles` to type `CustomerAddressRemovedMessagePayload`
79+
- added property `email` to type `CustomerDeletedMessagePayload`
80+
- added property `oldEmail` to type `CustomerEmailChangedMessagePayload`
81+
- added property `oldCustomerGroupAssignments` to type `CustomerGroupAssignmentsSetMessagePayload`
5082
- added property `sku` to type `InventoryEntryQuantitySetMessagePayload`
5183
- added property `paymentRef` to type `OrderPaymentAddedMessagePayload`
5284
- added property `minimumQuantity` to type `StandalonePriceRemovePriceTierAction`

changes.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,25 @@
55

66
- added type `CartMergeMode`
77
- added type `MergeCartDraft`
8+
- added type `AddressRole`
89
- added type `RecurringOrderFailureError`
910
- added type `GraphQLRecurringOrderFailureError`
1011
- added type `CartFrozenMessage`
1112
- added type `CartUnfrozenMessage`
13+
- added type `CustomerBillingAddressAddedMessage`
14+
- added type `CustomerBillingAddressRemovedMessage`
15+
- added type `CustomerExternalIdSetMessage`
16+
- added type `CustomerShippingAddressAddedMessage`
17+
- added type `CustomerShippingAddressRemovedMessage`
1218
- added type `OrderPaymentRemovedMessage`
1319
- added type `RecurringOrderFailedMessage`
1420
- added type `CartFrozenMessagePayload`
1521
- added type `CartUnfrozenMessagePayload`
22+
- added type `CustomerBillingAddressAddedMessagePayload`
23+
- added type `CustomerBillingAddressRemovedMessagePayload`
24+
- added type `CustomerExternalIdSetMessagePayload`
25+
- added type `CustomerShippingAddressAddedMessagePayload`
26+
- added type `CustomerShippingAddressRemovedMessagePayload`
1627
- added type `OrderPaymentRemovedMessagePayload`
1728
- added type `RecurringOrderFailedMessagePayload`
1829
</details>
@@ -30,6 +41,13 @@
3041
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
3142
</details>
3243

44+
<details>
45+
<summary>Required Property(s)</summary>
46+
47+
- :warning: changed property `customerGroupAssignments` of type `CustomerGroupAssignmentsSetMessage` to be required
48+
- :warning: changed property `customerGroupAssignments` of type `CustomerGroupAssignmentsSetMessagePayload` to be required
49+
</details>
50+
3351
<details>
3452
<summary>Removed Property(s)</summary>
3553

@@ -41,8 +59,22 @@
4159
<details>
4260
<summary>Added Property(s)</summary>
4361

62+
- added property `addressRoles` to type `BusinessUnitAddressChangedMessage`
63+
- added property `addressRoles` to type `BusinessUnitAddressRemovedMessage`
64+
- added property `addressRoles` to type `CustomerAddressChangedMessage`
65+
- added property `addressRoles` to type `CustomerAddressRemovedMessage`
66+
- added property `email` to type `CustomerDeletedMessage`
67+
- added property `oldEmail` to type `CustomerEmailChangedMessage`
68+
- added property `oldCustomerGroupAssignments` to type `CustomerGroupAssignmentsSetMessage`
4469
- added property `sku` to type `InventoryEntryQuantitySetMessage`
4570
- added property `paymentRef` to type `OrderPaymentAddedMessage`
71+
- added property `addressRoles` to type `BusinessUnitAddressChangedMessagePayload`
72+
- added property `addressRoles` to type `BusinessUnitAddressRemovedMessagePayload`
73+
- added property `addressRoles` to type `CustomerAddressChangedMessagePayload`
74+
- added property `addressRoles` to type `CustomerAddressRemovedMessagePayload`
75+
- added property `email` to type `CustomerDeletedMessagePayload`
76+
- added property `oldEmail` to type `CustomerEmailChangedMessagePayload`
77+
- added property `oldCustomerGroupAssignments` to type `CustomerGroupAssignmentsSetMessagePayload`
4678
- added property `sku` to type `InventoryEntryQuantitySetMessagePayload`
4779
- added property `paymentRef` to type `OrderPaymentAddedMessagePayload`
4880
- added property `minimumQuantity` to type `StandalonePriceRemovePriceTierAction`

packages/history-sdk/src/generated/models/change.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3060,7 +3060,7 @@ export interface RemoveBillingAddressIdChange extends IChange {
30603060
*/
30613061
readonly nextValue: string[]
30623062
/**
3063-
* Address removed from `billingAddressesIds`.
3063+
* Address removed from `billingAddressIds`.
30643064
*
30653065
*/
30663066
readonly address: Address
@@ -3497,7 +3497,7 @@ export interface RemoveShippingAddressIdChange extends IChange {
34973497
*/
34983498
readonly nextValue: string[]
34993499
/**
3500-
* Address removed from `shippingAddressesIds`.
3500+
* Address removed from `shippingAddressIds`.
35013501
*
35023502
*/
35033503
readonly address: Address

packages/platform-sdk/src/generated/models/common.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,16 @@ export interface UpdateAction {
227227
*/
228228
readonly action: string
229229
}
230+
/**
231+
* Indicates the role of an address.
232+
*
233+
*/
234+
export enum AddressRoleValues {
235+
Billing = 'Billing',
236+
Shipping = 'Shipping',
237+
}
238+
239+
export type AddressRole = 'Billing' | 'Shipping' | (string & {})
230240
export interface Asset {
231241
/**
232242
* Unique identifier of the Asset. Not required when importing Assets using the [Import API](/import-export/import-resources).

packages/platform-sdk/src/generated/models/customer.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,21 +1042,21 @@ export interface CustomerRemoveAddressAction extends ICustomerUpdateAction {
10421042
readonly addressKey?: string
10431043
}
10441044
/**
1045-
* Removes a billing address from `billingAddressesIds`.
1045+
* Removes a billing address from `billingAddressIds`.
10461046
* If the billing address is the default billing address, the `defaultBillingAddressId` is unset. Either `addressId` or `addressKey` is required.
10471047
*
10481048
*/
10491049
export interface CustomerRemoveBillingAddressIdAction
10501050
extends ICustomerUpdateAction {
10511051
readonly action: 'removeBillingAddressId'
10521052
/**
1053-
* `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
1053+
* `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressIds`.
10541054
*
10551055
*
10561056
*/
10571057
readonly addressId?: string
10581058
/**
1059-
* `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
1059+
* `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressIds`.
10601060
*
10611061
*
10621062
*/
@@ -1077,21 +1077,21 @@ export interface CustomerRemoveCustomerGroupAssignmentAction
10771077
readonly customerGroup: CustomerGroupResourceIdentifier
10781078
}
10791079
/**
1080-
* Removes a shipping address from `shippingAddressesIds`.
1080+
* Removes a shipping address from `shippingAddressIds`.
10811081
* If the shipping address is the default shipping address, the `defaultShippingAddressId` is unset. Either `addressId` or `addressKey` is required.
10821082
*
10831083
*/
10841084
export interface CustomerRemoveShippingAddressIdAction
10851085
extends ICustomerUpdateAction {
10861086
readonly action: 'removeShippingAddressId'
10871087
/**
1088-
* `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
1088+
* `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressIds`.
10891089
*
10901090
*
10911091
*/
10921092
readonly addressId?: string
10931093
/**
1094-
* `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
1094+
* `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressIds`.
10951095
*
10961096
*
10971097
*/
@@ -1342,6 +1342,10 @@ export interface CustomerSetDefaultShippingAddressAction
13421342
*/
13431343
readonly addressKey?: string
13441344
}
1345+
/**
1346+
* This action generates the [CustomerExternalIdSet](ctp:api:type:CustomerExternalIdSetMessage) Message.
1347+
*
1348+
*/
13451349
export interface CustomerSetExternalIdAction extends ICustomerUpdateAction {
13461350
readonly action: 'setExternalId'
13471351
/**

packages/platform-sdk/src/generated/models/me.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2257,42 +2257,42 @@ export interface MyCustomerRemoveAddressAction extends IMyCustomerUpdateAction {
22572257
readonly addressKey?: string
22582258
}
22592259
/**
2260-
* Removes an existing billing address from `billingAddressesIds`.
2260+
* Removes an existing billing address from `billingAddressIds`.
22612261
* If the billing address is the default billing address, the `defaultBillingAddressId` is unset. Either `addressId` or `addressKey` is required.
22622262
*
22632263
*/
22642264
export interface MyCustomerRemoveBillingAddressIdAction
22652265
extends IMyCustomerUpdateAction {
22662266
readonly action: 'removeBillingAddressId'
22672267
/**
2268-
* `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
2268+
* `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressIds`.
22692269
*
22702270
*
22712271
*/
22722272
readonly addressId?: string
22732273
/**
2274-
* `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
2274+
* `key` of the [Address](ctp:api:type:Address) to remove from `billingAddressIds`.
22752275
*
22762276
*
22772277
*/
22782278
readonly addressKey?: string
22792279
}
22802280
/**
2281-
* Removes an existing shipping address from `shippingAddressesIds`.
2281+
* Removes an existing shipping address from `shippingAddressIds`.
22822282
* If the shipping address is the default shipping address, the `defaultShippingAddressId` is unset. Either `addressId` or `addressKey` is required.
22832283
*
22842284
*/
22852285
export interface MyCustomerRemoveShippingAddressIdAction
22862286
extends IMyCustomerUpdateAction {
22872287
readonly action: 'removeShippingAddressId'
22882288
/**
2289-
* `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
2289+
* `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressIds`.
22902290
*
22912291
*
22922292
*/
22932293
readonly addressId?: string
22942294
/**
2295-
* `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
2295+
* `key` of the [Address](ctp:api:type:Address) to remove from `shippingAddressIds`.
22962296
*
22972297
*
22982298
*/

0 commit comments

Comments
 (0)