Skip to content

Commit 547f168

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Update javadoc
1 parent 0917170 commit 547f168

59 files changed

Lines changed: 2492 additions & 2375 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/com/commercetools/api/models/cart/CartAddCustomLineItemAction.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,8 @@ <h3>getMoney</h3>
330330
<div class="member-signature"><span class="annotations">@NotNull
331331
@Valid
332332
</span><span class="return-type">@NotNull @Valid <a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getMoney</span>()</div>
333-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
333+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
334+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
334335
<dl class="notes">
335336
<dt>Returns:</dt>
336337
<dd>money</dd>
@@ -465,7 +466,8 @@ <h3>getRecurrenceInfo</h3>
465466
<section class="detail" id="setMoney(com.commercetools.api.models.common.Money)">
466467
<h3>setMoney</h3>
467468
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setMoney</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;money)</span></div>
468-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
469+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
470+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
469471
<dl class="notes">
470472
<dt>Parameters:</dt>
471473
<dd><code>money</code> - value to be set</dd>

‎javadoc/com/commercetools/api/models/cart/CartAddCustomLineItemActionBuilder.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,8 @@ <h2>Method Details</h2>
362362
<section class="detail" id="money(java.util.function.Function)">
363363
<h3>money</h3>
364364
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddCustomLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddCustomLineItemActionBuilder</a></span>&nbsp;<span class="element-name">money</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>&gt;&nbsp;builder)</span></div>
365-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
365+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
366+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
366367
<dl class="notes">
367368
<dt>Parameters:</dt>
368369
<dd><code>builder</code> - function to build the money value</dd>
@@ -375,7 +376,8 @@ <h3>money</h3>
375376
<section class="detail" id="withMoney(java.util.function.Function)">
376377
<h3>withMoney</h3>
377378
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddCustomLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddCustomLineItemActionBuilder</a></span>&nbsp;<span class="element-name">withMoney</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&gt;&nbsp;builder)</span></div>
378-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
379+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
380+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
379381
<dl class="notes">
380382
<dt>Parameters:</dt>
381383
<dd><code>builder</code> - function to build the money value</dd>
@@ -388,7 +390,8 @@ <h3>withMoney</h3>
388390
<section class="detail" id="money(com.commercetools.api.models.common.Money)">
389391
<h3>money</h3>
390392
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddCustomLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddCustomLineItemActionBuilder</a></span>&nbsp;<span class="element-name">money</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;money)</span></div>
391-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
393+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
394+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
392395
<dl class="notes">
393396
<dt>Parameters:</dt>
394397
<dd><code>money</code> - value to be set</dd>
@@ -701,7 +704,8 @@ <h3>recurrenceInfo</h3>
701704
<section class="detail" id="getMoney()">
702705
<h3>getMoney</h3>
703706
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getMoney</span>()</div>
704-
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p></div>
707+
<div class="block"><p>Money value of the Custom Line Item. The value can be negative.</p>
708+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
705709
<dl class="notes">
706710
<dt>Returns:</dt>
707711
<dd>money</dd>

‎javadoc/com/commercetools/api/models/cart/CartAddLineItemAction.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,8 @@ <h3>getSupplyChannel</h3>
470470
<h3>getExternalPrice</h3>
471471
<div class="member-signature"><span class="annotations">@Valid
472472
</span><span class="return-type">@Valid <a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getExternalPrice</span>()</div>
473-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
473+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
474+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
474475
<dl class="notes">
475476
<dt>Returns:</dt>
476477
<dd>externalPrice</dd>
@@ -658,7 +659,8 @@ <h3>setSupplyChannel</h3>
658659
<section class="detail" id="setExternalPrice(com.commercetools.api.models.common.Money)">
659660
<h3>setExternalPrice</h3>
660661
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setExternalPrice</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;externalPrice)</span></div>
661-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
662+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
663+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
662664
<dl class="notes">
663665
<dt>Parameters:</dt>
664666
<dd><code>externalPrice</code> - value to be set</dd>

‎javadoc/com/commercetools/api/models/cart/CartAddLineItemActionBuilder.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -611,7 +611,8 @@ <h3>supplyChannel</h3>
611611
<section class="detail" id="externalPrice(java.util.function.Function)">
612612
<h3>externalPrice</h3>
613613
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddLineItemActionBuilder</a></span>&nbsp;<span class="element-name">externalPrice</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>&gt;&nbsp;builder)</span></div>
614-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
614+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
615+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
615616
<dl class="notes">
616617
<dt>Parameters:</dt>
617618
<dd><code>builder</code> - function to build the externalPrice value</dd>
@@ -624,7 +625,8 @@ <h3>externalPrice</h3>
624625
<section class="detail" id="withExternalPrice(java.util.function.Function)">
625626
<h3>withExternalPrice</h3>
626627
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddLineItemActionBuilder</a></span>&nbsp;<span class="element-name">withExternalPrice</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&gt;&nbsp;builder)</span></div>
627-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
628+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
629+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
628630
<dl class="notes">
629631
<dt>Parameters:</dt>
630632
<dd><code>builder</code> - function to build the externalPrice value</dd>
@@ -638,7 +640,8 @@ <h3>withExternalPrice</h3>
638640
<h3>externalPrice</h3>
639641
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartAddLineItemActionBuilder.html" title="class in com.commercetools.api.models.cart">CartAddLineItemActionBuilder</a></span>&nbsp;<span class="element-name">externalPrice</span><wbr><span class="parameters">(@Nullable
640642
<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;externalPrice)</span></div>
641-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
643+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
644+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
642645
<dl class="notes">
643646
<dt>Parameters:</dt>
644647
<dd><code>externalPrice</code> - value to be set</dd>
@@ -1060,7 +1063,8 @@ <h3>getSupplyChannel</h3>
10601063
<h3>getExternalPrice</h3>
10611064
<div class="member-signature"><span class="annotations">@Nullable
10621065
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getExternalPrice</span>()</div>
1063-
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p></div>
1066+
<div class="block"><p>Sets the LineItem <code>price</code> value, and the <code>priceMode</code> to <code>ExternalPrice</code> LineItemPriceMode.</p>
1067+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
10641068
<dl class="notes">
10651069
<dt>Returns:</dt>
10661070
<dd>externalPrice</dd>

‎javadoc/com/commercetools/api/models/cart/CartChangeCustomLineItemMoneyAction.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,8 @@ <h3>getMoney</h3>
259259
<div class="member-signature"><span class="annotations">@NotNull
260260
@Valid
261261
</span><span class="return-type">@NotNull @Valid <a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getMoney</span>()</div>
262-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
262+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
263+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
263264
<dl class="notes">
264265
<dt>Returns:</dt>
265266
<dd>money</dd>
@@ -292,7 +293,8 @@ <h3>setCustomLineItemKey</h3>
292293
<section class="detail" id="setMoney(com.commercetools.api.models.common.Money)">
293294
<h3>setMoney</h3>
294295
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setMoney</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;money)</span></div>
295-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
296+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
297+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
296298
<dl class="notes">
297299
<dt>Parameters:</dt>
298300
<dd><code>money</code> - value to be set</dd>

‎javadoc/com/commercetools/api/models/cart/CartChangeCustomLineItemMoneyActionBuilder.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,8 @@ <h3>customLineItemKey</h3>
242242
<section class="detail" id="money(java.util.function.Function)">
243243
<h3>money</h3>
244244
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartChangeCustomLineItemMoneyActionBuilder.html" title="class in com.commercetools.api.models.cart">CartChangeCustomLineItemMoneyActionBuilder</a></span>&nbsp;<span class="element-name">money</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>&gt;&nbsp;builder)</span></div>
245-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
245+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
246+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
246247
<dl class="notes">
247248
<dt>Parameters:</dt>
248249
<dd><code>builder</code> - function to build the money value</dd>
@@ -255,7 +256,8 @@ <h3>money</h3>
255256
<section class="detail" id="withMoney(java.util.function.Function)">
256257
<h3>withMoney</h3>
257258
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartChangeCustomLineItemMoneyActionBuilder.html" title="class in com.commercetools.api.models.cart">CartChangeCustomLineItemMoneyActionBuilder</a></span>&nbsp;<span class="element-name">withMoney</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a>&lt;<a href="../common/MoneyBuilder.html" title="class in com.commercetools.api.models.common">MoneyBuilder</a>,<wbr><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&gt;&nbsp;builder)</span></div>
258-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
259+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
260+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
259261
<dl class="notes">
260262
<dt>Parameters:</dt>
261263
<dd><code>builder</code> - function to build the money value</dd>
@@ -268,7 +270,8 @@ <h3>withMoney</h3>
268270
<section class="detail" id="money(com.commercetools.api.models.common.Money)">
269271
<h3>money</h3>
270272
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CartChangeCustomLineItemMoneyActionBuilder.html" title="class in com.commercetools.api.models.cart">CartChangeCustomLineItemMoneyActionBuilder</a></span>&nbsp;<span class="element-name">money</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;money)</span></div>
271-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
273+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
274+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
272275
<dl class="notes">
273276
<dt>Parameters:</dt>
274277
<dd><code>money</code> - value to be set</dd>
@@ -305,7 +308,8 @@ <h3>getCustomLineItemKey</h3>
305308
<section class="detail" id="getMoney()">
306309
<h3>getMoney</h3>
307310
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getMoney</span>()</div>
308-
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p></div>
311+
<div class="block"><p>Value to set. Must not be empty. Can be a negative amount.</p>
312+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
309313
<dl class="notes">
310314
<dt>Returns:</dt>
311315
<dd>money</dd>

‎javadoc/com/commercetools/api/models/cart/CartChangeLineItemQuantityAction.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,8 @@ <h3>getExternalPrice</h3>
295295
<div class="member-signature"><span class="annotations">@Valid
296296
</span><span class="return-type">@Valid <a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a></span>&nbsp;<span class="element-name">getExternalPrice</span>()</div>
297297
<div class="block"><p>Required when the Line Item uses <code>ExternalPrice</code> LineItemPriceMode. Sets the LineItem <code>price</code> to the given value when changing the quantity of a Line Item.</p>
298-
<p>The LineItem price is updated as described in Line Item price selection.</p></div>
298+
<p>The LineItem price is updated as described in Line Item price selection.</p>
299+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
299300
<dl class="notes">
300301
<dt>Returns:</dt>
301302
<dd>externalPrice</dd>
@@ -353,7 +354,8 @@ <h3>setQuantity</h3>
353354
<h3>setExternalPrice</h3>
354355
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setExternalPrice</span><wbr><span class="parameters">(<a href="../common/Money.html" title="interface in com.commercetools.api.models.common">Money</a>&nbsp;externalPrice)</span></div>
355356
<div class="block"><p>Required when the Line Item uses <code>ExternalPrice</code> LineItemPriceMode. Sets the LineItem <code>price</code> to the given value when changing the quantity of a Line Item.</p>
356-
<p>The LineItem price is updated as described in Line Item price selection.</p></div>
357+
<p>The LineItem price is updated as described in Line Item price selection.</p>
358+
<p>To set the money value in high precision, use HighPrecisionMoneyDraft.</p></div>
357359
<dl class="notes">
358360
<dt>Parameters:</dt>
359361
<dd><code>externalPrice</code> - value to be set</dd>

0 commit comments

Comments
 (0)