@medusajs/types 1.12.0-snapshot-20240403120107 → 1.12.0-snapshot-20240405154416

package/dist/tax/common.d.ts

@@ -1,12 +1,17 @@
 import { BaseFilterable } from "../dal";
 import { OperatorMap } from "../dal/utils";
+/**
+ * The tax rate details.
+ */
 export interface TaxRateDTO {
     /**
-     * The ID of the Tax Rate.
+     * The ID of the tax rate.
      */
     id: string;
     /**
-     * The numerical rate to charge.
+     * The rate to charge.
+     * @example
+     * 10
      */
     rate: number | null;
     /**
@@ -14,7 +19,9 @@ export interface TaxRateDTO {
      */
     code: string | null;
     /**
-     * The name of the Tax Rate. E.g. "VAT".
+     * The name of the Tax Rate.
+     * @example
+     * VAT
      */
     name: string;
     /**
@@ -22,136 +29,417 @@ export interface TaxRateDTO {
      */
     metadata: Record<string, unknown> | null;
     /**
-     * The id of the Tax Region the rate is associated with.
+     * The ID of the associated tax region.
      */
     tax_region_id: string;
     /**
-     * Flag to indicate if the Tax Rate should be combined with parent rates.
+     * Whether the tax rate should be combined with parent rates.
+     *
+     * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).
      */
     is_combinable: boolean;
     /**
-     * Flag to indicate if the Tax Rate is the default rate for the region.
+     * Whether the tax rate is the default rate for the region.
      */
     is_default: boolean;
     /**
-     * When the Tax Rate was created.
+     * The creation date of the tax rate.
      */
     created_at: string | Date;
     /**
-     * When the Tax Rate was updated.
+     * The update date of the tax rate.
      */
     updated_at: string | Date;
     /**
-     * When the Tax Rate was deleted.
+     * The deletion date of the tax rate.
      */
     deleted_at: Date | null;
     /**
-     * The ID of the user that created the Tax Rate.
+     * Who created the tax rate. For example, the ID of the user that created the tax rate.
      */
     created_by: string | null;
 }
+/**
+ * The tax provider details.
+ */
 export interface TaxProviderDTO {
+    /**
+     * The ID of the tax provider.
+     */
     id: string;
+    /**
+     * Whether the tax provider is enabled.
+     */
     is_enabled: boolean;
 }
+/**
+ * The filters to apply on the retrieved tax rates.
+ */
 export interface FilterableTaxRateProps extends BaseFilterable<FilterableTaxRateProps> {
+    /**
+     * The IDs to filter the tax rates by.
+     */
     id?: string | string[];
+    /**
+     * Filter the tax rates by their associated tax regions.
+     */
     tax_region_id?: string | string[];
+    /**
+     * Filter the tax rates by their rate.
+     */
     rate?: number | number[] | OperatorMap<number>;
+    /**
+     * Filter the tax rates by their code.
+     */
     code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax rates by their name.
+     */
     name?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax rates by their creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter the tax rates by their update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter the tax rates by who created it.
+     */
     created_by?: string | string[] | OperatorMap<string>;
 }
+/**
+ * The tax region details.
+ */
 export interface TaxRegionDTO {
+    /**
+     * The ID of the tax region.
+     */
     id: string;
+    /**
+     * The ISO 2 character country code of the tax region.
+     */
     country_code: string;
+    /**
+     * The province code of the tax region.
+     */
     province_code: string | null;
+    /**
+     * The ID of the tax region's parent tax region.
+     */
     parent_id: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the tax region.
+     */
     created_at: string | Date;
+    /**
+     * The update date of the tax region.
+     */
     updated_at: string | Date;
+    /**
+     * Who created the tax region. For example, the ID of the user
+     * that created the tax region.
+     */
     created_by: string | null;
+    /**
+     * The deletion date of the tax region.
+     */
     deleted_at: string | Date | null;
 }
+/**
+ * The filters to apply on the retrieved tax regions.
+ */
 export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRegionProps> {
+    /**
+     * The IDs to filter the tax regions by.
+     */
     id?: string | string[];
+    /**
+     * Filter the tax regions by their country code.
+     */
     country_code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax regions by their province code.
+     */
     province_code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax regions by the ID of their parent tax region.
+     */
     parent_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax regions by their metadata.
+     */
     metadata?: Record<string, unknown> | Record<string, unknown>[] | OperatorMap<Record<string, unknown>>;
+    /**
+     * Filter the tax regions by their creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter the tax regions by their update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter the tax regions by who created it.
+     */
     created_by?: string | string[] | OperatorMap<string>;
 }
+/**
+ * The tax rate rule details.
+ */
 export interface TaxRateRuleDTO {
+    /**
+     * The ID of the tax rate rule.
+     */
     id: string;
+    /**
+     * The snake-case name of the data model that the tax rule references.
+     * For example, `product`.
+     *
+     * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
+     */
     reference: string;
+    /**
+     * The ID of the record of the data model that the tax rule references.
+     * For example, `prod_123`.
+     *
+     * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
+     */
     reference_id: string;
+    /**
+     * The associated tax rate's ID.
+     */
     tax_rate_id: string;
+    /**
+     * The associated tax rate.
+     */
     tax_rate?: TaxRateDTO;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the tax rate rule.
+     */
     created_at: string | Date;
+    /**
+     * The update date of the tax rate rule.
+     */
     updated_at: string | Date;
+    /**
+     * Who created the tax rate rule. For example, the ID of the user
+     * that created the tax rate rule.
+     */
     created_by: string | null;
 }
+/**
+ * The filters to apply on the retrieved tax rate rules.
+ */
 export interface FilterableTaxRateRuleProps extends BaseFilterable<FilterableTaxRateRuleProps> {
+    /**
+     * Filter the tax rate rule by what it references.
+     */
     reference?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax rate rule by the ID of the record it references.
+     */
     reference_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax rate rule by the ID of their associated tax rate.
+     */
     tax_rate_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the tax rate rule by their associated tax rate.
+     */
     tax_rate?: FilterableTaxRateProps;
+    /**
+     * Filter the tax rate rule by what its metadata.
+     */
     metadata?: Record<string, unknown> | Record<string, unknown>[] | OperatorMap<Record<string, unknown>>;
+    /**
+     * Filter the tax rate rule by its creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter the tax rate rule by its update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter the tax rate rule by who created it.
+     */
     created_by?: string | string[] | OperatorMap<string>;
 }
+/**
+ * The taxable item details.
+ */
 export interface TaxableItemDTO {
+    /**
+     * The ID of the taxable item.
+     */
     id: string;
+    /**
+     * The associated product's ID.
+     */
     product_id: string;
+    /**
+     * The name of the item's product.
+     */
     product_name?: string;
+    /**
+     * The ID of the category of the item's product.
+     */
     product_category_id?: string;
+    /**
+     * The categories of the item's product.
+     */
     product_categories?: string[];
+    /**
+     * The SKU of the item's product.
+     */
     product_sku?: string;
+    /**
+     * The type of the item's product.
+     */
     product_type?: string;
+    /**
+     * The ID of the type of the item's product.
+     */
     product_type_id?: string;
+    /**
+     * The quantity of the taxable item.
+     */
     quantity?: number;
+    /**
+     * The unit price of the taxable item.
+     */
     unit_price?: number;
+    /**
+     * The ISO 3 character currency code of the taxable item.
+     */
     currency_code?: string;
 }
+/**
+ * The taxable shipping details.
+ */
 export interface TaxableShippingDTO {
+    /**
+     * The ID of the taxable shipping.
+     */
     id: string;
+    /**
+     * The associated shipping option's ID.
+     */
     shipping_option_id: string;
+    /**
+     * The unit price of the taxable shipping.
+     */
     unit_price?: number;
+    /**
+     * The ISO 3 character currency code of the taxable shipping.
+     */
     currency_code?: string;
 }
+/**
+ * The context provided when tax lines are calculated and retrieved. This
+ * context is later passed to the underlying tax provider.
+ */
 export interface TaxCalculationContext {
+    /**
+     * The customer's address
+     */
     address: {
+        /**
+         * The ISO 2 character currency code.
+         */
         country_code: string;
+        /**
+         * The province code.
+         */
         province_code?: string | null;
+        /**
+         * The first line of the address.
+         */
         address_1?: string;
+        /**
+         * The second line of the address
+         */
         address_2?: string | null;
+        /**
+         * The city.
+         */
         city?: string;
+        /**
+         * The postal code.
+         */
         postal_code?: string;
     };
+    /**
+     * The customer's details.
+     */
     customer?: {
+        /**
+         * The ID of the customer.
+         */
         id: string;
+        /**
+         * The email of the customer.
+         */
         email: string;
+        /**
+         * The groups that the customer belongs to.
+         */
         customer_groups: string[];
     };
+    /**
+     * Whether the tax lines are calculated for an order return.
+     */
     is_return?: boolean;
 }
+/**
+ * The tax line details.
+ */
 interface TaxLineDTO {
+    /**
+     * The associated rate's ID.
+     */
     rate_id?: string;
+    /**
+     * The rate of the tax line.
+     */
     rate: number | null;
+    /**
+     * The code of the tax line.
+     */
     code: string | null;
+    /**
+     * The name of the tax line.
+     */
     name: string;
+    /**
+     * The ID of the tax provider used to calculate and retrieve the tax line.
+     */
     provider_id: string;
 }
+/**
+ * The item tax line details.
+ */
 export interface ItemTaxLineDTO extends TaxLineDTO {
+    /**
+     * The associated line item's ID.
+     */
     line_item_id: string;
 }
+/**
+ * The shipping tax line details.
+ */
 export interface ShippingTaxLineDTO extends TaxLineDTO {
+    /**
+     * The associated shipping line's ID.
+     */
     shipping_line_id: string;
 }
 export {};

package/dist/tax/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACtD,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnD,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnD,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACtD,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACrD,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IACjC,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AACD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACzB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IACD,QAAQ,CAAC,EAAE;QACT,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,EAAE,CAAA;KAC1B,CAAA;IACD,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,UAAU,UAAU;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,gBAAgB,EAAE,MAAM,CAAA;CACzB"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAE7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QAEV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;KAC1B,CAAA;IAED;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB"}

package/dist/tax/mutations.d.ts

@@ -1,50 +1,207 @@
+/**
+ * The tax rate to be created.
+ */
 export interface CreateTaxRateDTO {
+    /**
+     * The associated tax region's ID.
+     */
     tax_region_id: string;
+    /**
+     * The rate to charge.
+     *
+     * @example
+     * 10
+     */
     rate?: number | null;
+    /**
+     * The code of the tax rate.
+     */
     code?: string | null;
+    /**
+     * The name of the tax rate.
+     */
     name: string;
+    /**
+     * The rules of the tax rate.
+     */
     rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
+    /**
+     * Whether the tax rate is default.
+     */
     is_default?: boolean;
+    /**
+     * Who created the tax rate. For example, the ID of the user
+     * that created the tax rate.
+     */
     created_by?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * The attributes in the tax rate to be created or updated.
+ */
 export interface UpsertTaxRateDTO {
+    /**
+     * The ID of the tax rate. If not provided, the tax rate
+     * is created.
+     */
     id?: string;
+    /**
+     * The rate to charge
+     *
+     * @example
+     * 10
+     */
     rate?: number | null;
+    /**
+     * The code of the tax rate.
+     */
     code?: string | null;
+    /**
+     * The name of the tax rate.
+     */
     name?: string;
+    /**
+     * Whether the tax rate is default.
+     */
     is_default?: boolean;
+    /**
+     * Who created the tax rate. For example, the
+     * ID of the user that created it.
+     */
     created_by?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
 }
+/**
+ * The attributes to update in the tax rate.
+ */
 export interface UpdateTaxRateDTO {
+    /**
+     * The rate to charge.
+     *
+     * @example
+     * 10
+     */
     rate?: number | null;
+    /**
+     * The code of the tax rate.
+     */
     code?: string | null;
+    /**
+     * The name of the tax rate.
+     */
     name?: string;
+    /**
+     * The rules of the tax rate.
+     */
     rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
+    /**
+     * Whether the tax rate is default.
+     */
     is_default?: boolean;
+    /**
+     * Whether the tax rate is combinable.
+     *
+     * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).
+     */
     is_combinable?: boolean;
+    /**
+     * @ignore
+     *
+     * @privateRemarks
+     * This should be `created_by`.
+     */
     updated_by?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * The tax region to be created.
+ */
 export interface CreateTaxRegionDTO {
+    /**
+     * The ISO 3 character country code of the tax region.
+     */
     country_code: string;
+    /**
+     * The province code of the tax region.
+     */
     province_code?: string | null;
+    /**
+     * The ID of the tax region's parent.
+     */
     parent_id?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * Who created the tax region. For example, the ID of
+     * the user that created the tax region.
+     */
     created_by?: string;
+    /**
+     * The default tax rate of the tax region.
+     */
     default_tax_rate?: {
+        /**
+         * The rate to charge.
+         *
+         * @example
+         * 10
+         */
         rate?: number | null;
+        /**
+         * The code of the tax rate.
+         */
         code?: string | null;
+        /**
+         * The name of the tax rate.
+         */
         name: string;
+        /**
+         * Holds custom data in key-value pairs.
+         */
         metadata?: Record<string, unknown>;
     };
 }
+/**
+ * The tax rate rule to be created.
+ */
 export interface CreateTaxRateRuleDTO {
+    /**
+     * The snake-case name of the data model that the tax rule references.
+     * For example, `product`.
+     *
+     * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
+     */
     reference: string;
+    /**
+     * The ID of the record of the data model that the tax rule references.
+     * For example, `prod_123`.
+     *
+     * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
+     */
     reference_id: string;
+    /**
+     * The associated tax rate's ID.
+     */
     tax_rate_id: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * Who created the tax rate rule. For example, the ID of the
+     * user that created it.
+     */
     created_by?: string | null;
 }
 //# sourceMappingURL=mutations.d.ts.map

package/dist/tax/mutations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IACnD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IACnD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE;QACjB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACjB;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}