Skip to content

Commit 45b20c1

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Update javadoc
1 parent 293e2e9 commit 45b20c1

79 files changed

Lines changed: 2471 additions & 2357 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: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11800,7 +11800,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
1180011800
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
1180111801
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/product/CategoryOrderHints.html" title="interface in com.commercetools.api.models.product">CategoryOrderHints</a></div>
1180211802
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
11803-
<div class="block">JSON object where the key is a Category <code>id</code> and the value is an order hint.</div>
11803+
<div class="block">JSON object where the keys are Category <code>id</code>, and the values are order hint values: strings representing a number between <code>0</code> and <code>1</code>, but not ending in <code>0</code>.</div>
1180411804
</div>
1180511805
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/history/models/common/CategoryOrderHints.html" title="interface in com.commercetools.history.models.common">CategoryOrderHints</a></div>
1180611806
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
@@ -20514,7 +20514,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
2051420514
</div>
2051520515
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/importapi/models/importsummaries/ImportSummary.html" title="interface in com.commercetools.importapi.models.importsummaries">ImportSummary</a></div>
2051620516
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
20517-
<div class="block">Describes the status of an ImportContainer by the number of resources in each Processing State.</div>
20517+
<div class="block">Describes the status of an ImportContainer by the number of resources in each ProcessingState.</div>
2051820518
</div>
2051920519
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/importapi/models/importsummaries/ImportSummaryBuilder.html" title="class in com.commercetools.importapi.models.importsummaries">ImportSummaryBuilder</a></div>
2052020520
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -23847,11 +23847,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
2384723847
</div>
2384823848
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/me/MyShoppingListSetDeleteDaysAfterLastModificationAction.html" title="interface in com.commercetools.api.models.me">MyShoppingListSetDeleteDaysAfterLastModificationAction</a></div>
2384923849
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
23850-
<div class="block">MyShoppingListSetDeleteDaysAfterLastModificationAction
23851-
23852-
23853-
Example to create an instance using the builder pattern
23854-
</div>
23850+
<div class="block">Number of days after the last modification before a Shopping List is deleted.</div>
2385523851
</div>
2385623852
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/me/MyShoppingListSetDeleteDaysAfterLastModificationActionBuilder.html" title="class in com.commercetools.api.models.me">MyShoppingListSetDeleteDaysAfterLastModificationActionBuilder</a></div>
2385723853
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -24131,7 +24127,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
2413124127
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
2413224128
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/importapi/models/importsummaries/OperationStates.html" title="interface in com.commercetools.importapi.models.importsummaries">OperationStates</a></div>
2413324129
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
24134-
<div class="block">The number of resources in each Processing State.</div>
24130+
<div class="block">The number of resources in each ProcessingState.</div>
2413524131
</div>
2413624132
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/importapi/models/importsummaries/OperationStatesBuilder.html" title="class in com.commercetools.importapi.models.importsummaries">OperationStatesBuilder</a></div>
2413724133
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -31711,7 +31707,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
3171131707
</div>
3171231708
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/product/ProductVariantChannelAvailabilityMap.html" title="interface in com.commercetools.api.models.product">ProductVariantChannelAvailabilityMap</a></div>
3171331709
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
31714-
<div class="block">JSON object where the key is a supply Channel <code>id</code> and the value is the ProductVariantChannelAvailability of the InventoryEntry.</div>
31710+
<div class="block">JSON object where the keys are supply Channel <code>id</code>, and the values are ProductVariantChannelAvailability.</div>
3171531711
</div>
3171631712
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/history/models/common/ProductVariantChannelAvailabilityMap.html" title="interface in com.commercetools.history.models.common">ProductVariantChannelAvailabilityMap</a></div>
3171731713
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
@@ -34971,7 +34967,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
3497134967
</div>
3497234968
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/product/SearchKeywords.html" title="interface in com.commercetools.api.models.product">SearchKeywords</a></div>
3497334969
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
34974-
<div class="block">Search keywords are JSON objects primarily used by Product Suggestions, but are also considered for a full text search.</div>
34970+
<div class="block">Although search keywords are primarily used by Product Suggestions, they are also considered for a full text search.</div>
3497534971
</div>
3497634972
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/history/models/common/SearchKeywords.html" title="interface in com.commercetools.history.models.common">SearchKeywords</a></div>
3497734973
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
@@ -38101,11 +38097,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
3810138097
</div>
3810238098
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/shopping_list/ShoppingListSetDeleteDaysAfterLastModificationAction.html" title="interface in com.commercetools.api.models.shopping_list">ShoppingListSetDeleteDaysAfterLastModificationAction</a></div>
3810338099
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
38104-
<div class="block">ShoppingListSetDeleteDaysAfterLastModificationAction
38105-
38106-
38107-
Example to create an instance using the builder pattern
38108-
</div>
38100+
<div class="block">Number of days after the last modification before a Shopping List is deleted.</div>
3810938101
</div>
3811038102
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/shopping_list/ShoppingListSetDeleteDaysAfterLastModificationActionBuilder.html" title="class in com.commercetools.api.models.shopping_list">ShoppingListSetDeleteDaysAfterLastModificationActionBuilder</a></div>
3811138103
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">

‎javadoc/com/commercetools/api/client/ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ <h1 title="Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusiness
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost</span>
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="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>,<wbr><a href="../models/order/OrderFromCartDraft.html" title="interface in com.commercetools.api.models.order">OrderFromCartDraft</a>&gt;
9090
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost</a>&gt;</span></div>
91-
<div class="block"><p>Creates an Order from a Cart in a BusinessUnit. The Cart must have a shipping address set before creating an Order. Creating an Order fails with an InvalidOperation if the Cart does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter.</p>
91+
<div class="block"><p>Creates an Order from a Cart in a BusinessUnit.</p>
92+
<p>The Cart must have a shipping address and an active Shipping Method set.</p>
93+
<p>If the Cart does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter, an InvalidOperation is returned.</p>
9294
<p>Specific Error Codes:</p>
9395
<ul>
9496
<li>DiscountCodeNonApplicable</li>

‎javadoc/com/commercetools/api/client/ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ <h1 title="Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusiness
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString</span>
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="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>&gt;
9292
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPostString</a>&gt;</span></div>
93-
<div class="block"><p>Creates an Order from a Cart in a BusinessUnit. The Cart must have a shipping address set before creating an Order. Creating an Order fails with an InvalidOperation if the Cart does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter.</p>
93+
<div class="block"><p>Creates an Order from a Cart in a BusinessUnit.</p>
94+
<p>The Cart must have a shipping address and an active Shipping Method set.</p>
95+
<p>If the Cart does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter, an InvalidOperation is returned.</p>
9496
<p>Specific Error Codes:</p>
9597
<ul>
9698
<li>DiscountCodeNonApplicable</li>

‎javadoc/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost" class="title">Cla
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="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>,<wbr><a href="../models/me/MyOrderFromCartDraft.html" title="interface in com.commercetools.api.models.me">MyOrderFromCartDraft</a>&gt;
9090
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost</a>&gt;</span></div>
9191
<div class="block"><p>Creates an Order from a Cart in a Store for the Customer or anonymous user. The <code>customerId</code> or <code>anonymousId</code> field on the Order is automatically set based on the customer:{id} or anonymous_id:{id} scope.</p>
92-
<p>The Cart must have a shipping address set for taxes to be calculated. When creating B2B Orders, the Customer must have the <code>CreateMyOrdersFromMyCarts</code> Permission.</p>
92+
<p>The Cart must have a shipping address and an active Shipping Method set.</p>
93+
<p>When creating B2B Orders, the Customer must have the <code>CreateMyOrdersFromMyCarts</code> Permission.</p>
9394
<p>If the Cart's <code>customerId</code> does not match the customer:{id} scope, or the <code>anonymousId</code> does not match the anonymous_id:{id} scope, a ResourceNotFound error is returned.</p>
9495
<p>Creating an Order produces the OrderCreated Message.</p>
9596
<p>Specific Error Codes:</p>

‎javadoc/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString" class="titl
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="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>&gt;
9292
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyMeOrdersPostString</a>&gt;</span></div>
9393
<div class="block"><p>Creates an Order from a Cart in a Store for the Customer or anonymous user. The <code>customerId</code> or <code>anonymousId</code> field on the Order is automatically set based on the customer:{id} or anonymous_id:{id} scope.</p>
94-
<p>The Cart must have a shipping address set for taxes to be calculated. When creating B2B Orders, the Customer must have the <code>CreateMyOrdersFromMyCarts</code> Permission.</p>
94+
<p>The Cart must have a shipping address and an active Shipping Method set.</p>
95+
<p>When creating B2B Orders, the Customer must have the <code>CreateMyOrdersFromMyCarts</code> Permission.</p>
9596
<p>If the Cart's <code>customerId</code> does not match the customer:{id} scope, or the <code>anonymousId</code> does not match the anonymous_id:{id} scope, a ResourceNotFound error is returned.</p>
9697
<p>Creating an Order produces the OrderCreated Message.</p>
9798
<p>Specific Error Codes:</p>

0 commit comments

Comments
 (0)