Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Feb 29, 2024
1 parent 52002f4 commit ae8d766
Show file tree
Hide file tree
Showing 68 changed files with 3,346 additions and 2,218 deletions.
21 changes: 18 additions & 3 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15980,6 +15980,21 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
Example to create an instance using the builder pattern
</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/cart/DiscountedLineItemPortionDraft.html" title="interface in com.commercetools.api.models.cart">DiscountedLineItemPortionDraft</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">DiscountedLineItemPortionDraft


Example to create an instance using the builder pattern
</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/cart/DiscountedLineItemPortionDraftBuilder.html" title="class in com.commercetools.api.models.cart">DiscountedLineItemPortionDraftBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">DiscountedLineItemPortionDraftBuilder

Example to create an instance using the builder pattern
</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/cart/DiscountedLineItemPrice.html" title="interface in com.commercetools.api.models.cart">DiscountedLineItemPrice</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">DiscountedLineItemPrice
Expand Down Expand Up @@ -23316,7 +23331,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">Deprecated.</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/OrderReturnShipmentStateChangedMessage.html" title="interface in com.commercetools.api.models.message">OrderReturnShipmentStateChangedMessage</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Generated after a successful Set ReturnShipmentState update action.</div>
<div class="block">Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/OrderReturnShipmentStateChangedMessageBuilder.html" title="class in com.commercetools.api.models.message">OrderReturnShipmentStateChangedMessageBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
Expand All @@ -23327,7 +23342,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/OrderReturnShipmentStateChangedMessagePayload.html" title="interface in com.commercetools.api.models.message">OrderReturnShipmentStateChangedMessagePayload</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Generated after a successful Set ReturnShipmentState update action.</div>
<div class="block">Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/OrderReturnShipmentStateChangedMessagePayloadBuilder.html" title="class in com.commercetools.api.models.message">OrderReturnShipmentStateChangedMessagePayloadBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
Expand Down Expand Up @@ -28809,7 +28824,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/docs/meta/Querying.html" title="class in com.commercetools.docs.meta">Querying</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><b>Table of content</b><ul><li><a href="#querying-api">Querying the API</a></li><ul><li><a href="#predicates">Predicates</a></li><li><a href="#get-by-id">Get by id/key</a></li><li><a href="#query-all">Query all</a></li><li><a href="#sorting">Sorting</a></li><li><a href="#pagination">Pagination</a></li><li><a href="#tests">Test cases</a></li></ul></ul></div>
<div class="block"><b>Table of content</b><ul><li><a href="#querying-api">Querying the API</a></li><ul><li><a href="#predicates">Predicates</a></li><li><a href="#get-by-id">Get by id/key</a></li><li><a href="#query-all">Query all</a></li><li><a href="#sorting">Sorting</a></li><li><a href="#pagination">Pagination</a></li></ul><li><a href="#tests">Test cases</a></li></ul></div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/predicates/query/QueryPredicate.html" title="interface in com.commercetools.api.predicates.query">QueryPredicate</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyLoginPost" class="title">Class
<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;
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>
<div class="block"><p>Authenticates a Customer associated with a Store. For more information, see Global versus Store-specific Customers.</p>
<p>Triggers Cart merge during sign-in.</p>
<p>If the Customer exists in the Project but the <code>stores</code> field references a different Store, this method returns an InvalidCredentials error.</p>

<hr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyInStoreKeyByStoreKeyLoginPostString" class="title">
<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="ByProjectKeyInStoreKeyByStoreKeyLoginPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyLoginPostString</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>&gt;
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyInStoreKeyByStoreKeyLoginPostString.html" title="class in com.commercetools.api.client">ByProjectKeyInStoreKeyByStoreKeyLoginPostString</a>&gt;</span></div>
<div class="block"><p>Authenticates a Customer associated with a Store. For more information, see Global versus Store-specific Customers.</p>
<p>Triggers Cart merge during sign-in.</p>
<p>If the Customer exists in the Project but the <code>stores</code> field references a different Store, this method returns an InvalidCredentials error.</p>

<hr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ <h1 title="Class ByProjectKeyLoginPost" class="title">Class ByProjectKeyLoginPos
<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="ByProjectKeyLoginPost.html" title="class in com.commercetools.api.client">ByProjectKeyLoginPost</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;
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyLoginPost.html" title="class in com.commercetools.api.client">ByProjectKeyLoginPost</a>&gt;</span></div>
<div class="block"><p>Authenticates a global Customer not associated with a Store. For more information, see Global versus Store-specific Customers. If the Customer is registered in a Store, use the Authenticate (sign in) Customer in Store method.</p>
<p>Triggers Cart merge during sign-in.</p>
<p>If an account with the given credentials is not found, an InvalidCredentials error is returned.</p>

<hr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ <h1 title="Class ByProjectKeyLoginPostString" class="title">Class ByProjectKeyLo
<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="ByProjectKeyLoginPostString.html" title="class in com.commercetools.api.client">ByProjectKeyLoginPostString</a>,<wbr><a href="../models/customer/CustomerSignInResult.html" title="interface in com.commercetools.api.models.customer">CustomerSignInResult</a>&gt;
implements <a href="ErrorableTrait.html" title="interface in com.commercetools.api.client">ErrorableTrait</a>&lt;<a href="ByProjectKeyLoginPostString.html" title="class in com.commercetools.api.client">ByProjectKeyLoginPostString</a>&gt;</span></div>
<div class="block"><p>Authenticates a global Customer not associated with a Store. For more information, see Global versus Store-specific Customers. If the Customer is registered in a Store, use the Authenticate (sign in) Customer in Store method.</p>
<p>Triggers Cart merge during sign-in.</p>
<p>If an account with the given credentials is not found, an InvalidCredentials error is returned.</p>

<hr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ <h1 title="Interface CustomLineItemDraft" class="title">Interface CustomLineItem
.name(nameBuilder -> nameBuilder)
.money(moneyBuilder -> moneyBuilder)
.slug("{slug}")
.priceMode(CustomLineItemPriceMode.STANDARD)
.build()
</code></pre>
</div></div>
Expand Down Expand Up @@ -146,7 +145,7 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Name of the Custom Line Item.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull <a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceMode()" class="member-name-link">getPriceMode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">
Expand Down Expand Up @@ -377,8 +376,7 @@ <h3>getShippingDetails</h3>
<li>
<section class="detail" id="getPriceMode()">
<h3>getPriceMode</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="return-type">@NotNull <a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></span>&nbsp;<span class="element-name">getPriceMode</span>()</div>
<div class="member-signature"><span class="return-type"><a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></span>&nbsp;<span class="element-name">getPriceMode</span>()</div>
<div class="block"><ul>
<li>If <code>Standard</code>, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.</li>
<li>If <code>External</code>, Cart Discounts are not considered on the Custom Line Item.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ <h1 title="Class CustomLineItemDraftBuilder" class="title">Class CustomLineItemD
.name(nameBuilder -> nameBuilder)
.money(moneyBuilder -> moneyBuilder)
.slug("{slug}")
.priceMode(CustomLineItemPriceMode.STANDARD)
.build()
</code></pre>
</div></div>
Expand Down Expand Up @@ -621,7 +620,8 @@ <h3>shippingDetails</h3>
<li>
<section class="detail" id="priceMode(com.commercetools.api.models.cart.CustomLineItemPriceMode)">
<h3>priceMode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CustomLineItemDraftBuilder.html" title="class in com.commercetools.api.models.cart">CustomLineItemDraftBuilder</a></span>&nbsp;<span class="element-name">priceMode</span><wbr><span class="parameters">(<a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a>&nbsp;priceMode)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CustomLineItemDraftBuilder.html" title="class in com.commercetools.api.models.cart">CustomLineItemDraftBuilder</a></span>&nbsp;<span class="element-name">priceMode</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
<a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a>&nbsp;priceMode)</span></div>
<div class="block"><ul>
<li>If <code>Standard</code>, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.</li>
<li>If <code>External</code>, Cart Discounts are not considered on the Custom Line Item.</li>
Expand Down Expand Up @@ -742,7 +742,8 @@ <h3>getShippingDetails</h3>
<li>
<section class="detail" id="getPriceMode()">
<h3>getPriceMode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></span>&nbsp;<span class="element-name">getPriceMode</span>()</div>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CustomLineItemPriceMode.html" title="interface in com.commercetools.api.models.cart">CustomLineItemPriceMode</a></span>&nbsp;<span class="element-name">getPriceMode</span>()</div>
<div class="block"><ul>
<li>If <code>Standard</code>, Cart Discounts with a matching CartDiscountCustomLineItemsTarget are applied to the Custom Line Item.</li>
<li>If <code>External</code>, Cart Discounts are not considered on the Custom Line Item.</li>
Expand Down
Loading

0 comments on commit ae8d766

Please sign in to comment.