Skip to content

Commit 278ce69

Browse files
committed
Update javadoc
1 parent dc25b72 commit 278ce69

85 files changed

Lines changed: 11223 additions & 7419 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

javadoc/allclasses-index.html

Lines changed: 6000 additions & 5965 deletions
Large diffs are not rendered by default.

javadoc/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet" clas
8686
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</span>
8787
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/TypeApiMethod.html" title="class in io.vrap.rmf.base.client">TypeApiMethod</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>,<wbr><a href="../models/product/ProductProjection.html" title="interface in com.commercetools.api.models.product">ProductProjection</a>&gt;
8888
implements <a href="ProjectionselectingtailoringTrait.html" title="interface in com.commercetools.api.client">ProjectionselectingtailoringTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;, <a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;, <a href="LocaleprojectingTrait.html" title="interface in com.commercetools.api.client">LocaleprojectingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet</a>&gt;</span></div>
89-
<div class="block"><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>.</p>
90-
<p>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.</p>
91-
<p>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.</p>
92-
<p>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>
89+
<div class="block"><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>
9390

9491
<hr>
9592
<div class=code-example>

javadoc/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet"
8686
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</span>
8787
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/TypeApiMethod.html" title="class in io.vrap.rmf.base.client">TypeApiMethod</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>,<wbr><a href="../models/product/ProductProjection.html" title="interface in com.commercetools.api.models.product">ProductProjection</a>&gt;
8888
implements <a href="ProjectionselectingtailoringTrait.html" title="interface in com.commercetools.api.client">ProjectionselectingtailoringTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;, <a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;, <a href="LocaleprojectingTrait.html" title="interface in com.commercetools.api.client">LocaleprojectingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet</a>&gt;</span></div>
89-
<div class="block"><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>.</p>
90-
<p>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.</p>
91-
<p>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>
92-
<p>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>
89+
<div class="block"><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>
9390

9491
<hr>
9592
<div class=code-example>

javadoc/com/commercetools/api/client/ByProjectKeyRecurringOrdersByIDPost.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyRecurringOrdersByIDPost" class="title">Class ByProj
8989
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/TypeBodyApiMethod.html" title="class in io.vrap.rmf.base.client">TypeBodyApiMethod</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPost</a>,<wbr><a href="../models/recurring_order/RecurringOrder.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrder</a>,<wbr><a href="../models/recurring_order/RecurringOrderUpdate.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrderUpdate</a>&gt;
9090
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPost</a>&gt;</span></div>
9191
<div class="block"><p>Updates a Recurring Order using one or more <span>update actions</span>.</p>
92+
<p>A Recurring Order can only be updated when it is not processing an Order. Otherwise, an <a href="https://docs.commercetools.com/apis/ctp:api:type:InvalidOperationError" rel="nofollow">InvalidOperation</a> error is returned.</p>
9293

9394
<hr>
9495
<div class=code-example>

javadoc/com/commercetools/api/client/ByProjectKeyRecurringOrdersByIDPostString.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyRecurringOrdersByIDPostString" class="title">Class
9191
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/StringBodyApiMethod.html" title="class in io.vrap.rmf.base.client">StringBodyApiMethod</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPostString</a>,<wbr><a href="../models/recurring_order/RecurringOrder.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrder</a>&gt;
9292
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPostString</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersByIDPostString</a>&gt;</span></div>
9393
<div class="block"><p>Updates a Recurring Order using one or more <span>update actions</span>.</p>
94+
<p>A Recurring Order can only be updated when it is not processing an Order. Otherwise, an <a href="https://docs.commercetools.com/apis/ctp:api:type:InvalidOperationError" rel="nofollow">InvalidOperation</a> error is returned.</p>
9495

9596
<hr>
9697
<div class=code-example>

javadoc/com/commercetools/api/client/ByProjectKeyRecurringOrdersKeyByKeyPost.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyRecurringOrdersKeyByKeyPost" class="title">Class By
8989
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/TypeBodyApiMethod.html" title="class in io.vrap.rmf.base.client">TypeBodyApiMethod</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPost</a>,<wbr><a href="../models/recurring_order/RecurringOrder.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrder</a>,<wbr><a href="../models/recurring_order/RecurringOrderUpdate.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrderUpdate</a>&gt;
9090
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPost</a>&gt;</span></div>
9191
<div class="block"><p>Updates a Recurring Order using one or more <span>update actions</span>.</p>
92+
<p>A Recurring Order can only be updated when it is not processing an Order. Otherwise, an <a href="https://docs.commercetools.com/apis/ctp:api:type:InvalidOperationError" rel="nofollow">InvalidOperation</a> error is returned.</p>
9293

9394
<hr>
9495
<div class=code-example>

javadoc/com/commercetools/api/client/ByProjectKeyRecurringOrdersKeyByKeyPostString.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyRecurringOrdersKeyByKeyPostString" class="title">Cl
9191
<span class="extends-implements">extends <a href="../../../../io/vrap/rmf/base/client/StringBodyApiMethod.html" title="class in io.vrap.rmf.base.client">StringBodyApiMethod</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPostString</a>,<wbr><a href="../models/recurring_order/RecurringOrder.html" title="interface in com.commercetools.api.models.recurring_order">RecurringOrder</a>&gt;
9292
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPostString</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyRecurringOrdersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyRecurringOrdersKeyByKeyPostString</a>&gt;</span></div>
9393
<div class="block"><p>Updates a Recurring Order using one or more <span>update actions</span>.</p>
94+
<p>A Recurring Order can only be updated when it is not processing an Order. Otherwise, an <a href="https://docs.commercetools.com/apis/ctp:api:type:InvalidOperationError" rel="nofollow">InvalidOperation</a> error is returned.</p>
9495

9596
<hr>
9697
<div class=code-example>

javadoc/com/commercetools/api/models/DomainResource.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

javadoc/com/commercetools/api/models/Identifiable.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

javadoc/com/commercetools/api/models/ResourceUpdateAction.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)