Skip to content

Commit 62c9b21

Browse files
committed
build(codegen): updating SDK
1 parent 01d8503 commit 62c9b21

12 files changed

+66
-34
lines changed

changes.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,13 @@
305305
</details>
306306

307307

308+
<details>
309+
<summary>MarkDeprecated Type(s)</summary>
310+
311+
- marked type `ProductSearchProjectionParams` as deprecated
312+
</details>
313+
314+
308315
<details>
309316
<summary>Deprecated Type(s)</summary>
310317

@@ -431,6 +438,8 @@
431438

432439
- marked property `CountOnCustomLineItemUnits::excludeCount` as deprecated
433440
- marked property `CountOnLineItemUnits::excludeCount` as deprecated
441+
- marked property `ProductSearchRequest::productProjectionParameters` as deprecated
442+
- marked property `ProductSearchResult::productProjection` as deprecated
434443
</details>
435444

436445

lib/commercetools-api/docs/RequestBuilder.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10755,6 +10755,8 @@ $request = $builder
1075510755

1075610756
Retrieves Recurrence Policies in the Project.
1075710757

10758+
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.
10759+
1075810760

1075910761
### Example
1076010762
```php
@@ -10770,6 +10772,8 @@ $request = $builder
1077010772

1077110773
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.
1077210774

10775+
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.
10776+
1077310777

1077410778
### Example
1077510779
```php
@@ -10785,6 +10789,8 @@ $request = $builder
1078510789

1078610790
Creates a Recurrence Policy in the Project.
1078710791

10792+
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.
10793+
1078810794

1078910795
### Example
1079010796
```php
@@ -10800,6 +10806,8 @@ $request = $builder
1080010806

1080110807
Retrieves a Recurrence Policy with the provided `id`.
1080210808

10809+
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.
10810+
1080310811

1080410812
### Example
1080510813
```php
@@ -10816,6 +10824,8 @@ $request = $builder
1081610824

1081710825
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.
1081810826

10827+
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.
10828+
1081910829

1082010830
### Example
1082110831
```php
@@ -10832,6 +10842,8 @@ $request = $builder
1083210842

1083310843
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
1083410844

10845+
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.
10846+
1083510847

1083610848
### Example
1083710849
```php
@@ -10850,6 +10862,8 @@ Deletes a Recurrence Policy in the Project.
1085010862

1085110863
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.
1085210864

10865+
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.
10866+
1085310867

1085410868
### Example
1085510869
```php
@@ -10866,6 +10880,8 @@ $request = $builder
1086610880

1086710881
Retrieves a Recurrence Policy with the provided `key`.
1086810882

10883+
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.
10884+
1086910885

1087010886
### Example
1087110887
```php
@@ -10882,6 +10898,8 @@ $request = $builder
1088210898

1088310899
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.
1088410900

10901+
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.
10902+
1088510903

1088610904
### Example
1088710905
```php
@@ -10898,6 +10916,8 @@ $request = $builder
1089810916

1089910917
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
1090010918

10919+
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.
10920+
1090110921

1090210922
### Example
1090310923
```php
@@ -10916,6 +10936,8 @@ Deletes a Recurrence Policy in the Project.
1091610936

1091710937
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.
1091810938

10939+
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.
10940+
1091910941

1092010942
### Example
1092110943
```php

lib/commercetools-api/src/Models/ProductSearch/ProductSearchProjectionParams.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ interface ProductSearchProjectionParams extends JsonObject
3333
public function getExpand();
3434

3535
/**
36-
* <p>Set to <code>true</code> to retrieve the <a href="ctp:api:type:CurrentStaged">staged</a> Product Projection</p>
36+
* <p>Set to <code>true</code> to retrieve the <a href="/../api/projects/productProjections#current--staged">staged</a> Product Projection</p>
3737
*
3838
3939
* @return null|bool
@@ -81,7 +81,7 @@ public function getPriceCustomerGroupAssignments();
8181
public function getPriceChannel();
8282

8383
/**
84-
* <p>Used for <a href="ctp:api:type:ProductProjectionLocales">locale-based projection</a>.</p>
84+
* <p>Used for <a href="/../api/projects/productProjections#locales">locale-based projection</a>.</p>
8585
*
8686
8787
* @return null|array
@@ -91,10 +91,10 @@ public function getLocaleProjection();
9191
/**
9292
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
9393
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
94-
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
95-
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.</p>
96-
* <p>For Projects with active <a href="/api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
97-
* <p><a href="/api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
94+
* they are used for projections based on <a href="/../api/projects/productProjections#locales">locale</a>, <a href="/../api/projects/productProjections#prices">price</a>,
95+
* and <a href="/../api/projects/productProjections#inventory-entries">inventory</a>.</p>
96+
* <p>For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
97+
* <p><a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/../api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
9898
*
9999
100100
* @return null|string

lib/commercetools-api/src/Models/ProductSearch/ProductSearchProjectionParamsBuilder.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public function getExpand()
8787
}
8888

8989
/**
90-
* <p>Set to <code>true</code> to retrieve the <a href="ctp:api:type:CurrentStaged">staged</a> Product Projection</p>
90+
* <p>Set to <code>true</code> to retrieve the <a href="/../api/projects/productProjections#current--staged">staged</a> Product Projection</p>
9191
*
9292
9393
* @return null|bool
@@ -153,7 +153,7 @@ public function getPriceChannel()
153153
}
154154

155155
/**
156-
* <p>Used for <a href="ctp:api:type:ProductProjectionLocales">locale-based projection</a>.</p>
156+
* <p>Used for <a href="/../api/projects/productProjections#locales">locale-based projection</a>.</p>
157157
*
158158
159159
* @return null|array
@@ -166,10 +166,10 @@ public function getLocaleProjection()
166166
/**
167167
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
168168
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
169-
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
170-
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.</p>
171-
* <p>For Projects with active <a href="/api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
172-
* <p><a href="/api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
169+
* they are used for projections based on <a href="/../api/projects/productProjections#locales">locale</a>, <a href="/../api/projects/productProjections#prices">price</a>,
170+
* and <a href="/../api/projects/productProjections#inventory-entries">inventory</a>.</p>
171+
* <p>For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
172+
* <p><a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/../api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
173173
*
174174
175175
* @return null|string

lib/commercetools-api/src/Models/ProductSearch/ProductSearchProjectionParamsModel.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public function getExpand()
121121
}
122122

123123
/**
124-
* <p>Set to <code>true</code> to retrieve the <a href="ctp:api:type:CurrentStaged">staged</a> Product Projection</p>
124+
* <p>Set to <code>true</code> to retrieve the <a href="/../api/projects/productProjections#current--staged">staged</a> Product Projection</p>
125125
*
126126
*
127127
* @return null|bool
@@ -241,7 +241,7 @@ public function getPriceChannel()
241241
}
242242

243243
/**
244-
* <p>Used for <a href="ctp:api:type:ProductProjectionLocales">locale-based projection</a>.</p>
244+
* <p>Used for <a href="/../api/projects/productProjections#locales">locale-based projection</a>.</p>
245245
*
246246
*
247247
* @return null|array
@@ -263,10 +263,10 @@ public function getLocaleProjection()
263263
/**
264264
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
265265
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
266-
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
267-
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.</p>
268-
* <p>For Projects with active <a href="/api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
269-
* <p><a href="/api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
266+
* they are used for projections based on <a href="/../api/projects/productProjections#locales">locale</a>, <a href="/../api/projects/productProjections#prices">price</a>,
267+
* and <a href="/../api/projects/productProjections#inventory-entries">inventory</a>.</p>
268+
* <p>For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/project-configuration-overview#products-available-in-store">availability of the Product in the specified Store</a> into account.</p>
269+
* <p><a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses. However, you can only specify <a href="/../api/search-query-language#simple-expressions">query expressions</a> for the original Product data, not for tailored data.</p>
270270
*
271271
*
272272
* @return null|string

lib/commercetools-api/src/Models/ProductSearch/ProductSearchRequest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ public function getOffset();
6868
public function getMarkMatchingVariants();
6969

7070
/**
71-
* <p>Controls data integration <a href="/../api/projects/product-search#with-product-projection-parameters">with Product Projection parameters</a>.
71+
* <p>Controls deprecated data integration <a href="/../api/deprecations-and-removals#product-projection-parameters">with Product Projection parameters</a>.
7272
* If not set, the result does not include the Product Projection.</p>
7373
*
74-
74+
* @deprecated
7575
* @return null|ProductSearchProjectionParams
7676
*/
7777
public function getProductProjectionParameters();

lib/commercetools-api/src/Models/ProductSearch/ProductSearchRequestBuilder.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ final class ProductSearchRequestBuilder implements Builder
5454
private $markMatchingVariants;
5555

5656
/**
57-
57+
* @deprecated
5858
* @var null|ProductSearchProjectionParams|ProductSearchProjectionParamsBuilder
5959
*/
6060
private $productProjectionParameters;
@@ -130,10 +130,10 @@ public function getMarkMatchingVariants()
130130
}
131131

132132
/**
133-
* <p>Controls data integration <a href="/../api/projects/product-search#with-product-projection-parameters">with Product Projection parameters</a>.
133+
* <p>Controls deprecated data integration <a href="/../api/deprecations-and-removals#product-projection-parameters">with Product Projection parameters</a>.
134134
* If not set, the result does not include the Product Projection.</p>
135135
*
136-
136+
* @deprecated
137137
* @return null|ProductSearchProjectionParams
138138
*/
139139
public function getProductProjectionParameters()

lib/commercetools-api/src/Models/ProductSearch/ProductSearchRequestModel.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ final class ProductSearchRequestModel extends JsonObjectModel implements Product
5353
protected $markMatchingVariants;
5454

5555
/**
56-
*
56+
* @deprecated
5757
* @var ?ProductSearchProjectionParams
5858
*/
5959
protected $productProjectionParameters;
@@ -199,10 +199,10 @@ public function getMarkMatchingVariants()
199199
}
200200

201201
/**
202-
* <p>Controls data integration <a href="/../api/projects/product-search#with-product-projection-parameters">with Product Projection parameters</a>.
202+
* <p>Controls deprecated data integration <a href="/../api/deprecations-and-removals#product-projection-parameters">with Product Projection parameters</a>.
203203
* If not set, the result does not include the Product Projection.</p>
204204
*
205-
*
205+
* @deprecated
206206
* @return null|ProductSearchProjectionParams
207207
*/
208208
public function getProductProjectionParameters()

lib/commercetools-api/src/Models/ProductSearch/ProductSearchResult.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ public function getMatchingVariants();
3737

3838
/**
3939
* <p>Projected data of the Product with <code>id</code>.
40-
* Only present if data integration <a href="/../api/projects/product-search#with-product-projection-parameters">with Product Projection parameters</a> is requested.</p>
40+
* Only present if deprecated data integration <a href="/../api/deprecations-and-removals#product-projection-parameters">with Product Projection parameters</a> is requested.</p>
4141
*
42-
42+
* @deprecated
4343
* @return null|ProductProjection
4444
*/
4545
public function getProductProjection();

lib/commercetools-api/src/Models/ProductSearch/ProductSearchResultBuilder.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ final class ProductSearchResultBuilder implements Builder
3535
private $matchingVariants;
3636

3737
/**
38-
38+
* @deprecated
3939
* @var null|ProductProjection|ProductProjectionBuilder
4040
*/
4141
private $productProjection;
@@ -65,9 +65,9 @@ public function getMatchingVariants()
6565

6666
/**
6767
* <p>Projected data of the Product with <code>id</code>.
68-
* Only present if data integration <a href="/../api/projects/product-search#with-product-projection-parameters">with Product Projection parameters</a> is requested.</p>
68+
* Only present if deprecated data integration <a href="/../api/deprecations-and-removals#product-projection-parameters">with Product Projection parameters</a> is requested.</p>
6969
*
70-
70+
* @deprecated
7171
* @return null|ProductProjection
7272
*/
7373
public function getProductProjection()

0 commit comments

Comments
 (0)