Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/commercetools-api/docs/RequestBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -5679,6 +5679,8 @@ and [inventory](ctp:api:type:ProductProjectionInventoryEntries).

If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store.

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.

When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.


Expand Down Expand Up @@ -5719,6 +5721,8 @@ and [inventory](ctp:api:type:ProductProjectionInventoryEntries).

If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/projects/stores#products-available-in-store) in the specified Store.

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.

When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@
/**

* @psalm-suppress PropertyNotSetInConstructor
* @template-implements ProjectionSelecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements ProjectionSelectingTailoring<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements PriceSelecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements LocaleProjecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements Expandable<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements Errorable<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
* @template-implements Deprecatable200<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet>
*/
class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, Expandable, Errorable, Deprecatable200
class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet extends ApiRequest implements ProjectionSelectingTailoring, PriceSelecting, LocaleProjecting, Expandable, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@
/**

* @psalm-suppress PropertyNotSetInConstructor
* @template-implements ProjectionSelecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements ProjectionSelectingTailoring<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements PriceSelecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements LocaleProjecting<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements Expandable<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements Errorable<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
* @template-implements Deprecatable200<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet>
*/
class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, Expandable, Errorable, Deprecatable200
class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet extends ApiRequest implements ProjectionSelectingTailoring, PriceSelecting, LocaleProjecting, Expandable, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@
* @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsByIDGet>
* @template-implements PriceSelecting<ByProjectKeyProductProjectionsByIDGet>
* @template-implements LocaleProjecting<ByProjectKeyProductProjectionsByIDGet>
* @template-implements StoreProjecting<ByProjectKeyProductProjectionsByIDGet>
* @template-implements StoreProjectingTailoring<ByProjectKeyProductProjectionsByIDGet>
* @template-implements Expandable<ByProjectKeyProductProjectionsByIDGet>
* @template-implements Errorable<ByProjectKeyProductProjectionsByIDGet>
* @template-implements Deprecatable200<ByProjectKeyProductProjectionsByIDGet>
*/
class ByProjectKeyProductProjectionsByIDGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjecting, Expandable, Errorable, Deprecatable200
class ByProjectKeyProductProjectionsByIDGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjectingTailoring, Expandable, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@
* @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsGet>
* @template-implements PriceSelecting<ByProjectKeyProductProjectionsGet>
* @template-implements LocaleProjecting<ByProjectKeyProductProjectionsGet>
* @template-implements StoreProjecting<ByProjectKeyProductProjectionsGet>
* @template-implements StoreProjectingTailoring<ByProjectKeyProductProjectionsGet>
* @template-implements Expandable<ByProjectKeyProductProjectionsGet>
* @template-implements Sortable<ByProjectKeyProductProjectionsGet>
* @template-implements Paging<ByProjectKeyProductProjectionsGet>
* @template-implements Query<ByProjectKeyProductProjectionsGet>
* @template-implements Errorable<ByProjectKeyProductProjectionsGet>
* @template-implements Deprecatable200<ByProjectKeyProductProjectionsGet>
*/
class ByProjectKeyProductProjectionsGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjecting, Expandable, Sortable, Paging, Query, Errorable, Deprecatable200
class ByProjectKeyProductProjectionsGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjectingTailoring, Expandable, Sortable, Paging, Query, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@
* @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements PriceSelecting<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements LocaleProjecting<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements StoreProjecting<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements StoreProjectingTailoring<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements Expandable<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements Errorable<ByProjectKeyProductProjectionsKeyByKeyGet>
* @template-implements Deprecatable200<ByProjectKeyProductProjectionsKeyByKeyGet>
*/
class ByProjectKeyProductProjectionsKeyByKeyGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjecting, Expandable, Errorable, Deprecatable200
class ByProjectKeyProductProjectionsKeyByKeyGet extends ApiRequest implements ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjectingTailoring, Expandable, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@
* @template-implements ProjectionSelecting<ByProjectKeyProductProjectionsSearchGet>
* @template-implements PriceSelecting<ByProjectKeyProductProjectionsSearchGet>
* @template-implements LocaleProjecting<ByProjectKeyProductProjectionsSearchGet>
* @template-implements StoreProjecting<ByProjectKeyProductProjectionsSearchGet>
* @template-implements StoreProjectingTailoring<ByProjectKeyProductProjectionsSearchGet>
* @template-implements Expandable<ByProjectKeyProductProjectionsSearchGet>
* @template-implements Errorable<ByProjectKeyProductProjectionsSearchGet>
* @template-implements Deprecatable200<ByProjectKeyProductProjectionsSearchGet>
*/
class ByProjectKeyProductProjectionsSearchGet extends ApiRequest implements Sortable, Paging, ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjecting, Expandable, Errorable, Deprecatable200
class ByProjectKeyProductProjectionsSearchGet extends ApiRequest implements Sortable, Paging, ProjectionSelecting, PriceSelecting, LocaleProjecting, StoreProjectingTailoring, Expandable, Errorable, Deprecatable200
{
/**
* @param ?object|array|string $body
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php

declare(strict_types=1);
/**
* This file has been auto generated
* Do not change it.
*/

namespace Commercetools\Api\Client\Resource;

use Commercetools\Client\ApiRequestInterface;

/**
* @template T of ApiRequestInterface
* @template-extends ApiRequestInterface<T>
*/
interface ProjectionSelectingTailoring extends ApiRequestInterface
{
/**
* @return ApiRequestInterface
* @psalm-return T
*/
public function withStaged(bool $staged);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php

declare(strict_types=1);
/**
* This file has been auto generated
* Do not change it.
*/

namespace Commercetools\Api\Client\Resource;

use Commercetools\Client\ApiRequestInterface;

/**
* @template T of ApiRequestInterface
* @template-extends ApiRequestInterface<T>
*/
interface StoreProjectingTailoring extends ApiRequestInterface
{
/**
* @return ApiRequestInterface
* @psalm-return T
*/
public function withStoreProjection(string $storeProjection);
}
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ public function getLocaleProjection();

/**
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
* If the Store has defined some languages, countries, distribution or supply Channels,
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.
* If the Store has defined <a href="ctp:api:type:ProductSelection">Product Selections</a> or <a href="ctp:api:type:ProductTailoring">Product Tailoring</a>, they have no effect on the results of this query.</p>
* For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/projects/stores#products-available-in-store">availability of the Product in the specified Store</a> into account.
* <a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses, but evaluating <a href="/../api/search-query-language#simple-expressions">query expressions</a> is restricted to the original product information.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,11 @@ public function getLocaleProjection()

/**
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
* If the Store has defined some languages, countries, distribution or supply Channels,
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.
* If the Store has defined <a href="ctp:api:type:ProductSelection">Product Selections</a> or <a href="ctp:api:type:ProductTailoring">Product Tailoring</a>, they have no effect on the results of this query.</p>
* For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/projects/stores#products-available-in-store">availability of the Product in the specified Store</a> into account.
* <a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses, but evaluating <a href="/../api/search-query-language#simple-expressions">query expressions</a> is restricted to the original product information.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,11 @@ public function getLocaleProjection()

/**
* <p><code>key</code> of an existing <a href="ctp:api:type:Store">Store</a>.
* If the Store has defined some languages, countries, distribution or supply Channels,
* If the Store has defined <code>languages</code>, <code>countries</code>, <code>distributionChannels</code>, or <code>supplyChannels</code>,
* they are used for projections based on <a href="ctp:api:type:ProductProjectionLocales">locale</a>, <a href="ctp:api:type:ProductProjectionPrices">price</a>,
* and <a href="ctp:api:type:ProductProjectionInventoryEntries">inventory</a>.
* If the Store has defined <a href="ctp:api:type:ProductSelection">Product Selections</a> or <a href="ctp:api:type:ProductTailoring">Product Tailoring</a>, they have no effect on the results of this query.</p>
* For Projects with active <a href="/../api/projects/product-selections">Product Selections</a>, the API does not take the <a href="/../api/projects/stores#products-available-in-store">availability of the Product in the specified Store</a> into account.
* <a href="/../api/projects/product-tailoring">Product Tailoring</a> modifies the product information returned in API responses, but evaluating <a href="/../api/search-query-language#simple-expressions">query expressions</a> is restricted to the original product information.</p>
*
*
* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,9 @@ public function getStore();
public function getProduct();

/**
* <p><code>true</code> if the ProductTailoring is published.</p>
* <p>If <code>true</code>, the tailored information contained in the <code>current</code> <a href="ctp:api:type:ProductTailoringData">ProductTailoringData</a> is provided when <a href="/../api/projects/product-tailoring#retrieve-product-projection-with-tailored-information">retrieving the ProductProjection in Store</a>.
* For information not part of the ProductTailoringData, the original information contained in the <a href="ctp:api:type:ProductData">ProductData</a> is provided.
* If <code>false</code>, only the original information contained in the ProductData is provided.</p>
*

* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,9 @@ public function getProduct()
}

/**
* <p><code>true</code> if the ProductTailoring is published.</p>
* <p>If <code>true</code>, the tailored information contained in the <code>current</code> <a href="ctp:api:type:ProductTailoringData">ProductTailoringData</a> is provided when <a href="/../api/projects/product-tailoring#retrieve-product-projection-with-tailored-information">retrieving the ProductProjection in Store</a>.
* For information not part of the ProductTailoringData, the original information contained in the <a href="ctp:api:type:ProductData">ProductData</a> is provided.
* If <code>false</code>, only the original information contained in the ProductData is provided.</p>
*

* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ public function getMetaKeywords();
public function getSlug();

/**
* <p>If <code>true</code>, the ProductTailoring is published immediately.</p>
* <p>Set to <code>true</code> to <a href="/../api/projects/product-tailoring#stage-and-publish-tailored-product-information">publish</a> the ProductTailoring immediately.
* Otherwise, the tailored product information is just staged.</p>
*

* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ public function getSlug()
}

/**
* <p>If <code>true</code>, the ProductTailoring is published immediately.</p>
* <p>Set to <code>true</code> to <a href="/../api/projects/product-tailoring#stage-and-publish-tailored-product-information">publish</a> the ProductTailoring immediately.
* Otherwise, the tailored product information is just staged.</p>
*

* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ public function getSlug()
}

/**
* <p>If <code>true</code>, the ProductTailoring is published immediately.</p>
* <p>Set to <code>true</code> to <a href="/../api/projects/product-tailoring#stage-and-publish-tailored-product-information">publish</a> the ProductTailoring immediately.
* Otherwise, the tailored product information is just staged.</p>
*
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,9 @@ public function getProduct()
}

/**
* <p><code>true</code> if the ProductTailoring is published.</p>
* <p>If <code>true</code>, the tailored information contained in the <code>current</code> <a href="ctp:api:type:ProductTailoringData">ProductTailoringData</a> is provided when <a href="/../api/projects/product-tailoring#retrieve-product-projection-with-tailored-information">retrieving the ProductProjection in Store</a>.
* For information not part of the ProductTailoringData, the original information contained in the <a href="ctp:api:type:ProductData">ProductData</a> is provided.
* If <code>false</code>, only the original information contained in the ProductData is provided.</p>
*
*
* @return null|bool
Expand Down
1 change: 1 addition & 0 deletions references.txt
Original file line number Diff line number Diff line change
Expand Up @@ -374,3 +374,4 @@ be04b8a13c612b3eed8290dd00b81c2ebe16e5ed
e2594613d04733e91fe77848b55c73f255fac743
d6a0c240644648d19c9880bc8eb48f961165dfec
020bd279b2cc54072bf692d0654c883d73ade338
a4fe92e28e967d91ddaad6750b6434a65949b840