Skip to content

Commit 2e4103d

Browse files
committed
build(codegen): updating SDK
1 parent 183022e commit 2e4103d

File tree

11 files changed

+72
-24
lines changed

11 files changed

+72
-24
lines changed

lib/commercetools-api/docs/RequestBuilder.md

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5964,13 +5964,22 @@ $request = $builder
59645964
```
59655965
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withId("ID")->get()`
59665966

5967-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
5967+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
5968+
59685969
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
59695970
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
59705971
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
59715972
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
5972-
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `id` and the given Store, this endpoint returns the ProductProjection with tailored data.
5973-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
5973+
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
5974+
5975+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
5976+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
5977+
5978+
Required access scopes:
5979+
5980+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
5981+
5982+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
59745983

59755984

59765985
### Example
@@ -6003,13 +6012,22 @@ $request = $builder
60036012
```
60046013
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withKey("key")->get()`
60056014

6006-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key in the specified [Store](ctp:api:type:Store).
6015+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key in the specified [Store](ctp:api:type:Store).
6016+
60076017
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
60086018
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
60096019
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
60106020
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
60116021
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
6012-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
6022+
6023+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
6024+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
6025+
6026+
Required access scopes:
6027+
6028+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
6029+
6030+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
60136031

60146032

60156033
### Example
@@ -9548,9 +9566,16 @@ $request = $builder
95489566
```
95499567
## `withProjectKey("projectKey")->productProjections()->get()`
95509568

9551-
Use the Product Projections query endpoint to get the current or staged representations of Products.
9552-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
9553-
this endpoint only returns published (current) Product Projections.
9569+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of [Products](ctp:api:type:Product) by [query predicates](/../api/predicates/query).
9570+
9571+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9572+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9573+
9574+
Required access scopes:
9575+
9576+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9577+
9578+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
95549579

95559580

95569581
### Example
@@ -9579,7 +9604,16 @@ $request = $builder
95799604
```
95809605
## `withProjectKey("projectKey")->productProjections()->withId("ID")->get()`
95819606

9582-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID. When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
9607+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID.
9608+
9609+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9610+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9611+
9612+
Required access scopes:
9613+
9614+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9615+
9616+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
95839617

95849618

95859619
### Example
@@ -9610,9 +9644,16 @@ $request = $builder
96109644
```
96119645
## `withProjectKey("projectKey")->productProjections()->withKey("key")->get()`
96129646

9613-
Gets the current or staged representation of a [Product](ctp:api:type:Product) found by Key.
9614-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
9615-
this endpoint only returns published (current) Product Projections.
9647+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key.
9648+
9649+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
9650+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
9651+
9652+
Required access scopes:
9653+
9654+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
9655+
9656+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
96169657

96179658

96189659
### Example

lib/commercetools-api/src/Models/Product/ProductCatalogData.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface ProductCatalogData extends JsonObject
1919
public const FIELD_HAS_STAGED_CHANGES = 'hasStagedChanges';
2020

2121
/**
22-
* <p><code>true</code> if the Product is published.</p>
22+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
2323
*
2424
2525
* @return null|bool

lib/commercetools-api/src/Models/Product/ProductCatalogDataBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ final class ProductCatalogDataBuilder implements Builder
4545
private $hasStagedChanges;
4646

4747
/**
48-
* <p><code>true</code> if the Product is published.</p>
48+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
4949
*
5050
5151
* @return null|bool

lib/commercetools-api/src/Models/Product/ProductCatalogDataModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function __construct(
6060
}
6161

6262
/**
63-
* <p><code>true</code> if the Product is published.</p>
63+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <a href="/projects/productProjections">Product Projection</a> endpoints and indexed for <a href="/../api/projects/product-search">Product Search</a>.</p>
6464
*
6565
*
6666
* @return null|bool

lib/commercetools-api/src/Models/Product/ProductDraft.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,9 @@ public function getSearchKeywords();
162162
public function getState();
163163

164164
/**
165-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
165+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
166+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
167+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
166168
*
167169
168170
* @return null|bool

lib/commercetools-api/src/Models/Product/ProductDraftBuilder.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,9 @@ public function getState()
307307
}
308308

309309
/**
310-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
310+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
311+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
312+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
311313
*
312314
313315
* @return null|bool

lib/commercetools-api/src/Models/Product/ProductDraftModel.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,9 @@ public function getState()
497497
}
498498

499499
/**
500-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
500+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="ctp:api:type:ProductCatalogData">ProductCatalogData</a> to <code>true</code>.
501+
* This makes the current representation retrievable in <a href="/projects/productProjections">Product Projection</a> endpoints and indexes it for <a href="/../api/projects/product-search">Product Search</a>.
502+
* You can also set this flag later using the <a href="/projects/products#publish">Publish</a> update action.</p>
501503
*
502504
*
503505
* @return null|bool

lib/commercetools-api/src/Models/ProductTailoring/ProductTailoring.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,15 @@ public function getProduct();
114114
public function getPublished();
115115

116116
/**
117-
* <p>Current (published) data of the ProductTailoring.</p>
117+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
118118
*
119119
120120
* @return null|ProductTailoringData
121121
*/
122122
public function getCurrent();
123123

124124
/**
125-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
125+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
126126
*
127127
128128
* @return null|ProductTailoringData

lib/commercetools-api/src/Models/ProductTailoring/ProductTailoringBuilder.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ public function getPublished()
229229
}
230230

231231
/**
232-
* <p>Current (published) data of the ProductTailoring.</p>
232+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
233233
*
234234
235235
* @return null|ProductTailoringData
@@ -240,7 +240,7 @@ public function getCurrent()
240240
}
241241

242242
/**
243-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
243+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
244244
*
245245
246246
* @return null|ProductTailoringData

lib/commercetools-api/src/Models/ProductTailoring/ProductTailoringModel.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ public function getPublished()
366366
}
367367

368368
/**
369-
* <p>Current (published) data of the ProductTailoring.</p>
369+
* <p>Current data of the ProductTailoring returned in the <a href="/projects/productProjections">Product Projection</a> response when the ProductTailoring is published.</p>
370370
*
371371
*
372372
* @return null|ProductTailoringData
@@ -387,7 +387,7 @@ public function getCurrent()
387387
}
388388

389389
/**
390-
* <p>Staged (unpublished) data of the ProductTailoring.</p>
390+
* <p>Staged data of the ProductTailoring. This data is not returned in the Product Projection response by default.</p>
391391
*
392392
*
393393
* @return null|ProductTailoringData

0 commit comments

Comments
 (0)