@wix/ditto-codegen-public 1.0.7 → 1.0.8

package/dist/docs-output/service-plugins/ecom-tax-calculation-provider-doc.txt

@@ -0,0 +1,244 @@
+
+<tax_calculation_provider_service_plugin>
+<purpose>**Required.** Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
+
+For example, to call the Calculate Tax endpoint at `https://my-tax-calc.com/v1/calculateTax`, the base URI you provide here is `"https://my-tax-calc.com/"`.</purpose>
+<use_cases>
+- Handle addresses: Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.
+- Handle currency: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+- Handle lineItems: Line items to calculate tax for.
+</use_cases>
+<required_handlers>
+- calculateTax() - Handler to process: Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.
+</required_handlers>
+<import>import { taxCalculationProvider } from '@wix/ecom/service-plugins'</import>
+<types>
+
+**Address**
+Properties:
+- addressLine1: string - Main address line, usually street and number as free text.
+
+maxLength 200
+- addressLine2: string - Free text providing more detailed address information, such as apartment, suite, or floor.
+
+maxLength 200
+- city: string - City name.
+
+maxLength 100
+- country: string - 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
+- postalCode: string - Postal or zip code.
+
+maxLength 50
+- subdivision: string - Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
+
+maxLength 50
+
+**AddressIndex**
+One of (addressIndexOptions):
+- multipleAddresses: MultipleAddresses - Multiple addresses to use for a sale. For example, some tax calculations may require both the address where an item is shipped from,
+as well as the address the item is shipped to.
+- singleAddress: number - Single address to use for a sale location when only one address is required for tax calculations. The index is zero-based.
+
+**AlternativeUri**
+Properties:
+- absoluteUri: string - Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
+Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
+
+minLength 6, maxLength 2048
+- methodName: string - Name of the method to create a custom URI for.
+
+For `methodName`, use the name of the method in PascalCase.
+For example, for Get Shipping Rates use `GetShippingRates`.
+
+minLength 3, maxLength 128
+
+**CalculateTaxEnvelope**
+Properties:
+- metadata: Context
+- request: CalculateTaxRequest
+
+**CalculateTaxRequest**
+Properties:
+- addresses: Address[] - Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.
+
+minSize 1, maxSize 3
+- currency: string - 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+
+format CURRENCY
+- lineItems: LineItem[] - Line items to calculate tax for.
+
+minSize 1, maxSize 300
+
+**CalculateTaxResponse**
+Properties:
+- currency: string - 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+If this code doesn't match the `currency` passed in the request, then the response is invalid.
+
+format CURRENCY
+- lineItemTaxDetails: LineItemTaxDetails[] - Details of each tax applied to each line item.
+
+minSize 1, maxSize 300
+- taxSummary: TaxSummary - Summary of the tax calculated.
+
+**Context**
+Properties:
+- currency: string - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+
+format CURRENCY
+- identity: IdentificationData - An object that describes the identity that triggered this request.
+- instanceId: string - The service provider app's instance ID.
+
+format GUID
+- languages: string[] - A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`.
+- requestId: string - A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.
+
+**IdentificationData**
+Properties:
+- identityType: IdentityType
+One of (id):
+- anonymousVisitorId: string - ID of a site visitor that has not logged in to the site.
+- appId: string - ID of an app.
+- memberId: string - ID of a site visitor that has logged in to the site.
+- wixUserId: string - ID of a Wix user (site owner, contributor, etc.).
+
+**IdentityType**
+Enum values:
+- ANONYMOUS_VISITOR
+- APP
+- MEMBER
+- UNKNOWN
+- WIX_USER
+
+**JurisdictionType**
+Enum values:
+- CITY
+- COUNTRY
+- COUNTY
+- SPECIAL
+- STATE
+- UNDEFINED
+
+**LineItem**
+Properties:
+- _id: string - Line item ID.
+
+minLength 1, maxLength 100
+- addressIndex: AddressIndex - Index of the address from `addresses` to use to calculate tax for this specific line item. The index is zero-based.
+- itemCode: string - Stock keeping unit for this line item. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
+
+maxLength 40
+- itemName: string - Line item name to display.
+
+maxLength 250
+- price: string - Line item price.
+
+format DECIMAL_VALUE, decimalValue { lte:1000000000000000 }
+- quantity: number - Line item quantity.
+
+min 1, max 100000
+- taxGroupId: string - Tax group ID for this line item. If not provided, the default tax group applies.
+
+format GUID
+- taxIncludedInPrice: boolean - Whether tax is included in the price.
+- taxRegionId: string - Tax region ID for this line item.
+
+format GUID
+
+**LineItemTaxDetails**
+Properties:
+- _id: string - Line item ID.
+
+minLength 1, maxLength 100
+- itemName: string - Line item name to display.
+
+maxLength 250
+- quantity: number - Line item quantity.
+
+min 1, max 100000
+- taxBreakdown: TaxBreakdown[] - Array of each tax applied, grouped by `jurisdiction`, `jurisdictionType`, `taxName`, `rate`, and `taxType`.
+
+maxSize 7
+- taxSummary: LineItemTaxSummary - Summary of this line item's total price and tax.
+
+**LineItemTaxSummary**
+Properties:
+- fullPrice: string - 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 { lte:1000000000000000 }
+- taxableAmount: string - Total taxable amount for this line item.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+- taxAmount: string - The total amount of tax calculated for this line item.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+
+**MultipleAddresses**
+Properties:
+- destination: number - Index of the destination address.
+- origin: number - Index of the origin address.
+
+**SpiBaseUri**
+Properties:
+- alternativeUris: AlternativeUri[] - Alternate, custom URIs to replace the default URIs for specific service plugin methods.
+- baseUri: string - Base URI where the methods are called. Wix appends the path to the `baseUri`.
+For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
+
+minLength 6, maxLength 2048
+
+**TaxBreakdown**
+Properties:
+- jurisdiction: string - Jurisdiction that taxes were calculated for.
+
+maxLength 200
+- jurisdictionType: JurisdictionType - Type of jurisdiction that taxes were calculated for. For example, `"State"`, `"County"`, `"City"`, `"Special"`, etc.
+- nonTaxableAmount: string - Non-taxable amount of the price.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4, gte:0 }
+- rate: string - 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 { maxScale:6, gte:0 }
+- taxableAmount: string - Taxable amount of the price.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4, gte:0 }
+- taxAmount: string - Amount of this tax calculated for this jurisdiction.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+- taxName: string - Name of the tax that was calculated. For example, `"NY State Sales Tax"`, `"Quebec GST"`, etc.
+
+maxLength 200
+- taxType: string - Type of tax that was calculated. For example, `"Sales Tax"`, `"Income Tax"`, `"Value Added Tax"`, etc.
+
+maxLength 200
+
+**TaxCalculationConfig**
+Properties:
+- calculatorDisplayName: string - Display name of the tax calculator.
+
+minLength 1, maxLength 200
+- deploymentUri: SpiBaseUri - **Required.** Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
+
+For example, to call the Calculate Tax endpoint at `https://my-tax-calc.com/v1/calculateTax`, the base URI you provide here is `"https://my-tax-calc.com/"`.
+- unsupportedCountries: 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.
+
+format COUNTRY, maxSize 195
+
+**TaxSummary**
+Properties:
+- totalAmount: string - Total price for all line items.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+- totalTax: 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 { maxScale:4 }
+- totalTaxableAmount: string - Total taxable amount for all line items.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+- totalTaxIncludedInPrice: string - Total amount of `totalTax` that is included in price. Applies to line items with `taxIncludedInPrice` set to `true`.
+
+format DECIMAL_VALUE, decimalValue { maxScale:4 }
+</types>
+</tax_calculation_provider_service_plugin>