Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ct-sdks
ct-sdks[bot] committed Apr 1, 2024
1 parent ae8d766 commit 04e1ef1
Show file tree
Hide file tree
Showing 646 changed files with 137,264 additions and 24,367 deletions.
25,422 changes: 13,380 additions & 12,042 deletions javadoc/allclasses-index.html
View file

Large diffs are not rendered by default.

146 changes: 76 additions & 70 deletions javadoc/allpackages-index.html
View file

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersByIDPost.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ <h1 title="Class ByProjectKeyCustomersByIDPost" class="title">Class ByProjectKey
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersByIDPost</span>
<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="ByProjectKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerUpdate.html" title="interface in com.commercetools.api.models.customer">CustomerUpdate</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPost</a>&gt;</span></div>
<div class="block"><hr>
<div class="block"><p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
<pre><code class='java'><code>
CompletableFuture&lt;ApiHttpResponse&lt;com.commercetools.api.models.customer.Customer&gt;&gt; result = apiRoot
Expand Down
4 changes: 3 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersByIDPostString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ <h1 title="Class ByProjectKeyCustomersByIDPostString" class="title">Class ByProj
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersByIDPostString</span>
<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="ByProjectKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPostString</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPostString</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersByIDPostString</a>&gt;</span></div>
<div class="block"><hr>
<div class="block"><p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
<pre><code class='java'><code>
CompletableFuture&lt;ApiHttpResponse&lt;com.commercetools.api.models.customer.Customer&gt;&gt; result = apiRoot
Expand Down
4 changes: 3 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersKeyByKeyPost.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ <h1 title="Class ByProjectKeyCustomersKeyByKeyPost" class="title">Class ByProjec
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersKeyByKeyPost</span>
<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="ByProjectKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerUpdate.html" title="interface in com.commercetools.api.models.customer">CustomerUpdate</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPost</a>&gt;</span></div>
<div class="block"><hr>
<div class="block"><p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
<pre><code class='java'><code>
CompletableFuture&lt;ApiHttpResponse&lt;com.commercetools.api.models.customer.Customer&gt;&gt; result = apiRoot
Expand Down
4 changes: 3 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersKeyByKeyPostString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ <h1 title="Class ByProjectKeyCustomersKeyByKeyPostString" class="title">Class By
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersKeyByKeyPostString</span>
<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="ByProjectKeyCustomersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPostString</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPostString</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersKeyByKeyPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersKeyByKeyPostString</a>&gt;</span></div>
<div class="block"><hr>
<div class="block"><p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
<pre><code class='java'><code>
CompletableFuture&lt;ApiHttpResponse&lt;com.commercetools.api.models.customer.Customer&gt;&gt; result = apiRoot
Expand Down
3 changes: 2 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersPost.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ <h1 title="Class ByProjectKeyCustomersPost" class="title">Class ByProjectKeyCust
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPost</span>
<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;
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>
<div class="block"><p>If the <code>anonymousCart</code> field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same <code>anonymousId</code>. Creating a Customer produces the CustomerCreated Message.</p>
<div class="block"><p>If the <code>anonymousCart</code> field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same <code>anonymousId</code>.</p>
<p>Creating a Customer produces the CustomerCreated Message. Simultaneously creating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
Expand Down
3 changes: 2 additions & 1 deletion javadoc/com/commercetools/api/client/ByProjectKeyCustomersPostString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ <h1 title="Class ByProjectKeyCustomersPostString" class="title">Class ByProjectK
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPostString</span>
<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;
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>
<div class="block"><p>If the <code>anonymousCart</code> field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same <code>anonymousId</code>. Creating a Customer produces the CustomerCreated Message.</p>
<div class="block"><p>If the <code>anonymousCart</code> field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the <code>anonymousId</code> field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same <code>anonymousId</code>.</p>
<p>Creating a Customer produces the CustomerCreated Message. Simultaneously creating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
Expand Down
1 change: 1 addition & 0 deletions javadoc/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost" class="title
<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="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerUpdate.html" title="interface in com.commercetools.api.models.customer">CustomerUpdate</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost</a>&gt;</span></div>
<div class="block"><p>If the Customer exists in the Project but the <code>stores</code> field references a different Store, this method returns a ResourceNotFound error.</p>
<p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
Expand Down
1 change: 1 addition & 0 deletions ...com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString" class=
<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="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPostString</a>&gt;</span></div>
<div class="block"><p>If the Customer exists in the Project but the <code>stores</code> field references a different Store, this method returns a ResourceNotFound error.</p>
<p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
Expand Down
1 change: 1 addition & 0 deletions ...c/com/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost" class="t
<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="ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerUpdate.html" title="interface in com.commercetools.api.models.customer">CustomerUpdate</a>&gt;
implements <a href="ConflictingTrait.html" title="interface in com.commercetools.api.client">ConflictingTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost</a>&gt;, <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost</a>&gt;</span></div>
<div class="block"><p>If the Customer exists in the Project but the <code>stores</code> field references a different Store, this method returns a ResourceNotFound error.</p>
<p>Simultaneously updating two Customers with the same email address can return a LockedField error.</p>

<hr>
<div class=code-example>
Expand Down
Loading

0 comments on commit 04e1ef1

Please sign in to comment.