Skip to content

Commit 293e2e9

Browse files
committed
Update javadoc
1 parent 2c60478 commit 293e2e9

121 files changed

Lines changed: 16388 additions & 312 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: 169 additions & 4 deletions
Large diffs are not rendered by default.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ <h1 title="Class ByProjectKeyCustomersEmailConfirmPost" class="title">Class ByPr
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>
9191
<div class="block"><p>Use this method to verify a global Customer's email during their email verification process.</p>
9292
<p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
93+
<p>After the email is verified, all email tokens issued previously through the email verification flow are invalidated. This invalidation of tokens is eventually consistent.</p>
9394

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ <h1 title="Class ByProjectKeyCustomersEmailConfirmPostString" class="title">Clas
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>
9393
<div class="block"><p>Use this method to verify a global Customer's email during their email verification process.</p>
9494
<p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
95+
<p>After the email is verified, all email tokens issued previously through the email verification flow are invalidated. This invalidation of tokens is eventually consistent.</p>
9596

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h1 title="Class ByProjectKeyCustomersEmailTokenPost" 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="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>
9191
<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>
92+
<p>Creating an email token for the Customer produces the CustomerEmailTokenCreated Message. The Message will include the token's value, if the token's validity is 60 minutes or less.</p>
9393

9494
<hr>
9595
<div class=code-example>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h1 title="Class ByProjectKeyCustomersEmailTokenPostString" 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="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>
9393
<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>
94+
<p>Creating an email token for the Customer produces the CustomerEmailTokenCreated Message. The Message will include the token's value, if the token's validity is 60 minutes or less.</p>
9595

9696
<hr>
9797
<div class=code-example>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ <h1 title="Class ByProjectKeyCustomersPasswordResetPost" class="title">Class ByP
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>
9191
<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>
9392
<p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
93+
<p>After the password is reset, all password tokens issued previously through the password reset flow are invalidated. In addition, any access and refresh tokens issued previously through the password flow and refresh token flow are invalidated. This invalidation of tokens is eventually consistent.</p>
9494

9595
<hr>
9696
<div class=code-example>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ <h1 title="Class ByProjectKeyCustomersPasswordResetPostString" class="title">Cla
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>
9393
<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>
9594
<p>Resetting the password of the Customer produces the CustomerPasswordUpdated Message with <code>reset=true</code>.</p>
95+
<p>After the password is reset, all password tokens issued previously through the password reset flow are invalidated. In addition, any access and refresh tokens issued previously through the password flow and refresh token flow are invalidated. This invalidation of tokens is eventually consistent.</p>
9696

9797
<hr>
9898
<div class=code-example>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h1 title="Class ByProjectKeyCustomersPasswordTokenPost" class="title">Class ByP
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="ByProjectKeyCustomersPasswordTokenPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordTokenPost</a>,<wbr><a href="../models/customer/CustomerToken.html" title="interface in com.commercetools.api.models.customer">CustomerToken</a>,<wbr><a href="../models/customer/CustomerCreatePasswordResetToken.html" title="interface in com.commercetools.api.models.customer">CustomerCreatePasswordResetToken</a>&gt;
9090
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyCustomersPasswordTokenPost.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordTokenPost</a>&gt;</span></div>
9191
<div class="block"><p>Use this method to create a password reset token for a global Customer during their password reset process.</p>
92-
<p>Creating a password reset token does not invalidate existing tokens.</p>
92+
<p>Creating a password reset token for the Customer produces the CustomerPasswordTokenCreated Message. The Message will include the token's value, if the token's validity is 60 minutes or less.</p>
9393

9494
<hr>
9595
<div class=code-example>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h1 title="Class ByProjectKeyCustomersPasswordTokenPostString" class="title">Cla
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="ByProjectKeyCustomersPasswordTokenPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordTokenPostString</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="ByProjectKeyCustomersPasswordTokenPostString.html" title="class in com.commercetools.api.client">ByProjectKeyCustomersPasswordTokenPostString</a>&gt;</span></div>
9393
<div class="block"><p>Use this method to create a password reset token for a global Customer during their password reset process.</p>
94-
<p>Creating a password reset token does not invalidate existing tokens.</p>
94+
<p>Creating a password reset token for the Customer produces the CustomerPasswordTokenCreated Message. The Message will include the token's value, if the token's validity is 60 minutes or less.</p>
9595

9696
<hr>
9797
<div class=code-example>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmPost" clas
9191
<div class="block"><p>Use this method to verify a Store-specific Customer's email during their email verification process.</p>
9292
<p>Verifying the email of the Customer produces the CustomerEmailVerified Message.</p>
9393
<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>
94+
<p>After the email is verified, all email tokens issued previously through the email verification flow are invalidated. This invalidation of tokens is eventually consistent.</p>
9495

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

0 commit comments

Comments
 (0)