@wix/auto_sdk_billing_tax-calculation 1.0.1 → 1.0.3

package/build/internal/cjs/src/gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.d.ts

@@ -1,44 +1,99 @@
 export interface TaxCalculationGateway {
+    /** @format GUID */
     id?: string | null;
 }
 export interface CalculateTaxRequest {
-    /** Optional ID of the entity that tax is being calculated for. For example, a cart ID. */
+    /**
+     * Optional ID of the entity that tax is being calculated for. For example, a cart ID.
+     * @format GUID
+     * @immutable
+     */
     externalId?: string | null;
-    /** 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
     currency?: string;
-    /** Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`. */
+    /**
+     * Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.
+     * @minSize 1
+     * @maxSize 3
+     */
     addresses: Address[];
-    /** Line items to calculate tax for. */
+    /**
+     * Line items to calculate tax for.
+     * @minSize 1
+     * @maxSize 300
+     */
     lineItems: LineItem[];
 }
 /** Wix common address format for physical address to use if you plan to store addresses in your service. */
 export interface Address {
-    /** 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
+    /**
+     * 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
+     * @format COUNTRY
+     */
     country?: string | null;
-    /** Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
+    /**
+     * Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
+     * @maxLength 50
+     */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 100
+     */
     city?: string | null;
-    /** Postal or zip code. */
+    /**
+     * Postal or zip code.
+     * @maxLength 50
+     */
     postalCode?: string | null;
-    /** Main address line, usually street and number as free text. */
+    /**
+     * Main address line, usually street and number as free text.
+     * @maxLength 200
+     */
     addressLine?: string | null;
-    /** Free text providing more detailed address information, such as apartment, suite, or floor. */
+    /**
+     * Free text providing more detailed address information, such as apartment, suite, or floor.
+     * @maxLength 200
+     */
     addressLine2?: string | null;
 }
 /** Line items to calculate tax for. */
 export interface LineItem {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     id?: string;
-    /** Line item name to display. */
+    /**
+     * Line item name to display.
+     * @maxLength 250
+     */
     itemName?: string | null;
-    /** Line item quantity. */
+    /**
+     * Line item quantity.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
-    /** Line item price. */
+    /**
+     * Line item price.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { lte:1000000000000000 }
+     */
     price?: string;
-    /** Stock keeping unit for this line item. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    /**
+     * Stock keeping unit for this line item. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
+     * @maxLength 40
+     */
     itemCode?: string | null;
-    /** Tax group ID for this line item. If not provided, the default tax group applies. */
+    /**
+     * Tax group ID for this line item. If not provided, the default tax group applies.
+     * @format GUID
+     */
     taxGroupId?: string | null;
     /**
      * ID of the app providing the catalog for this line item.
@@ -49,6 +104,7 @@ export interface LineItem {
      * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
      * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
      * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * @format GUID
      */
     appId?: string | null;
     /** Whether tax is included in the price. */
@@ -87,32 +143,67 @@ export interface MultipleAddresses {
     destination?: number;
 }
 export interface CalculateTaxResponse {
-    /** Optional ID of the entity that tax is being calculated for. For example, a cart ID. */
+    /**
+     * Optional ID of the entity that tax is being calculated for. For example, a cart ID.
+     * @format GUID
+     * @immutable
+     */
     externalId?: string | null;
-    /** 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
     currency?: string;
-    /** Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`. */
+    /**
+     * Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.
+     * @minSize 1
+     * @maxSize 3
+     */
     addresses?: Address[];
     /** Summary of the tax calculated. */
     taxSummary?: TaxSummary;
-    /** Details of each tax applied to each line item. */
+    /**
+     * Details of each tax applied to each line item.
+     * @minSize 1
+     * @maxSize 300
+     */
     lineItemTaxDetails?: LineItemTaxDetails[];
-    /** Errors that occurred during the tax calculation. */
+    /**
+     * Errors that occurred during the tax calculation.
+     * @maxSize 100
+     */
     errors?: ApplicationError[];
 }
 export interface TaxSummary {
-    /** Total price for all line items. */
+    /**
+     * Total price for all line items.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     totalAmount?: string;
     /**
      * Total amount of tax calculated for all line items.
      * Note that due to rounding, `totalTax` may not equal the sum of `lineItemTaxDetails.taxSummary.taxAmount`.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
      */
     totalTax?: string;
-    /** Total taxable amount for all line items. */
+    /**
+     * Total taxable amount for all line items.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     totalTaxableAmount?: string;
-    /** Total amount of `totalTax` that is included in price. Applies to line items with `taxIncludedInPrice` set to `true`. */
+    /**
+     * Total amount of `totalTax` that is included in price. Applies to line items with `taxIncludedInPrice` set to `true`.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     totalTaxIncludedInPrice?: string;
-    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdictionType"`, `"taxType"`, `"taxName"` and `"rate"`. */
+    /**
+     * Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdictionType"`, `"taxType"`, `"taxName"` and `"rate"`.
+     * @maxSize 50
+     */
     aggregatedTaxBreakdown?: AggregatedTaxBreakdown[];
 }
 /**
@@ -124,17 +215,33 @@ export interface TaxSummary {
  * then the tax rate will be remain 10% but tax amount in the breakdown will be 5$ instead of 10$.
  */
 export interface AggregatedTaxBreakdown {
-    /** Name of the tax that was calculated. */
+    /**
+     * Name of the tax that was calculated.
+     * @maxLength 200
+     */
     taxName?: string;
-    /** Type of tax that was calculated. */
+    /**
+     * Type of tax that was calculated.
+     * @maxLength 200
+     */
     taxType?: string;
-    /** Jurisdiction that taxes were calculated for. */
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
     jurisdiction?: string;
     /** Type of jurisdiction that taxes were calculated for. */
     jurisdictionType?: JurisdictionType;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
+    /**
+     * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     rate?: string;
-    /** Total amount of this tax for this jurisdiction. */
+    /**
+     * Total amount of this tax for this jurisdiction.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     aggregatedTaxAmount?: string;
 }
 /** Type of jurisdiction that taxes were calculated for. For example, `"State"`, `"County"`, `"City"`, `"Special"`, etc. */
@@ -148,13 +255,27 @@ export declare enum JurisdictionType {
 }
 /** Tax details for a specific line item. */
 export interface LineItemTaxDetails {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     id?: string;
-    /** Line item name to display. */
+    /**
+     * Line item name to display.
+     * @maxLength 250
+     */
     itemName?: string | null;
-    /** Line item quantity. */
+    /**
+     * Line item quantity.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
-    /** Array of each tax applied, grouped by `jurisdiction`. */
+    /**
+     * Array of each tax applied, grouped by `jurisdiction`.
+     * @maxSize 7
+     */
     taxBreakdown?: TaxBreakdown[];
     /** Summary of this line item's total price and tax. */
     taxSummary?: LineItemTaxSummary;
@@ -165,19 +286,44 @@ export interface LineItemTaxDetails {
 }
 /** A detailed description of all the tax authorities applied on this item. */
 export interface TaxBreakdown {
-    /** Jurisdiction that taxes were calculated for. */
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
     jurisdiction?: string | null;
-    /** Non-taxable amount of the price. */
+    /**
+     * Non-taxable amount of the price.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4, gte:0 }
+     */
     nonTaxableAmount?: string | null;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
+    /**
+     * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:6, gte:0 }
+     */
     rate?: string | null;
-    /** Amount of this tax calculated for this jurisdiction. */
+    /**
+     * Amount of this tax calculated for this jurisdiction.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     taxAmount?: string | null;
-    /** Taxable amount of the price. */
+    /**
+     * Taxable amount of the price.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4, gte:0 }
+     */
     taxableAmount?: string | null;
-    /** Type of tax that was calculated. For example, `"Sales Tax"`, `"Income Tax"`, `"Value Added Tax"`, etc. */
+    /**
+     * Type of tax that was calculated. For example, `"Sales Tax"`, `"Income Tax"`, `"Value Added Tax"`, etc.
+     * @maxLength 200
+     */
     taxType?: string | null;
-    /** Name of the tax that was calculated. For example, `"NY State Sales Tax"`, `"Quebec GST"`, etc. */
+    /**
+     * Name of the tax that was calculated. For example, `"NY State Sales Tax"`, `"Quebec GST"`, etc.
+     * @maxLength 200
+     */
     taxName?: string | null;
     /** Type of jurisdiction that taxes were calculated for. For example, `"State"`, `"Çounty"`, `"City"`, `"Special"`, etc. */
     jurisdictionType?: JurisdictionType;
@@ -186,13 +332,26 @@ export interface LineItemTaxSummary {
     /**
      * Total price for this line item.
      * To determine the price for each individual unit of this line item, divide by `quantity`.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { lte:1000000000000000 }
      */
     fullPrice?: string | null;
-    /** Total amount of tax calculated for this line item. */
+    /**
+     * Total amount of tax calculated for this line item.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     taxAmount?: string;
-    /** Total taxable amount for this line item. */
+    /**
+     * Total taxable amount for this line item.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     taxableAmount?: string;
-    /** ID of the calculator app that calculated tax for this line item. */
+    /**
+     * ID of the calculator app that calculated tax for this line item.
+     * @maxLength 50
+     */
     appId?: string | null;
 }
 export interface ApplicationError {
@@ -206,15 +365,29 @@ export interface ApplicationError {
 export interface ListTaxCalculatorsRequest {
 }
 export interface ListTaxCalculatorsResponse {
-    /** Retrieved tax calculators. */
+    /**
+     * Retrieved tax calculators.
+     * @maxSize 10
+     */
     taxCalculatorDetails?: TaxCalculatorDetails[];
 }
 export interface TaxCalculatorDetails {
-    /** ID of the tax calculator. */
+    /**
+     * ID of the tax calculator.
+     * @format GUID
+     */
     appId?: string;
-    /** Display name of the tax calculator. */
+    /**
+     * Display name of the tax calculator.
+     * @minLength 1
+     * @maxLength 200
+     */
     displayName?: string;
-    /** List of countries, in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format, that the calculator does not support. */
+    /**
+     * List of countries, in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format, that the calculator does not support.
+     * @format COUNTRY
+     * @maxSize 195
+     */
     unsupportedCountries?: string[];
 }
 interface AggregatedTaxBreakdownNonNullableFields {

package/build/internal/cjs/src/gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.js","sourceRoot":"","sources":["../../../../src/gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.ts"],"names":[],"mappings":";;;AAqJA,2HAA2H;AAC3H,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B"}
+{"version":3,"file":"gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.js","sourceRoot":"","sources":["../../../../src/gateways-billing-v1-tax-calculation-gateway-tax-calculation.types.ts"],"names":[],"mappings":";;;AAgQA,2HAA2H;AAC3H,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B"}