Skip to content

Commit 9cbd978

Browse files
committed
build(codegen): updating SDK
1 parent 0e20c6c commit 9cbd978

20 files changed

+71
-34
lines changed

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
import org.apache.commons.lang3.builder.HashCodeBuilder;
2121

2222
/**
23-
* <p>Gets the current or staged representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its ID in the specified <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>. If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionLocales" rel="nofollow">locale</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionPrices" rel="nofollow">price</a>, and <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionInventoryEntries" rel="nofollow">inventory</a>. If <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductSelection" rel="nofollow">ProductSelection</a> is used, it affects the <span>availability of the Product</span> in the specified Store. If a <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductTailoring" rel="nofollow">ProductTailoring</a> exists for the Product with the given <code>id</code> and the given Store, this endpoint returns the ProductProjection with tailored data. When used with an API Client that has the <code>view_published_products:{projectKey}</code> scope, this endpoint only returns published (current) Product Projections.</p>
23+
* <p>Retrieves the <span>projected</span> representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its ID in the specified <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>.</p>
24+
* <p>If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionLocales" rel="nofollow">locale</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionPrices" rel="nofollow">price</a>, and <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionInventoryEntries" rel="nofollow">inventory</a>. If <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductSelection" rel="nofollow">ProductSelection</a> is used, it affects the <span>availability of the Product</span> in the specified Store. If a <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductTailoring" rel="nofollow">ProductTailoring</a> exists for the Product with the given <code>key</code> and the given Store, this endpoint returns the ProductProjection with tailored data.</p>
25+
* <p>By default, this endpoint returns the <code>current</code> representation of Products where the <code>published</code> flag is <code>true</code>. If a Product is unpublished (<code>published=false</code>), the endpoint returns a <span>Not Found</span> error.</p>
26+
* <p>Required access scopes:</p>
27+
* <ul>
28+
* <li><p>To retrieve the current representation of published Products (published data), the <code>view_published_products:{projectKey}</code> scope is required.</p></li>
29+
* <li><p>To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the <code>view_products:{projectKey}</code> scope.</p></li>
30+
* </ul>
2431
*
2532
* <hr>
2633
* <div class=code-example>

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
import org.apache.commons.lang3.builder.HashCodeBuilder;
2121

2222
/**
23-
* <p>Gets the current or staged representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its key in the specified <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>. If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionLocales" rel="nofollow">locale</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionPrices" rel="nofollow">price</a>, and <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionInventoryEntries" rel="nofollow">inventory</a>. If <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductSelection" rel="nofollow">ProductSelection</a> is used, it affects the <span>availability of the Product</span> in the specified Store. If a <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductTailoring" rel="nofollow">ProductTailoring</a> exists for the Product with the given <code>key</code> and the given Store, this endpoint returns the ProductProjection with tailored data. When used with an API Client that has the <code>view_published_products:{projectKey}</code> scope, this endpoint only returns published (current) Product Projections.</p>
23+
* <p>Retrieves the <span>projected</span> representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its Key in the specified <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>.</p>
24+
* <p>If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection, they are used for projections based on <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionLocales" rel="nofollow">locale</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionPrices" rel="nofollow">price</a>, and <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductProjectionInventoryEntries" rel="nofollow">inventory</a>. If <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductSelection" rel="nofollow">ProductSelection</a> is used, it affects the <span>availability of the Product</span> in the specified Store. If a <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductTailoring" rel="nofollow">ProductTailoring</a> exists for the Product with the given <code>key</code> and the given Store, this endpoint returns the ProductProjection with tailored data.</p>
25+
* <p>By default, this endpoint returns the <code>current</code> representation of Products where the <code>published</code> flag is <code>true</code>. If a Product is unpublished (<code>published=false</code>), the endpoint returns a <span>Not Found</span> error.</p>
26+
* <p>Required access scopes:</p>
27+
* <ul>
28+
* <li><p>To retrieve the current representation of published Products (published data), the <code>view_published_products:{projectKey}</code> scope is required.</p></li>
29+
* <li><p>To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the <code>view_products:{projectKey}</code> scope.</p></li>
30+
* </ul>
2431
*
2532
* <hr>
2633
* <div class=code-example>

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/client/ByProjectKeyProductProjectionsByIDGet.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
import org.apache.commons.lang3.builder.HashCodeBuilder;
2121

2222
/**
23-
* <p>Gets the current or staged representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its ID. When used with an API Client that has the <code>view_published_products:{projectKey}</code> scope, this endpoint only returns published (current) Product Projections.</p>
23+
* <p>Retrieves the <span>projected</span> representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its ID.</p>
24+
* <p>By default, this endpoint returns the <code>current</code> representation of Products where the <code>published</code> flag is <code>true</code>. If a Product is unpublished (<code>published=false</code>), the endpoint returns a <span>Not Found</span> error.</p>
25+
* <p>Required access scopes:</p>
26+
* <ul>
27+
* <li><p>To retrieve the current representation of published Products (published data), the <code>view_published_products:{projectKey}</code> scope is required.</p></li>
28+
* <li><p>To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the <code>view_products:{projectKey}</code> scope.</p></li>
29+
* </ul>
2430
*
2531
* <hr>
2632
* <div class=code-example>

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/client/ByProjectKeyProductProjectionsGet.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
import org.apache.commons.lang3.builder.HashCodeBuilder;
2121

2222
/**
23-
* <p>Use the Product Projections query endpoint to get the current or staged representations of Products. When used with an API Client that has the <code>view_published_products:{projectKey}</code> scope, this endpoint only returns published (current) Product Projections.</p>
23+
* <p>Retrieves the <span>projected</span> representation of <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Products</a> by <span>query predicates</span>.</p>
24+
* <p>By default, this endpoint returns the <code>current</code> representation of Products where the <code>published</code> flag is <code>true</code>. If a Product is unpublished (<code>published=false</code>), the endpoint returns a <span>Not Found</span> error.</p>
25+
* <p>Required access scopes:</p>
26+
* <ul>
27+
* <li><p>To retrieve the current representation of published Products (published data), the <code>view_published_products:{projectKey}</code> scope is required.</p></li>
28+
* <li><p>To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the <code>view_products:{projectKey}</code> scope.</p></li>
29+
* </ul>
2430
*
2531
* <hr>
2632
* <div class=code-example>

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/client/ByProjectKeyProductProjectionsKeyByKeyGet.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
import org.apache.commons.lang3.builder.HashCodeBuilder;
2121

2222
/**
23-
* <p>Gets the current or staged representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> found by Key. When used with an API Client that has the <code>view_published_products:{projectKey}</code> scope, this endpoint only returns published (current) Product Projections.</p>
23+
* <p>Retrieves the <span>projected</span> representation of a <a href="https://docs.commercetools.com/apis/ctp:api:type:Product" rel="nofollow">Product</a> by its Key.</p>
24+
* <p>By default, this endpoint returns the <code>current</code> representation of Products where the <code>published</code> flag is <code>true</code>. If a Product is unpublished (<code>published=false</code>), the endpoint returns a <span>Not Found</span> error.</p>
25+
* <p>Required access scopes:</p>
26+
* <ul>
27+
* <li><p>To retrieve the current representation of published Products (published data), the <code>view_published_products:{projectKey}</code> scope is required.</p></li>
28+
* <li><p>To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the <code>view_products:{projectKey}</code> scope.</p></li>
29+
* </ul>
2430
*
2531
* <hr>
2632
* <div class=code-example>

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/cart/ProductPublishScope.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
public interface ProductPublishScope extends JsonEnum {
1818

1919
/**
20-
<p>Publishes a Product that causes the <em>staged</em> projection of the Product to override the <em>current</em> projection. If the Product is published for the first time, the <em>current</em> projection is created. This is the default scope.</p> */
20+
<p>Publishes a Product that causes the <em>staged</em> projection of the Product to override the <em>current</em> projection. This is the default scope.</p> */
2121
ProductPublishScope ALL = ProductPublishScopeEnum.ALL;
2222
/**
2323
<p>Publishes the Prices of the Product (only if the Product is already published). All Product Variants' Prices in the <em>staged</em> projection are published into the <em>current</em> projection with the same <code>id</code>. Prices in a <em>staged</em> Product Variant that has no <em>current</em> projection are not published. Prices in a <em>current</em> Product Variant that has no <em>staged</em> projection are unchanged. The <code>hasStagedChanges</code> <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductCatalogData" rel="nofollow">flag</a> is updated according to whether the <em>staged</em> and <em>current</em> projections still differ after the prices are published.</p> */

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/product/ProductCatalogData.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
public interface ProductCatalogData extends ProductCatalogDataMixin {
3737

3838
/**
39-
* <p><code>true</code> if the Product is published.</p>
39+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <span>Product Projection</span> endpoints and indexed for <span>Product Search</span>.</p>
4040
* @return published
4141
*/
4242
@NotNull
@@ -70,7 +70,7 @@ public interface ProductCatalogData extends ProductCatalogDataMixin {
7070
public Boolean getHasStagedChanges();
7171

7272
/**
73-
* <p><code>true</code> if the Product is published.</p>
73+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <span>Product Projection</span> endpoints and indexed for <span>Product Search</span>.</p>
7474
* @param published value to be set
7575
*/
7676

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/product/ProductCatalogDataBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class ProductCatalogDataBuilder implements Builder<ProductCatalogData> {
3434
private Boolean hasStagedChanges;
3535

3636
/**
37-
* <p><code>true</code> if the Product is published.</p>
37+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <span>Product Projection</span> endpoints and indexed for <span>Product Search</span>.</p>
3838
* @param published value to be set
3939
* @return Builder
4040
*/
@@ -126,7 +126,7 @@ public ProductCatalogDataBuilder hasStagedChanges(final Boolean hasStagedChanges
126126
}
127127

128128
/**
129-
* <p><code>true</code> if the Product is published.</p>
129+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <span>Product Projection</span> endpoints and indexed for <span>Product Search</span>.</p>
130130
* @return published
131131
*/
132132

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/product/ProductCatalogDataImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public ProductCatalogDataImpl() {
5151
}
5252

5353
/**
54-
* <p><code>true</code> if the Product is published.</p>
54+
* <p>If <code>true</code>, the <code>current</code> representation of the Product is retrievable in the <span>Product Projection</span> endpoints and indexed for <span>Product Search</span>.</p>
5555
*/
5656

5757
public Boolean getPublished() {

commercetools/commercetools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/product/ProductDraft.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public interface ProductDraft
167167
public StateResourceIdentifier getState();
168168

169169
/**
170-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
170+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductCatalogData" rel="nofollow">ProductCatalogData</a> to <code>true</code>. This makes the current representation retrievable in <span>Product Projection</span> endpoints and indexes it for <span>Product Search</span>. You can also set this flag later using the <span>Publish</span> update action.</p>
171171
* @return publish
172172
*/
173173

@@ -314,7 +314,7 @@ public interface ProductDraft
314314
public void setState(final StateResourceIdentifier state);
315315

316316
/**
317-
* <p>If <code>true</code>, the Product is published immediately to the current projection.</p>
317+
* <p>If <code>true</code>, the platform sets the <code>published</code> flag on the resulting <a href="https://docs.commercetools.com/apis/ctp:api:type:ProductCatalogData" rel="nofollow">ProductCatalogData</a> to <code>true</code>. This makes the current representation retrievable in <span>Product Projection</span> endpoints and indexes it for <span>Product Search</span>. You can also set this flag later using the <span>Publish</span> update action.</p>
318318
* @param publish value to be set
319319
*/
320320

0 commit comments

Comments
 (0)