Skip to content

Commit ade3efe

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

File tree

7 files changed

+66
-17
lines changed

7 files changed

+66
-17
lines changed

.changeset/changes_api.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,23 @@
3232
- added type `RecurringOrderFailedMessagePayload`
3333
</details>
3434

35+
<details>
36+
<summary>MarkDeprecated Type(s)</summary>
37+
38+
- marked type `ProductSearchProjectionParams` as deprecated
39+
</details>
40+
3541
<details>
3642
<summary>Deprecated Type(s)</summary>
3743

3844
- type `ProductLegacySetSkuAction` is removed
3945
</details>
4046

4147
<details>
42-
<summary>Added Method(s)</summary>
48+
<summary>MarkDeprecated Property(s)</summary>
4349

44-
- added method `apiRoot.withProjectKey().carts().customerIdWithCustomerIdValueMerge().post()`
45-
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
50+
- marked property `ProductSearchRequest::productProjectionParameters` as deprecated
51+
- marked property `ProductSearchResult::productProjection` as deprecated
4652
</details>
4753

4854
<details>
@@ -84,6 +90,13 @@
8490
- added property `minimumQuantity` to type `StandalonePriceRemovePriceTierAction`
8591
</details>
8692

93+
<details>
94+
<summary>Added Method(s)</summary>
95+
96+
- added method `apiRoot.withProjectKey().carts().customerIdWithCustomerIdValueMerge().post()`
97+
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
98+
</details>
99+
87100
<details>
88101
<summary>Added Resource(s)</summary>
89102

changes.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,23 @@
2828
- added type `RecurringOrderFailedMessagePayload`
2929
</details>
3030

31+
<details>
32+
<summary>MarkDeprecated Type(s)</summary>
33+
34+
- marked type `ProductSearchProjectionParams` as deprecated
35+
</details>
36+
3137
<details>
3238
<summary>Deprecated Type(s)</summary>
3339

3440
- type `ProductLegacySetSkuAction` is removed
3541
</details>
3642

3743
<details>
38-
<summary>Added Method(s)</summary>
44+
<summary>MarkDeprecated Property(s)</summary>
3945

40-
- added method `apiRoot.withProjectKey().carts().customerIdWithCustomerIdValueMerge().post()`
41-
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
46+
- marked property `ProductSearchRequest::productProjectionParameters` as deprecated
47+
- marked property `ProductSearchResult::productProjection` as deprecated
4248
</details>
4349

4450
<details>
@@ -80,6 +86,13 @@
8086
- added property `minimumQuantity` to type `StandalonePriceRemovePriceTierAction`
8187
</details>
8288

89+
<details>
90+
<summary>Added Method(s)</summary>
91+
92+
- added method `apiRoot.withProjectKey().carts().customerIdWithCustomerIdValueMerge().post()`
93+
- added method `apiRoot.withProjectKey().inStoreKeyWithStoreKeyValue().carts().customerIdWithCustomerIdValueMerge().post()`
94+
</details>
95+
8396
<details>
8497
<summary>Added Resource(s)</summary>
8598

packages/platform-sdk/src/generated/client/recurrence-policies/by-project-key-recurrence-policies-by-id-request-builder.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export class ByProjectKeyRecurrencePoliciesByIDRequestBuilder {
2525
/**
2626
* Retrieves a Recurrence Policy with the provided `id`.
2727
*
28+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
29+
*
2830
*/
2931
public get(methodArgs?: {
3032
queryArgs?: {
@@ -52,6 +54,8 @@ export class ByProjectKeyRecurrencePoliciesByIDRequestBuilder {
5254
/**
5355
* Checks if a Recurrence Policy exists with the provided `id`. Returns a `200` status if the Recurrence Policy exists, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
5456
*
57+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
58+
*
5559
*/
5660
public head(methodArgs?: {
5761
headers?: {
@@ -74,6 +78,8 @@ export class ByProjectKeyRecurrencePoliciesByIDRequestBuilder {
7478
/**
7579
* Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
7680
*
81+
* The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
82+
*
7783
*/
7884
public post(methodArgs: {
7985
queryArgs?: {
@@ -106,6 +112,8 @@ export class ByProjectKeyRecurrencePoliciesByIDRequestBuilder {
106112
*
107113
* A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a [ReferenceExists](ctp:api:type:ReferenceExistsError) error is returned.
108114
*
115+
* The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
116+
*
109117
*/
110118
public delete(methodArgs: {
111119
queryArgs: {

packages/platform-sdk/src/generated/client/recurrence-policies/by-project-key-recurrence-policies-key-by-key-request-builder.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export class ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder {
2525
/**
2626
* Retrieves a Recurrence Policy with the provided `key`.
2727
*
28+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
29+
*
2830
*/
2931
public get(methodArgs?: {
3032
queryArgs?: {
@@ -52,6 +54,8 @@ export class ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder {
5254
/**
5355
* Checks if a Recurrence Policy exists with the provided `key`. Returns a `200` status if the Recurrence Policy exists, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
5456
*
57+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
58+
*
5559
*/
5660
public head(methodArgs?: {
5761
headers?: {
@@ -74,6 +78,8 @@ export class ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder {
7478
/**
7579
* Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
7680
*
81+
* The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
82+
*
7783
*/
7884
public post(methodArgs: {
7985
queryArgs?: {
@@ -106,6 +112,8 @@ export class ByProjectKeyRecurrencePoliciesKeyByKeyRequestBuilder {
106112
*
107113
* A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a [ReferenceExists](ctp:api:type:ReferenceExistsError) error is returned.
108114
*
115+
* The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
116+
*
109117
*/
110118
public delete(methodArgs: {
111119
queryArgs: {

packages/platform-sdk/src/generated/client/recurrence-policies/by-project-key-recurrence-policies-request-builder.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ export class ByProjectKeyRecurrencePoliciesRequestBuilder {
5252
/**
5353
* Retrieves Recurrence Policies in the Project.
5454
*
55+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
56+
*
5557
*/
5658
public get(methodArgs?: {
5759
queryArgs?: {
@@ -84,6 +86,8 @@ export class ByProjectKeyRecurrencePoliciesRequestBuilder {
8486
/**
8587
* Checks if one or more Recurrence Policies exist for the provided query predicate. Returns a `200` status if any Recurrence Policies match the query predicate, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
8688
*
89+
* The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
90+
*
8791
*/
8892
public head(methodArgs?: {
8993
queryArgs?: {
@@ -111,6 +115,8 @@ export class ByProjectKeyRecurrencePoliciesRequestBuilder {
111115
/**
112116
* Creates a Recurrence Policy in the Project.
113117
*
118+
* The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
119+
*
114120
*/
115121
public post(methodArgs: {
116122
queryArgs?: {

packages/platform-sdk/src/generated/models/product-search.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface ProductSearchMatchingVariants {
9797
readonly matchedVariants: ProductSearchMatchingVariantEntry[]
9898
}
9999
/**
100-
* The query parameters used for [data integration with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
100+
* The query parameters used for the deprecated [data integration with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters) in Product Search.
101101
*
102102
*/
103103
export interface ProductSearchProjectionParams {
@@ -109,7 +109,7 @@ export interface ProductSearchProjectionParams {
109109
*/
110110
readonly expand?: string[]
111111
/**
112-
* Set to `true` to retrieve the [staged](ctp:api:type:CurrentStaged) Product Projection
112+
* Set to `true` to retrieve the [staged](/../api/projects/productProjections#current--staged) Product Projection
113113
*
114114
*
115115
*/
@@ -145,20 +145,20 @@ export interface ProductSearchProjectionParams {
145145
*/
146146
readonly priceChannel?: string
147147
/**
148-
* Used for [locale-based projection](ctp:api:type:ProductProjectionLocales).
148+
* Used for [locale-based projection](/../api/projects/productProjections#locales).
149149
*
150150
*
151151
*/
152152
readonly localeProjection?: string[]
153153
/**
154154
* `key` of an existing [Store](ctp:api:type:Store).
155155
* If the Store has defined `languages`, `countries`, `distributionChannels`, or `supplyChannels`,
156-
* they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
157-
* and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
156+
* they are used for projections based on [locale](/../api/projects/productProjections#locales), [price](/../api/projects/productProjections#prices),
157+
* and [inventory](/../api/projects/productProjections#inventory-entries).
158158
*
159-
* For Projects with active [Product Selections](/api/projects/product-selections), the API does not take the [availability of the Product in the specified Store](/api/project-configuration-overview#products-available-in-store) into account.
159+
* For Projects with active [Product Selections](/../api/projects/product-selections), the API does not take the [availability of the Product in the specified Store](/../api/project-configuration-overview#products-available-in-store) into account.
160160
*
161-
* [Product Tailoring](/api/projects/product-tailoring) modifies the product information returned in API responses. However, you can only specify [query expressions](/api/search-query-language#simple-expressions) for the original Product data, not for tailored data.
161+
* [Product Tailoring](/../api/projects/product-tailoring) modifies the product information returned in API responses. However, you can only specify [query expressions](/../api/search-query-language#simple-expressions) for the original Product data, not for tailored data.
162162
*
163163
*
164164
*/
@@ -199,10 +199,10 @@ export interface ProductSearchRequest {
199199
*/
200200
readonly markMatchingVariants?: boolean
201201
/**
202-
* Controls data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
202+
* Controls deprecated data integration [with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters).
203203
* If not set, the result does not include the Product Projection.
204204
*
205-
*
205+
* @deprecated
206206
*/
207207
readonly productProjectionParameters?: ProductSearchProjectionParams
208208
/**
@@ -235,9 +235,9 @@ export interface ProductSearchResult {
235235
readonly matchingVariants?: ProductSearchMatchingVariants
236236
/**
237237
* Projected data of the Product with `id`.
238-
* Only present if data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters) is requested.
239-
*
238+
* Only present if deprecated data integration [with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters) is requested.
240239
*
240+
* @deprecated
241241
*/
242242
readonly productProjection?: ProductProjection
243243
}

references.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,3 +487,4 @@ a3e408093873cfed8ced6708aa90deec2e7daa44
487487
89eb52374e92eaaae7deb3c863bce47531efddc7
488488
b5fec4fbabbe620e9007e5937f794799bbd68ee3
489489
053837aaa0191604eafa5aaaf8a09203075ad21f
490+
d3cb53c9923eec30fa2e9c2a753ac19b94caa014

0 commit comments

Comments
 (0)