Skip to content

Commit bd70088

Browse files
committed
Update javadoc
1 parent 34e2578 commit bd70088

132 files changed

Lines changed: 18196 additions & 22437 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: 10049 additions & 10184 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ <h1 title="Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusiness
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPost</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="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPost</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>,<wbr><a href="../models/order/OrderFromQuoteDraft.html" title="interface in com.commercetools.api.models.order">OrderFromQuoteDraft</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPost.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPost</a>&gt;</span></div>
91-
<div class="block"><p>Creates an Order from a Quote in a BusinessUnit. Creating an Order fails with an InvalidOperation if the Quote does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter.</p>
91+
<div class="block"><p>Creates an Order from a Quote in a BusinessUnit.</p>
92+
<p>The Quote must reference the same Business Unit as the <code>businessUnitKey</code> path parameter, must have the <code>Pending</code> state, and must be valid (not past the <code>validTo</code> date). If these criteria are not met, an InvalidOperation error is returned.</p>
9293
<p>Specific Error Codes:</p>
9394
<ul>
9495
<li>InvalidItemShippingDetails</li>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ <h1 title="Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusiness
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPostString</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="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPostString</a>,<wbr><a href="../models/order/Order.html" title="interface in com.commercetools.api.models.order">Order</a>&gt;
9292
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPostString.html" title="class in com.commercetools.api.client">ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersQuotesPostString</a>&gt;</span></div>
93-
<div class="block"><p>Creates an Order from a Quote in a BusinessUnit. Creating an Order fails with an InvalidOperation if the Quote does not reference the same BusinessUnit as the <code>businessUnitKey</code> path parameter.</p>
93+
<div class="block"><p>Creates an Order from a Quote in a BusinessUnit.</p>
94+
<p>The Quote must reference the same Business Unit as the <code>businessUnitKey</code> path parameter, must have the <code>Pending</code> state, and must be valid (not past the <code>validTo</code> date). If these criteria are not met, an InvalidOperation error is returned.</p>
9495
<p>Specific Error Codes:</p>
9596
<ul>
9697
<li>InvalidItemShippingDetails</li>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ <h1 title="Class ByProjectKeyCustomersEmailConfirmPost" class="title">Class ByPr
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersEmailConfirmPost</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="ByProjectKeyCustomersEmailConfirmPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailConfirmPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerEmailVerify.html" title="interface in com.commercetools.api.models.customer">CustomerEmailVerify</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailConfirmPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailConfirmPost</a>&gt;</span></div>
91-
<div class="block"><p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
91+
<div class="block"><p>Use this method to verify a global Customer's email during their email verification process.</p>
92+
<p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
9293

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

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ <h1 title="Class ByProjectKeyCustomersEmailConfirmPostString" class="title">Clas
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersEmailConfirmPostString</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="ByProjectKeyCustomersEmailConfirmPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailConfirmPostString</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
9292
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailConfirmPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailConfirmPostString</a>&gt;</span></div>
93-
<div class="block"><p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
93+
<div class="block"><p>Use this method to verify a global Customer's email during their email verification process.</p>
94+
<p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
9495

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

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ <h1 title="Class ByProjectKeyCustomersEmailTokenByEmailTokenGet" class="title">C
8686
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersEmailTokenByEmailTokenGet</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="ByProjectKeyCustomersEmailTokenByEmailTokenGet.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenByEmailTokenGet</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
8888
implements <a href="ExpandableTrait.html" title="interface in com.commercetools.api.client">ExpandableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailTokenByEmailTokenGet.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenByEmailTokenGet</a>&gt;, <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailTokenByEmailTokenGet.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenByEmailTokenGet</a>&gt;, <a href="Deprecatable200Trait.html" title="interface in com.commercetools.api.client">Deprecatable200Trait</a>&lt;<a href="ByProjectKeyCustomersEmailTokenByEmailTokenGet.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenByEmailTokenGet</a>&gt;</span></div>
89-
<div class="block"><hr>
89+
<div class="block"><p>Use this method to retrieve a global Customer's details by using the email token during their email verification process.</p>
90+
91+
<hr>
9092
<div class=code-example>
9193
<pre><code class='java'><code>
9294
CompletableFuture&lt;ApiHttpResponse&lt;com.commercetools.api.models.customer.Customer&gt;&gt; result = apiRoot

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ <h1 title="Class ByProjectKeyCustomersEmailTokenPost" class="title">Class ByProj
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersEmailTokenPost</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="ByProjectKeyCustomersEmailTokenPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenPost</a>,<wbr><a href="../models/customer/CustomerToken.html" title="interface in com.commercetools.api.models.customer">CustomerToken</a>,<wbr><a href="../models/customer/CustomerCreateEmailToken.html" title="interface in com.commercetools.api.models.customer">CustomerCreateEmailToken</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailTokenPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenPost</a>&gt;</span></div>
91-
<div class="block"><p>Produces the CustomerEmailTokenCreated Message.</p>
91+
<div class="block"><p>Use this method to create an email token for a global Customer during their email verification process.</p>
92+
<p>Creating an email token for the Customer produces the CustomerEmailTokenCreated Message.</p>
9293

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

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ <h1 title="Class ByProjectKeyCustomersEmailTokenPostString" class="title">Class
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersEmailTokenPostString</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="ByProjectKeyCustomersEmailTokenPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenPostString</a>,<wbr><a href="../models/customer/CustomerToken.html" title="interface in com.commercetools.api.models.customer">CustomerToken</a>&gt;
9292
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersEmailTokenPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersEmailTokenPostString</a>&gt;</span></div>
93-
<div class="block"><p>Produces the CustomerEmailTokenCreated Message.</p>
93+
<div class="block"><p>Use this method to create an email token for a global Customer during their email verification process.</p>
94+
<p>Creating an email token for the Customer produces the CustomerEmailTokenCreated Message.</p>
9495

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

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ <h1 title="Class ByProjectKeyCustomersPasswordResetPost" class="title">Class ByP
8888
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPasswordResetPost</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="ByProjectKeyCustomersPasswordResetPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordResetPost</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>,<wbr><a href="../models/customer/CustomerResetPassword.html" title="interface in com.commercetools.api.models.customer">CustomerResetPassword</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersPasswordResetPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordResetPost</a>&gt;</span></div>
91-
<div class="block"><p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
91+
<div class="block"><p>Use this method to reset a global Customer's password during their password reset process.</p>
92+
<p>After the password is reset, any previously issued access and/or refresh tokens created through the password flow or refresh token flow are invalidated.</p>
93+
<p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
9294

9395
<hr>
9496
<div class=code-example>

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ <h1 title="Class ByProjectKeyCustomersPasswordResetPostString" class="title">Cla
9090
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByProjectKeyCustomersPasswordResetPostString</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="ByProjectKeyCustomersPasswordResetPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordResetPostString</a>,<wbr><a href="../models/customer/Customer.html" title="interface in com.commercetools.api.models.customer">Customer</a>&gt;
9292
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersPasswordResetPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordResetPostString</a>&gt;</span></div>
93-
<div class="block"><p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
93+
<div class="block"><p>Use this method to reset a global Customer's password during their password reset process.</p>
94+
<p>After the password is reset, any previously issued access and/or refresh tokens created through the password flow or refresh token flow are invalidated.</p>
95+
<p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
9496

9597
<hr>
9698
<div class=code-example>

0 commit comments

Comments
 (0)