Update javadoc

commercetools · Feb 11, 2025 · 34e2578 · 34e2578
1 parent 2386fe0
commit 34e2578
Show file tree

Hide file tree

Showing 111 changed files with 30,674 additions and 14,240 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
diff --git a/...m/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html b/...m/commercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet.html
diff --git a/...mmercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html b/...mmercetools/api/client/ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsByIDGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsByIDGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsKeyByKeyGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsKeyByKeyGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsSearchGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductProjectionsSearchGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDDelete.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDDelete.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDPost.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDPost.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDPostString.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsByIDPostString.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyDelete.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyDelete.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyGet.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyGet.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyPost.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyPost.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyPostString.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsKeyByKeyPostString.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsPost.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsPost.html
diff --git a/javadoc/com/commercetools/api/client/ByProjectKeyProductsPostString.html b/javadoc/com/commercetools/api/client/ByProjectKeyProductsPostString.html
diff --git a/javadoc/com/commercetools/api/client/PriceselectingTrait.html b/javadoc/com/commercetools/api/client/PriceselectingTrait.html
@@ -116,23 +116,31 @@ <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">add additional priceCustomerGroup query parameter</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#asPriceselectingTrait()" class="member-name-link">asPriceselectingTrait</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a></code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#asPriceselectingTraitToBaseType()" class="member-name-link">asPriceselectingTraitToBaseType</a>()</code></div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;TValue&gt;&nbsp;<a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addPriceCustomerGroupAssignments(TValue)" class="member-name-link">addPriceCustomerGroupAssignments</a><wbr>(TValue&nbsp;priceCustomerGroupAssignments)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">add additional priceCustomerGroupAssignments query parameter</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#asPriceselectingTrait()" class="member-name-link">asPriceselectingTrait</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#asPriceselectingTraitToBaseType()" class="member-name-link">asPriceselectingTraitToBaseType</a>()</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceChannel()" class="member-name-link">getPriceChannel</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceChannel()" class="member-name-link">getPriceChannel</a>()</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCountry()" class="member-name-link">getPriceCountry</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCountry()" class="member-name-link">getPriceCountry</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCurrency()" class="member-name-link">getPriceCurrency</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCurrency()" class="member-name-link">getPriceCurrency</a>()</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCustomerGroup()" class="member-name-link">getPriceCustomerGroup</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCustomerGroup()" class="member-name-link">getPriceCustomerGroup</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriceCustomerGroupAssignments()" class="member-name-link">getPriceCustomerGroupAssignments</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;TValue&gt;&nbsp;<a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withPriceChannel(TValue)" class="member-name-link">withPriceChannel</a><wbr>(TValue&nbsp;priceChannel)</code></div>
@@ -154,6 +162,11 @@ <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">set priceCustomerGroup with the specificied value</div>
 </div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;TValue&gt;&nbsp;<a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withPriceCustomerGroupAssignments(TValue)" class="member-name-link">withPriceCustomerGroupAssignments</a><wbr>(TValue&nbsp;priceCustomerGroupAssignments)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">set priceCustomerGroupAssignments with the specificied value</div>
+</div>
 </div>
 </div>
 </div>
@@ -187,6 +200,12 @@ <h3>getPriceCustomerGroup</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="getPriceCustomerGroupAssignments()">
+<h3>getPriceCustomerGroupAssignments</h3>
+<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getPriceCustomerGroupAssignments</span>()</div>
+</section>
+</li>
+<li>
 <section class="detail" id="getPriceChannel()">
 <h3>getPriceChannel</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getPriceChannel</span>()</div>
@@ -283,6 +302,36 @@ <h3 id="addPriceCustomerGroup(java.lang.Object)">addPriceCustomerGroup</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="withPriceCustomerGroupAssignments(TValue)">
+<h3 id="withPriceCustomerGroupAssignments(java.lang.Object)">withPriceCustomerGroupAssignments</h3>
+<div class="member-signature"><span class="type-parameters">&lt;TValue&gt;</span>&nbsp;<span class="return-type"><a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</span>&nbsp;<span class="element-name">withPriceCustomerGroupAssignments</span><wbr><span class="parameters">(TValue&nbsp;priceCustomerGroupAssignments)</span></div>
+<div class="block">set priceCustomerGroupAssignments with the specificied value</div>
+<dl class="notes">
+<dt>Type Parameters:</dt>
+<dd><code>TValue</code> - value type</dd>
+<dt>Parameters:</dt>
+<dd><code>priceCustomerGroupAssignments</code> - value to be set</dd>
+<dt>Returns:</dt>
+<dd>PriceselectingTrait</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="addPriceCustomerGroupAssignments(TValue)">
+<h3 id="addPriceCustomerGroupAssignments(java.lang.Object)">addPriceCustomerGroupAssignments</h3>
+<div class="member-signature"><span class="type-parameters">&lt;TValue&gt;</span>&nbsp;<span class="return-type"><a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</span>&nbsp;<span class="element-name">addPriceCustomerGroupAssignments</span><wbr><span class="parameters">(TValue&nbsp;priceCustomerGroupAssignments)</span></div>
+<div class="block">add additional priceCustomerGroupAssignments query parameter</div>
+<dl class="notes">
+<dt>Type Parameters:</dt>
+<dd><code>TValue</code> - value type</dd>
+<dt>Parameters:</dt>
+<dd><code>priceCustomerGroupAssignments</code> - value to be added</dd>
+<dt>Returns:</dt>
+<dd>PriceselectingTrait</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="withPriceChannel(TValue)">
 <h3 id="withPriceChannel(java.lang.Object)">withPriceChannel</h3>
 <div class="member-signature"><span class="type-parameters">&lt;TValue&gt;</span>&nbsp;<span class="return-type"><a href="PriceselectingTrait.html" title="interface in com.commercetools.api.client">PriceselectingTrait</a>&lt;<a href="PriceselectingTrait.html" title="type parameter in PriceselectingTrait">T</a>&gt;</span>&nbsp;<span class="element-name">withPriceChannel</span><wbr><span class="parameters">(TValue&nbsp;priceChannel)</span></div>

diff --git a/javadoc/com/commercetools/api/models/DomainResource.html b/javadoc/com/commercetools/api/models/DomainResource.html
diff --git a/javadoc/com/commercetools/api/models/Identifiable.html b/javadoc/com/commercetools/api/models/Identifiable.html
diff --git a/javadoc/com/commercetools/api/models/ResourceUpdateAction.html b/javadoc/com/commercetools/api/models/ResourceUpdateAction.html
diff --git a/javadoc/com/commercetools/api/models/Versioned.html b/javadoc/com/commercetools/api/models/Versioned.html
diff --git a/javadoc/com/commercetools/api/models/cart/LineItem.html b/javadoc/com/commercetools/api/models/cart/LineItem.html
@@ -585,7 +585,8 @@ <h3>getTotalPrice</h3>
 <div class="member-signature"><span class="annotations">@NotNull
 @Valid
 </span><span class="return-type">@NotNull @Valid <a href="../common/CentPrecisionMoney.html" title="interface in com.commercetools.api.models.common">CentPrecisionMoney</a></span>&nbsp;<span class="element-name">getTotalPrice</span>()</div>
-<div class="block"><p>Total price of this Line Item equalling <code>price</code> multiplied by <code>quantity</code>. If the Line Item is discounted, the total price is the <code>discountedPricePerQuantity</code> multiplied by <code>quantity</code>. Includes taxes if the TaxRate <code>includedInPrice</code> is <code>true</code>.</p></div>
+<div class="block"><p>Total price of this Line Item equalling <code>price</code> multiplied by <code>quantity</code>. If the Line Item is discounted, the total price is the <code>discountedPricePerQuantity</code> multiplied by <code>quantity</code>. Includes taxes if the TaxRate <code>includedInPrice</code> is <code>true</code>.</p>
+  <p>If <code>ExternalPrice</code> LineItemPriceMode is used with high-precision money, then the total price is rounded by using the <code>HalfEven</code> rounding mode.</p></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>totalPrice</dd>
@@ -899,7 +900,8 @@ <h3>setQuantity</h3>
 <section class="detail" id="setTotalPrice(com.commercetools.api.models.common.CentPrecisionMoney)">
 <h3>setTotalPrice</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setTotalPrice</span><wbr><span class="parameters">(<a href="../common/CentPrecisionMoney.html" title="interface in com.commercetools.api.models.common">CentPrecisionMoney</a>&nbsp;totalPrice)</span></div>
-<div class="block"><p>Total price of this Line Item equalling <code>price</code> multiplied by <code>quantity</code>. If the Line Item is discounted, the total price is the <code>discountedPricePerQuantity</code> multiplied by <code>quantity</code>. Includes taxes if the TaxRate <code>includedInPrice</code> is <code>true</code>.</p></div>
+<div class="block"><p>Total price of this Line Item equalling <code>price</code> multiplied by <code>quantity</code>. If the Line Item is discounted, the total price is the <code>discountedPricePerQuantity</code> multiplied by <code>quantity</code>. Includes taxes if the TaxRate <code>includedInPrice</code> is <code>true</code>.</p>
+  <p>If <code>ExternalPrice</code> LineItemPriceMode is used with high-precision money, then the total price is rounded by using the <code>HalfEven</code> rounding mode.</p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>totalPrice</code> - value to be set</dd>