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 Jan 23, 2025
1 parent b83d356 commit a536408
Show file tree
Hide file tree
Showing 50 changed files with 2,362 additions and 2,342 deletions.
4 changes: 2 additions & 2 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24907,7 +24907,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/order/OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/commercetools/api/models/order/OrderSearchCustomType.OrderSearchCustomTypeEnum.html" title="enum in com.commercetools.api.models.order">OrderSearchCustomType.OrderSearchCustomTypeEnum</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
Expand Down Expand Up @@ -34179,7 +34179,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-tab1"><a href="com/commercetools/api/models/search/SearchFieldType.html" title="interface in com.commercetools.api.models.search">SearchFieldType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Possible values for the <code>fieldType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>fieldType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/commercetools/api/models/search/SearchFieldType.SearchFieldTypeEnum.html" title="enum in com.commercetools.api.models.search">SearchFieldType.SearchFieldTypeEnum</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ <h1 title="Interface CartAddLineItemAction" class="title">Interface CartAddLineI
<div class="block"><p>If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased. If LineItem <code>shippingDetails</code> is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. A new Line Item is added when the <code>externalPrice</code> or <code>externalTotalPrice</code> is set in this update action. The LineItem price is set as described in Line Item price selection.</p>
<p>If the Tax Rate is not set, a MissingTaxRateForCountry error is returned.</p>
<p>If the Line Items do not have a Price according to the Product <code>priceMode</code> value for a selected currency and/or country, Customer Group, or Channel, a MatchingPriceNotFound error is returned.</p>
<p>If the Line Items are added to a Cart bound to a Store with active Product Selections, the selected Product Variant must be available in that Store, otherwise an InvalidInput error is returned.</p>

<hr>
Example to create an instance using the builder pattern
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ <h2>Method Summary</h2>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchAnyValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchAnyValueBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customType(com.commercetools.api.models.order.OrderSearchCustomType)" class="member-name-link">customType</a><wbr>(<a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchAnyValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchAnyValueBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#field(java.lang.String)" class="member-name-link">field</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;field)</code></div>
Expand All @@ -162,7 +162,7 @@ <h2>Method Summary</h2>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomType()" class="member-name-link">getCustomType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getField()" class="member-name-link">getField</a>()</code></div>
Expand Down Expand Up @@ -262,7 +262,7 @@ <h3>boost</h3>
<h3>customType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OrderSearchAnyValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchAnyValueBuilder</a></span>&nbsp;<span class="element-name">customType</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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</span></div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>customType</code> - value to be set</dd>
Expand Down Expand Up @@ -340,7 +340,7 @@ <h3>getBoost</h3>
<h3>getCustomType</h3>
<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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></span>&nbsp;<span class="element-name">getCustomType</span>()</div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>customType</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h1 title="Interface OrderSearchCustomType" class="title">Interface OrderSearchC
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">OrderSearchCustomType</span><span class="extends-implements">
extends <a href="../../../../../io/vrap/rmf/base/client/JsonEnum.html" title="interface in io.vrap.rmf.base.client">JsonEnum</a></span></div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h2>Method Summary</h2>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchDateRangeValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchDateRangeValueBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customType(com.commercetools.api.models.order.OrderSearchCustomType)" class="member-name-link">customType</a><wbr>(<a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchDateRangeValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchDateRangeValueBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#field(java.lang.String)" class="member-name-link">field</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;field)</code></div>
Expand All @@ -152,7 +152,7 @@ <h2>Method Summary</h2>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomType()" class="member-name-link">getCustomType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getField()" class="member-name-link">getField</a>()</code></div>
Expand Down Expand Up @@ -252,7 +252,7 @@ <h3>boost</h3>
<h3>customType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OrderSearchDateRangeValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchDateRangeValueBuilder</a></span>&nbsp;<span class="element-name">customType</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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</span></div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>customType</code> - value to be set</dd>
Expand Down Expand Up @@ -317,7 +317,7 @@ <h3>getBoost</h3>
<h3>getCustomType</h3>
<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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></span>&nbsp;<span class="element-name">getCustomType</span>()</div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>customType</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2>Method Summary</h2>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchFullTextValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchFullTextValueBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customType(com.commercetools.api.models.order.OrderSearchCustomType)" class="member-name-link">customType</a><wbr>(<a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchFullTextValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchFullTextValueBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#field(java.lang.String)" class="member-name-link">field</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;field)</code></div>
Expand All @@ -153,7 +153,7 @@ <h2>Method Summary</h2>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomType()" class="member-name-link">getCustomType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</div>
<div class="block">Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getField()" class="member-name-link">getField</a>()</code></div>
Expand Down Expand Up @@ -263,7 +263,7 @@ <h3>boost</h3>
<h3>customType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OrderSearchFullTextValueBuilder.html" title="class in com.commercetools.api.models.order">OrderSearchFullTextValueBuilder</a></span>&nbsp;<span class="element-name">customType</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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a>&nbsp;customType)</span></div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>customType</code> - value to be set</dd>
Expand Down Expand Up @@ -341,7 +341,7 @@ <h3>getBoost</h3>
<h3>getCustomType</h3>
<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="OrderSearchCustomType.html" title="interface in com.commercetools.api.models.order">OrderSearchCustomType</a></span>&nbsp;<span class="element-name">getCustomType</span>()</div>
<div class="block"><p>Possible values for the <code>customType</code> property on query expressions indicating the data type of the <code>field</code>.</p></div>
<div class="block"><p>Possible values for the <code>customType</code> property on simple expressions indicating the data type of the <code>field</code>.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>customType</dd>
Expand Down
Loading

0 comments on commit a536408

Please sign in to comment.