Skip to content

Commit dc25b72

Browse files
committed
Update javadoc
1 parent 34465c2 commit dc25b72

89 files changed

Lines changed: 19885 additions & 14815 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: 10006 additions & 9949 deletions
Large diffs are not rendered by default.

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,7 @@ <h1 title="Class ByProjectKeyCustomersPost" class="title">Class ByProjectKeyCust
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPost</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="ByProjectKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPost</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>,<wbr><a href="../models/customer/CustomerDraft.html" title="interface in com.commercetools.api.models.customer">CustomerDraft</a>&gt;
9090
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPost</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPost</a>&gt;</span></div>
91-
<div class="block"><p>If the <code>anonymousCart</code> field is set on the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerDraft" rel="nofollow">CustomerDraft</a>, then the newly created Customer will be assigned to that <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Cart</a>. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Carts</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:Order" rel="nofollow">Orders</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ShoppingList" rel="nofollow">ShoppingLists</a> and <a href="https://docs.commercetools.com/apis/ctp:api:type:Payment" rel="nofollow">Payments</a> with the same <code>anonymousId</code>.</p>
92-
<p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
91+
<div class="block"><p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
9392

9493
<hr>
9594
<div class=code-example>

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ <h1 title="Class ByProjectKeyCustomersPostString" class="title">Class ByProjectK
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPostString</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="ByProjectKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPostString</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>&gt;
9292
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPostString</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPostString</a>&gt;</span></div>
93-
<div class="block"><p>If the <code>anonymousCart</code> field is set on the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerDraft" rel="nofollow">CustomerDraft</a>, then the newly created Customer will be assigned to that <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Cart</a>. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Carts</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:Order" rel="nofollow">Orders</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ShoppingList" rel="nofollow">ShoppingLists</a> and <a href="https://docs.commercetools.com/apis/ctp:api:type:Payment" rel="nofollow">Payments</a> with the same <code>anonymousId</code>.</p>
94-
<p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
93+
<div class="block"><p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
9594

9695
<hr>
9796
<div class=code-example>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyDiscountGroupsPost" class="title">Class ByProjectKe
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="ByProjectKeyDiscountGroupsPost.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPost</a>,<wbr><a href="../models/discount_group/DiscountGroup.html" title="interface in com.commercetools.api.models.discount_group">DiscountGroup</a>,<wbr><a href="../models/discount_group/DiscountGroupDraft.html" title="interface in com.commercetools.api.models.discount_group">DiscountGroupDraft</a>&gt;
9090
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyDiscountGroupsPost.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPost</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyDiscountGroupsPost.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyDiscountGroupsPost.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPost</a>&gt;</span></div>
9191
<div class="block"><p>Creates a DiscountGroup in the Project. This request generates the <a href="https://docs.commercetools.com/apis/ctp:api:type:DiscountGroupCreatedMessage" rel="nofollow">DiscountGroupCreated</a> Message.</p>
92+
<p>If the <span>limit</span> for active Discount Groups has been reached, a <a href="https://docs.commercetools.com/apis/ctp:api:type:MaxDiscountGroupsReachedError" rel="nofollow">MaxDiscountGroupsReached</a> error is returned.</p>
9293

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyDiscountGroupsPostString" class="title">Class ByPro
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="ByProjectKeyDiscountGroupsPostString.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPostString</a>,<wbr><a href="../models/discount_group/DiscountGroup.html" title="interface in com.commercetools.api.models.discount_group">DiscountGroup</a>&gt;
9292
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyDiscountGroupsPostString.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPostString</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyDiscountGroupsPostString.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyDiscountGroupsPostString.html" title="class in com.commercetools.api.client">ByProjectKeyDiscountGroupsPostString</a>&gt;</span></div>
9393
<div class="block"><p>Creates a DiscountGroup in the Project. This request generates the <a href="https://docs.commercetools.com/apis/ctp:api:type:DiscountGroupCreatedMessage" rel="nofollow">DiscountGroupCreated</a> Message.</p>
94+
<p>If the <span>limit</span> for active Discount Groups has been reached, a <a href="https://docs.commercetools.com/apis/ctp:api:type:MaxDiscountGroupsReachedError" rel="nofollow">MaxDiscountGroupsReached</a> error is returned.</p>
9495

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

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersPost" class="title">Cl
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="ByProjectKeyInStoreKeyByStoreKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPost</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>,<wbr><a href="../models/customer/CustomerDraft.html" title="interface in com.commercetools.api.models.customer">CustomerDraft</a>&gt;
9090
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPost</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPost</a>&gt;</span></div>
9191
<div class="block"><p>When using this endpoint, if omitted, the Customer <code>stores</code> field is set to the <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the path parameter.</p>
92-
<p>If the <code>anonymousCart</code> field is set on the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerDraft" rel="nofollow">CustomerDraft</a>, then the newly created Customer will be assigned to that <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Cart</a>. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Carts</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:Order" rel="nofollow">Orders</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ShoppingList" rel="nofollow">ShoppingLists</a> and <a href="https://docs.commercetools.com/apis/ctp:api:type:Payment" rel="nofollow">Payments</a> with the same <code>anonymousId</code>. If a Cart with a <code>store</code> field specified, the <code>store</code> field must reference the same <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the <code>{storeKey}</code> path parameter.</p>
92+
<p>If a Cart with a <code>store</code> field specified, the <code>store</code> field must reference the same <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the <code>{storeKey}</code> path parameter.</p>
93+
<p>If the Customer has multiple active Carts, the anonymous Cart is <span>merged</span> into the most recently modified active Cart.</p>
9394
<p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
9495

9596
<hr>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersPostString" class="tit
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="ByProjectKeyInStoreKeyByStoreKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPostString</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>&gt;
9292
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPostString</a>&gt;, <a href="Deprecatable201Trait.html" title="interface in com.commercetools.api.client">Deprecatable201Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersPostString</a>&gt;</span></div>
9393
<div class="block"><p>When using this endpoint, if omitted, the Customer <code>stores</code> field is set to the <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the path parameter.</p>
94-
<p>If the <code>anonymousCart</code> field is set on the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerDraft" rel="nofollow">CustomerDraft</a>, then the newly created Customer will be assigned to that <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Cart</a>. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all <a href="https://docs.commercetools.com/apis/ctp:api:type:Cart" rel="nofollow">Carts</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:Order" rel="nofollow">Orders</a>, <a href="https://docs.commercetools.com/apis/ctp:api:type:ShoppingList" rel="nofollow">ShoppingLists</a> and <a href="https://docs.commercetools.com/apis/ctp:api:type:Payment" rel="nofollow">Payments</a> with the same <code>anonymousId</code>. If a Cart with a <code>store</code> field specified, the <code>store</code> field must reference the same <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the <code>{storeKey}</code> path parameter.</p>
94+
<p>If a Cart with a <code>store</code> field specified, the <code>store</code> field must reference the same <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a> specified in the <code>{storeKey}</code> path parameter.</p>
95+
<p>If the Customer has multiple active Carts, the anonymous Cart is <span>merged</span> into the most recently modified active Cart.</p>
9596
<p>Creating a Customer produces the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerCreatedMessage" rel="nofollow">CustomerCreated</a> Message. Simultaneously creating two Customers with the same email address can return a <a href="https://docs.commercetools.com/apis/ctp:api:type:LockedFieldError" rel="nofollow">LockedField</a> error.</p>
9697

9798
<hr>

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,8 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyLoginPost" class="title">Class
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyInStoreKeyByStoreKeyLoginPost</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="ByProjectKeyInStoreKeyByStoreKeyLoginPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyLoginPost</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>,<wbr><a href="../models/customer/CustomerSignin.html" title="interface in com.commercetools.api.models.customer">CustomerSignin</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyLoginPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyLoginPost</a>&gt;</span></div>
91-
<div class="block"><p>Authenticates a Customer associated with a <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>. For more information, see <span>Global versus Store-specific Customers</span>.</p>
92-
<p>A Cart returned in the <a href="https://docs.commercetools.com/apis/ctp:api:type:CustomerSignInResult" rel="nofollow">CustomerSignInResult</a> has any invalid Line Items removed and is <span>updated</span> with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: <a href="https://docs.commercetools.com/apis/ctp:api:type:MatchingPriceNotFoundError" rel="nofollow">MatchingPriceNotFound</a> and <a href="https://docs.commercetools.com/apis/ctp:api:type:MissingTaxRateForCountryError" rel="nofollow">MissingTaxRateForCountry</a>.</p>
93-
<p>Triggers <span>Cart merge during sign-in</span>.</p>
91+
<div class="block"><p>Authenticates a Customer associated with a <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>.</p>
92+
<p>If the Customer has multiple active Carts, the anonymous Cart is <span>merged</span> into the most recently modified active Cart.</p>
9493
<p>If the Customer exists in the Project but the <code>stores</code> field references a different <a href="https://docs.commercetools.com/apis/ctp:api:type:Store" rel="nofollow">Store</a>, this method returns an <a href="https://docs.commercetools.com/apis/ctp:api:type:InvalidCredentialsError" rel="nofollow">InvalidCredentials</a> error.</p>
9594

9695
<hr>

0 commit comments

Comments
 (0)