build(codegen): updating SDK

commercetools · May 28, 2024 · 187ecee · 187ecee
1 parent 61bf886
commit 187ecee
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 14 deletions.
diff --git a/.../src/main/java-generated/com/commercetools/api/models/cart/CartSetCartTotalTaxAction.java b/.../src/main/java-generated/com/commercetools/api/models/cart/CartSetCartTotalTaxAction.java
@@ -17,7 +17,7 @@
 import io.vrap.rmf.base.client.utils.Generated;
 
 /**
- *  <p>This update action results in the <code>taxedPrice</code> field being added to the Cart when the <code>ExternalAmount</code> TaxMode is used.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action adds the <code>taxedPrice</code> field to the Cart and must be used after any price-affecting change occurs within the Cart.</p>
  *
  * <hr>
  * Example to create an instance using the builder pattern

diff --git a/.../main/java-generated/com/commercetools/api/models/cart/CartSetCartTotalTaxActionImpl.java b/.../main/java-generated/com/commercetools/api/models/cart/CartSetCartTotalTaxActionImpl.java
@@ -17,7 +17,7 @@
 import org.apache.commons.lang3.builder.ToStringStyle;
 
 /**
- *  <p>This update action results in the <code>taxedPrice</code> field being added to the Cart when the <code>ExternalAmount</code> TaxMode is used.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action adds the <code>taxedPrice</code> field to the Cart and must be used after any price-affecting change occurs within the Cart.</p>
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
 public class CartSetCartTotalTaxActionImpl implements CartSetCartTotalTaxAction, ModelBase {

diff --git a/...main/java-generated/com/commercetools/api/models/cart/CartSetLineItemTaxAmountAction.java b/...main/java-generated/com/commercetools/api/models/cart/CartSetLineItemTaxAmountAction.java
@@ -14,7 +14,7 @@
 import io.vrap.rmf.base.client.utils.Generated;
 
 /**
- *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action sets the <code>taxedPrice</code> and <code>taxRate</code> on a Line Item and must be used after any price-affecting change occurs.</p>
  *
  * <hr>
  * Example to create an instance using the builder pattern

diff --git a/.../java-generated/com/commercetools/api/models/cart/CartSetLineItemTaxAmountActionImpl.java b/.../java-generated/com/commercetools/api/models/cart/CartSetLineItemTaxAmountActionImpl.java
@@ -17,7 +17,7 @@
 import org.apache.commons.lang3.builder.ToStringStyle;
 
 /**
- *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action sets the <code>taxedPrice</code> and <code>taxRate</code> on a Line Item and must be used after any price-affecting change occurs.</p>
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
 public class CartSetLineItemTaxAmountActionImpl implements CartSetLineItemTaxAmountAction, ModelBase {

diff --git a/...tools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/cart/TaxMode.java b/...tools-sdk-java-api/src/main/java-generated/com/commercetools/api/models/cart/TaxMode.java
@@ -17,20 +17,39 @@
 public interface TaxMode extends JsonEnum {
 
     /**
-    <p>Tax Rates are selected automatically from the TaxCategories based on the Cart <code>shippingAddress</code>. This is the default tax mode for a new Cart.</p>
-    <p><code>totalNet</code>, <code>totalGross</code>, and <code>taxPortions</code> fields are calculated based on the <code>taxRoundingMode</code>.</p> */
+    <ul>
+     <li><p>Tax Rates are selected automatically from the TaxCategories based on the Cart <code>shippingAddress</code>. This is the default tax mode for a new Cart.</p></li>
+     <li><p>The <code>totalNet</code>, <code>totalGross</code>, and <code>taxPortions</code> fields are calculated based on the <code>taxRoundingMode</code>.</p></li>
+    </ul> */
     TaxMode PLATFORM = TaxModeEnum.PLATFORM;
     /**
-    <p>Tax Rates are set externally per ExternalTaxRateDraft. A Cart can be ordered only if all Line Items, Custom Line Items, and the Shipping Method have an external Tax Rate set.</p>
-    <p><code>totalNet</code>, <code>totalGross</code>, and <code>taxPortions</code> fields are calculated based on the <code>taxRoundingMode</code>.</p> */
+    <ul>
+     <li><p>Tax Rates are set externally with ExternalTaxRateDraft. A Cart can be ordered only if all Line Items, Custom Line Items, and the Shipping Method have an external Tax Rate set.</p></li>
+     <li><p>The <code>totalNet</code>, <code>totalGross</code>, and <code>taxPortions</code> fields are calculated based on the <code>taxRoundingMode</code>.</p></li>
+    </ul> */
     TaxMode EXTERNAL = TaxModeEnum.EXTERNAL;
     /**
-    <p>Tax amounts, Tax Rates, and tax portions are set externally per ExternalTaxAmountDraft. A Cart can be ordered only if the Cart and all Line Items, Custom Line Items, and the Shipping Method have an external tax amount and rate set.</p>
-    <p>Price-specific update actions on Carts require external recalculation of the total gross price. Hence, the <code>externalTaxAmount</code> is removed in these cases and must be reset with Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount update actions. Also the Cart <code>taxedPrice</code> field must be explicitly set via Set Cart Total Tax. Since the API currently does not offer an update action for setting the <code>taxedShippingPrice</code> field of a Cart with <code>ExternalAmount</code> tax mode, it will always be empty.</p> */
+    <ul>
+     <li><p>Tax amounts, Tax Rates, and tax portions are set externally with ExternalTaxAmountDraft. A Cart can be ordered only if the Cart and all Line Items, Custom Line Items, and the Shipping Method have an external tax amount and rate set.</p></li>
+     <li><p>The Cart <code>taxedPrice</code> field must be set using Set Cart Total Tax. The Cart <code>taxedShippingPrice</code> field is always empty in this tax mode.</p></li>
+     <li><p>Price-affecting update actions on Carts require external recalculation of the total gross price. In these cases, <code>taxedPrice</code> and <code>taxRate</code> are removed and must be set again. The order in which the individual update actions are issued is important:</p>
+      <ol>
+       <li><p>Issue the price-affecting update action(s).</p></li>
+       <li><p>Update the tax amounts using Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount.</p>
+        <ul>
+         <li><p>If the update action changes the Line Item price, for Line Items with <code>Platform</code> LineItemPriceMode, you must issue Set LineItem TaxAmount in a <em>separate</em> request.</p></li>
+         <li><p>If the update action removes the externally set tax amount for the Shipping Method, you must issue Set ShippingMethod TaxAmount in a <em>separate</em> request.</p></li>
+        </ul></li>
+       <li><p>Update the <code>taxedPrice</code> on Cart using Set Cart Total Tax.</p></li>
+      </ol></li>
+     <li><p>Tax-inclusive pricing should be avoided when using TaxMode <code>ExternalAmount</code> because <code>taxedItemPrice.totalNet</code> is automatically set by the platform to the Line Item's <code>totalPrice</code>.</p></li>
+    </ul> */
     TaxMode EXTERNAL_AMOUNT = TaxModeEnum.EXTERNAL_AMOUNT;
     /**
-    <p>No taxes are added to the Cart.</p>
-    <p>Note that this tax mode cannot be set on the My Carts API.</p> */
+    <ul>
+     <li>No taxes are added to the Cart.</li>
+     <li>This tax mode cannot be set on the My Carts API.</li>
+    </ul> */
     TaxMode DISABLED = TaxModeEnum.DISABLED;
 
     /**

diff --git a/...erated/com/commercetools/api/models/order_edit/StagedOrderSetLineItemTaxAmountAction.java b/...erated/com/commercetools/api/models/order_edit/StagedOrderSetLineItemTaxAmountAction.java
@@ -16,7 +16,7 @@
 import io.vrap.rmf.base.client.utils.Generated;
 
 /**
- *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action sets the <code>taxedPrice</code> and <code>taxRate</code> on a Line Item and must be used after any price-affecting change occurs.</p>
  *
  * <hr>
  * Example to create an instance using the builder pattern

diff --git a/...ed/com/commercetools/api/models/order_edit/StagedOrderSetLineItemTaxAmountActionImpl.java b/...ed/com/commercetools/api/models/order_edit/StagedOrderSetLineItemTaxAmountActionImpl.java
@@ -17,7 +17,7 @@
 import org.apache.commons.lang3.builder.ToStringStyle;
 
 /**
- *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode.</p>
+ *  <p>Can be used if the Cart has the <code>ExternalAmount</code> TaxMode. This update action sets the <code>taxedPrice</code> and <code>taxRate</code> on a Line Item and must be used after any price-affecting change occurs.</p>
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
 public class StagedOrderSetLineItemTaxAmountActionImpl implements StagedOrderSetLineItemTaxAmountAction, ModelBase {

diff --git a/references.txt b/references.txt
@@ -238,3 +238,4 @@ cdb527e0fe5524d6c7411066fca556e1b3403003
 f1d13dc3acf6960cda08494da701d04a46f9eb3f
 eac13cfcb88a83f4f4e977ba51c0b11e458cff61
 6abab3f555aab9f5aa5b8a1b551235188fbb9201
+1b650bc8eb1a78c3487484900b1e36d06226c6e2