@medusajs/types 3.0.0-snapshot-20250410105645 → 3.0.0-snapshot-20251104004624

package/dist/settings/mutations.d.ts

@@ -0,0 +1,121 @@
+/**
+ * The view configuration to be created.
+ */
+export interface CreateViewConfigurationDTO {
+    /**
+     * The entity this configuration is for.
+     */
+    entity: string;
+    /**
+     * The name of the configuration. Required unless creating a system default.
+     */
+    name?: string;
+    /**
+     * The user ID this configuration belongs to. Can be null for system defaults.
+     */
+    user_id?: string | null;
+    /**
+     * Whether this is a system default configuration.
+     */
+    is_system_default?: boolean;
+    /**
+     * The configuration data.
+     */
+    configuration: {
+        /**
+         * The visible columns.
+         */
+        visible_columns: string[];
+        /**
+         * The column order.
+         */
+        column_order: string[];
+        /**
+         * The column widths.
+         */
+        column_widths?: Record<string, number>;
+        /**
+         * The filters to apply.
+         */
+        filters?: Record<string, any>;
+        /**
+         * The sorting configuration.
+         */
+        sorting?: {
+            id: string;
+            desc: boolean;
+        } | null;
+        /**
+         * The search string.
+         */
+        search?: string;
+    };
+}
+/**
+ * The attributes to update in the view configuration.
+ */
+export interface UpdateViewConfigurationDTO {
+    /**
+     * The name of the configuration.
+     */
+    name?: string;
+    /**
+     * The configuration data.
+     */
+    configuration?: {
+        /**
+         * The visible columns.
+         */
+        visible_columns?: string[];
+        /**
+         * The column order.
+         */
+        column_order?: string[];
+        /**
+         * The column widths.
+         */
+        column_widths?: Record<string, number>;
+        /**
+         * The filters to apply.
+         */
+        filters?: Record<string, any>;
+        /**
+         * The sorting configuration.
+         */
+        sorting?: {
+            id: string;
+            desc: boolean;
+        } | null;
+        /**
+         * The search string.
+         */
+        search?: string;
+    };
+}
+/**
+ * The user preference to be created.
+ */
+export interface CreateUserPreferenceDTO {
+    /**
+     * The user ID.
+     */
+    user_id: string;
+    /**
+     * The preference key.
+     */
+    key: string;
+    /**
+     * The preference value.
+     */
+    value: any;
+}
+/**
+ * The attributes to update in the user preference.
+ */
+export interface UpdateUserPreferenceDTO {
+    /**
+     * The preference value.
+     */
+    value: any;
+}
+//# sourceMappingURL=mutations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/settings/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,aAAa,EAAE;QACb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,EAAE,CAAA;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEtC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE,GAAG,IAAI,CAAA;QAE9C;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QACd;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEtC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE,GAAG,IAAI,CAAA;QAE9C;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,KAAK,EAAE,GAAG,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,GAAG,CAAA;CACX"}

package/dist/settings/mutations.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mutations.js.map

package/dist/settings/mutations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.js","sourceRoot":"","sources":["../../src/settings/mutations.ts"],"names":[],"mappings":""}

package/dist/settings/service.d.ts

@@ -0,0 +1,25 @@
+import { Context } from "../shared-context";
+import { FindConfig } from "../common";
+import { IModuleService } from "../modules-sdk";
+import { ViewConfigurationDTO, UserPreferenceDTO, FilterableViewConfigurationProps, FilterableUserPreferenceProps } from "./common";
+import { CreateViewConfigurationDTO, UpdateViewConfigurationDTO } from "./mutations";
+export interface ISettingsModuleService extends IModuleService {
+    retrieveViewConfiguration(id: string, config?: FindConfig<ViewConfigurationDTO>, sharedContext?: Context): Promise<ViewConfigurationDTO>;
+    listViewConfigurations(filters?: FilterableViewConfigurationProps, config?: FindConfig<ViewConfigurationDTO>, sharedContext?: Context): Promise<ViewConfigurationDTO[]>;
+    listAndCountViewConfigurations(filters?: FilterableViewConfigurationProps, config?: FindConfig<ViewConfigurationDTO>, sharedContext?: Context): Promise<[ViewConfigurationDTO[], number]>;
+    createViewConfigurations(data: CreateViewConfigurationDTO[], sharedContext?: Context): Promise<ViewConfigurationDTO[]>;
+    createViewConfigurations(data: CreateViewConfigurationDTO, sharedContext?: Context): Promise<ViewConfigurationDTO>;
+    updateViewConfigurations(idOrSelector: string, data: UpdateViewConfigurationDTO, sharedContext?: Context): Promise<ViewConfigurationDTO>;
+    updateViewConfigurations(idOrSelector: FilterableViewConfigurationProps, data: UpdateViewConfigurationDTO, sharedContext?: Context): Promise<ViewConfigurationDTO[]>;
+    deleteViewConfigurations(ids: string | string[], sharedContext?: Context): Promise<void>;
+    retrieveUserPreference(id: string, config?: FindConfig<UserPreferenceDTO>, sharedContext?: Context): Promise<UserPreferenceDTO>;
+    listUserPreferences(filters?: FilterableUserPreferenceProps, config?: FindConfig<UserPreferenceDTO>, sharedContext?: Context): Promise<UserPreferenceDTO[]>;
+    getUserPreference(userId: string, key: string, sharedContext?: Context): Promise<UserPreferenceDTO | null>;
+    setUserPreference(userId: string, key: string, value: any, sharedContext?: Context): Promise<UserPreferenceDTO>;
+    deleteUserPreferences(ids: string | string[], sharedContext?: Context): Promise<void>;
+    getActiveViewConfiguration(entity: string, userId: string, sharedContext?: Context): Promise<ViewConfigurationDTO | null>;
+    setActiveViewConfiguration(entity: string, userId: string, viewConfigurationId: string, sharedContext?: Context): Promise<void>;
+    getSystemDefaultViewConfiguration(entity: string, sharedContext?: Context): Promise<ViewConfigurationDTO | null>;
+    clearActiveViewConfiguration(entity: string, userId: string, sharedContext?: Context): Promise<void>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/settings/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/settings/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,gCAAgC,EAChC,6BAA6B,EAC9B,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAE5D,yBAAyB,CACvB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC,sBAAsB,CACpB,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC,8BAA8B,CAC5B,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAE5C,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAAE,EAClC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC,wBAAwB,CACtB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC,wBAAwB,CACtB,YAAY,EAAE,gCAAgC,EAC9C,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC,wBAAwB,CACtB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAGhB,sBAAsB,CACpB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B,mBAAmB,CACjB,OAAO,CAAC,EAAE,6BAA6B,EACvC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAE/B,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;IAEpC,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,GAAG,EACV,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B,qBAAqB,CACnB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAGhB,0BAA0B,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAA;IAEvC,0BAA0B,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,MAAM,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,iCAAiC,CAC/B,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAA;IAEvC,4BAA4B,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}

package/dist/settings/service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=service.js.map

package/dist/settings/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/settings/service.ts"],"names":[],"mappings":""}

package/dist/shared-context.d.ts

@@ -47,6 +47,10 @@ export type Context<TManager = unknown> = {
      * A string indicating the ID of the current transaction.
      */
     transactionId?: string;
+    /**
+     * A string indicating the ID of the current run.
+     */
+    runId?: string;
     /**
      * An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.
      */
@@ -67,5 +71,14 @@ export type Context<TManager = unknown> = {
      * preventReleaseEvents
      */
     preventReleaseEvents?: boolean;
+    /**
+     * A boolean value indicating whether the current workflow execution is being cancelled.
+     */
+    isCancelling?: boolean;
+    /**
+     * Weither or not a sub workflow cancellation is being triggered from a parent step.
+     * If true, the parent step will not be triggered by the sub workflow.
+     */
+    cancelingFromParentStep?: boolean;
 };
 //# sourceMappingURL=shared-context.d.ts.map

package/dist/shared-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared-context.d.ts","sourceRoot":"","sources":["../src/shared-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAErC,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACtD;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,IAAI,CAAA;IACpC,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;IACxE,aAAa,IAAI,IAAI,CAAA;IACrB,kBAAkB,CAAC,CAAC,EAClB,WAAW,EACP,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,GACjC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,IAAI,CAAA;CACR;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,QAAQ,GAAG,OAAO,IAAI;IACxC,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA"}
+{"version":3,"file":"shared-context.d.ts","sourceRoot":"","sources":["../src/shared-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAErC,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACtD;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,IAAI,CAAA;IACpC,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;IACxE,aAAa,IAAI,IAAI,CAAA;IACrB,kBAAkB,CAAC,CAAC,EAClB,WAAW,EACP,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,GACjC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,IAAI,CAAA;CACR;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,QAAQ,GAAG,OAAO,IAAI;IACxC,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAA;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC,CAAA"}

package/dist/stock-location/common.d.ts

@@ -99,7 +99,7 @@ export type StockLocationAddressDTO = {
      */
     postal_code?: string | null;
     /**
-     * The province of the stock location address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
      */
     province?: string | null;
     /**
@@ -273,8 +273,8 @@ export interface FilterableStockLocationProps extends BaseFilterable<FilterableS
  *     example: HD3-1G8
  *   province:
  *     type: string
- *     description: Stock location address' province
- *     example: Sinaloa
+ *     description: Stock location address' lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province
+ *     example: us-ca
  *   metadata:
  *     type: object
  *     description: An optional key-value map with additional details
@@ -302,7 +302,7 @@ export type StockLocationAddressInput = {
      */
     phone?: string | null;
     /**
-     * The province of the stock location address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
      */
     province?: string | null;
     /**

package/dist/stock-location/service.d.ts

@@ -27,6 +27,13 @@ export interface IStockLocationService extends IModuleService {
      *
      * To specify relations that should be retrieved within the stock locations:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const stockLocations = await stockLocationModuleService.listStockLocations(
      *   {
@@ -75,6 +82,13 @@ export interface IStockLocationService extends IModuleService {
      *
      * To specify relations that should be retrieved within the stock locations:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const [stockLocations, count] =
      *   await stockLocationModuleService.listandCountStockLocations(

package/dist/stock-location/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/stock-location/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,wBAAwB,EACxB,mCAAmC,EACnC,4BAA4B,EAC5B,uBAAuB,EACvB,gBAAgB,EAChB,wBAAwB,EACxB,+BAA+B,EAC/B,wBAAwB,EACzB,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,kBAAkB,CAChB,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,0BAA0B,CACxB,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAClB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAClB,KAAK,EAAE,wBAAwB,EAAE,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAClB,IAAI,EAAE,wBAAwB,EAAE,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAClB,IAAI,EAAE,wBAAwB,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAClB,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;;;;;;;;;;;OAiBG;IACH,wBAAwB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACtE,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACnE,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;OASG;IACH,0BAA0B,CACxB,QAAQ,EAAE,mCAAmC,EAC7C,MAAM,CAAC,EAAE,UAAU,CAAC,uBAAuB,CAAC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAA;IAErC;;;;;;;;;OASG;IACH,4BAA4B,CAC1B,IAAI,EAAE,+BAA+B,EAAE,EACvC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAA;IAErC;;;;;;;;;OASG;IACH,4BAA4B,CAC1B,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EACrB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/stock-location/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,wBAAwB,EACxB,mCAAmC,EACnC,4BAA4B,EAC5B,uBAAuB,EACvB,gBAAgB,EAChB,wBAAwB,EACxB,+BAA+B,EAC/B,wBAAwB,EACzB,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,kBAAkB,CAChB,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,0BAA0B,CACxB,QAAQ,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAClB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAClB,KAAK,EAAE,wBAAwB,EAAE,EACjC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAClB,IAAI,EAAE,wBAAwB,EAAE,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAClB,IAAI,EAAE,wBAAwB,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAClB,QAAQ,EAAE,4BAA4B,EACtC,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;;;;;;;;;;;OAiBG;IACH,wBAAwB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACtE,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACnE,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;OASG;IACH,0BAA0B,CACxB,QAAQ,EAAE,mCAAmC,EAC7C,MAAM,CAAC,EAAE,UAAU,CAAC,uBAAuB,CAAC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAA;IAErC;;;;;;;;;OASG;IACH,4BAA4B,CAC1B,IAAI,EAAE,+BAA+B,EAAE,EACvC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAA;IAErC;;;;;;;;;OASG;IACH,4BAA4B,CAC1B,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EACrB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}

package/dist/tax/common.d.ts

@@ -127,13 +127,17 @@ export interface TaxRegionDTO {
      */
     country_code: string;
     /**
-     * The province code of the tax region.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
      */
     province_code: string | null;
     /**
      * The ID of the tax region's parent tax region.
      */
     parent_id: string | null;
+    /**
+     * The ID of the tax provider for the region.
+     */
+    provider_id: string | null;
     /**
      * Holds custom data in key-value pairs.
      */
@@ -162,6 +166,7 @@ export interface TaxRegionDTO {
 export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRegionProps> {
     /**
      * Find tax regions based on currency and province codes through this search term.
+     * The province code is the lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      */
     q?: string;
     /**
@@ -173,7 +178,7 @@ export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRe
      */
     country_code?: string | string[] | OperatorMap<string>;
     /**
-     * Filter the tax regions by their province code.
+     * Filter the tax regions by their lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      */
     province_code?: string | string[] | OperatorMap<string>;
     /**
@@ -346,7 +351,7 @@ export interface TaxCalculationContext {
          */
         country_code: string;
         /**
-         * The province code.
+         * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
          */
         province_code?: string | null;
         /**
@@ -395,6 +400,27 @@ export interface TaxCalculationContext {
      * Whether the tax lines are calculated for an order return.
      */
     is_return?: boolean;
+    /**
+     * The shipping method details.
+     */
+    shipping_methods?: {
+        /**
+         * The associated shipping method's ID.
+         */
+        id: string;
+        /**
+         * The name of the shipping method.
+         */
+        name: string;
+        /**
+         * The associated shipping options's ID.
+         */
+        shipping_option_id: string;
+        /**
+         * The amount of the shipping method.
+         */
+        amount: number;
+    }[];
 }
 /**
  * The tax line details.
@@ -402,6 +428,8 @@ export interface TaxCalculationContext {
 interface TaxLineDTO {
     /**
      * The associated rate's ID.
+     * When integrating with a third-party, you don't need to provide it.
+     * This is mainly used for the built-in rates.
      */
     rate_id?: string;
     /**

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;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,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,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;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,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;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,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;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,cAAc,CAAA;IAE3B;;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;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,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;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,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,CAAA;IAEZ;;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"}
+{"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;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,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,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;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,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;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;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;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,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;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,cAAc,CAAA;IAE3B;;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;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,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;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,CAAA;IAED;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACjB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QAEV;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAA;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAA;KACf,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;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,4 +1,7 @@
 import { MetadataType } from "../common";
+import { BaseFilterable } from "../dal";
+import { OperatorMap } from "../dal";
+import { TaxProviderDTO } from "./common";
 /**
  * The tax rate to be created.
  */
@@ -40,6 +43,32 @@ export interface CreateTaxRateDTO {
      */
     metadata?: MetadataType;
 }
+/**
+ * The tax provider to be created.
+ */
+export interface CreateTaxProviderDTO {
+    /**
+     * The provider's ID.
+     */
+    id: string;
+    /**
+     * Whether the provider is enabled.
+     */
+    is_enabled?: boolean;
+}
+/**
+ * The filters to apply on the retrieved tax providers.
+ */
+export interface FilterableTaxProviderProps extends BaseFilterable<TaxProviderDTO> {
+    /**
+     * The IDs to filter the tax provider by.
+     */
+    id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter by whether the tax provider is enabled.
+     */
+    is_enabled?: boolean;
+}
 /**
  * The attributes in the tax rate to be created or updated.
  */
@@ -132,13 +161,17 @@ export interface CreateTaxRegionDTO {
      */
     country_code: string;
     /**
-     * The province code of the tax region.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
      */
     province_code?: string | null;
     /**
      * The ID of the tax region's parent.
      */
     parent_id?: string | null;
+    /**
+     * The ID of the tax provider for the region.
+     */
+    provider_id?: string | null;
     /**
      * Holds custom data in key-value pairs.
      */
@@ -182,9 +215,13 @@ export interface UpdateTaxRegionDTO {
      */
     id: string;
     /**
-     * The province code of the tax region.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
      */
     province_code?: string | null;
+    /**
+     * The ID of the tax provider for the region.
+     */
+    provider_id?: string | null;
     /**
      * Holds custom data in key-value pairs.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExC;;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,YAAY,CAAA;CACxB;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,YAAY,CAAA;CACxB;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,YAAY,CAAA;CACxB;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,YAAY,CAAA;IAEvB;;;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,YAAY,CAAA;KACxB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;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,YAAY,CAAA;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEzC;;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,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,cAAc,CAAC;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;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,YAAY,CAAA;CACxB;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,YAAY,CAAA;CACxB;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,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IAEvB;;;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,YAAY,CAAA;KACxB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;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,YAAY,CAAA;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}

package/dist/tax/provider.d.ts

@@ -32,7 +32,9 @@ export type ItemTaxCalculationLine = {
  *
  * ### Identifier Property
  *
- * The `identifier` property in a tax provider is used when the tax provider is loaded by the Tax Module and added to the database. A tax provider is represented in the database by the `TaxProvider` data model.
+ * Each tax provider has a unique identifier defined in its class. The provider's ID
+ * will be stored as `tp_{identifier}_{id}`, where `{id}` is the provider's `id`
+ * property in the `medusa-config.ts`.
  *
  * For example:
  *
@@ -45,7 +47,7 @@ export type ItemTaxCalculationLine = {
  *
  * ### constructor
  *
- * You can use the `constructor` of your tax provider to access the resources registered in the [Module Container](https://docs.medusajs.com/resources/medusa-container-resources#module-container-resources).
+ * You can use the `constructor` of your Tax Module Provider's service to access the resources registered in the [Module Container](https://docs.medusajs.com/resources/medusa-container-resources#module-container-resources).
  *
  * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.
  *
@@ -54,13 +56,34 @@ export type ItemTaxCalculationLine = {
  * For example:
  *
  * ```ts
+ * import {
+ *   ITaxProvider,
+ *   Logger
+ * } from "@medusajs/framework/types"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
  * export default class MyTaxProvider implements ITaxProvider {
- *   // ...
- *   constructor(container, options) {
- *     // you can access options here
+ *   static identifier = "my-tax"
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   // assuming you're initializing a client
+ *   protected client
  *
- *     // you can also initialize a client that
- *     // communicates with a third-party service.
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
  *     this.client = new Client(options)
  *   }
  * }
@@ -70,7 +93,18 @@ export type ItemTaxCalculationLine = {
  */
 export interface ITaxProvider {
     /**
-     * @ignore
+     * This method is used to retrieve the unique identifier of the tax provider.
+     *
+     * @return {string} The unique identifier of the tax provider.
+     *
+     * @example
+     * export default class MyTaxProvider implements ITaxProvider {
+     *   static identifier = "my-tax"
+     *
+     *   getIdentifier(): string {
+     *     return MyTaxProvider.identifier
+     *   }
+     * }
      */
     getIdentifier(): string;
     /**
@@ -102,8 +136,8 @@ export interface ITaxProvider {
      *     let taxLines: (TaxTypes.ItemTaxLineDTO | TaxTypes.ShippingTaxLineDTO)[] =
      *       itemLines.flatMap((l) => {
      *         return l.rates.map((r) => ({
-     *           rate_id: r.id,
-     *           rate: r.rate || 0,
+     *           rate_id: r.id, // this is optional. When integrating with a third-party, you don't need to provide it
+     *           rate: r.rate || 0, // For example, 10 for 10%
      *           name: r.name,
      *           code: r.code,
      *           line_item_id: l.line_item.id,
@@ -114,8 +148,8 @@ export interface ITaxProvider {
      *     taxLines = taxLines.concat(
      *       shippingLines.flatMap((l) => {
      *         return l.rates.map((r) => ({
-     *           rate_id: r.id,
-     *           rate: r.rate || 0,
+     *           rate_id: r.id, // this is optional. When integrating with a third-party, you don't need to provide it
+     *           rate: r.rate || 0, // For example, 10 for 10%
      *           name: r.name,
      *           code: r.code,
      *           shipping_line_id: l.shipping_line.id,

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

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/tax/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACX,MAAM,UAAU,CAAA;AAEjB;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,cAAc,CAAA;IACzB;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,WAAW,CACT,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,EAAE,0BAA0B,EAAE,EAC3C,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAA;CACpD"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/tax/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACX,MAAM,UAAU,CAAA;AAEjB;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,cAAc,CAAA;IACzB;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,WAAW,CACT,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,EAAE,0BAA0B,EAAE,EAC3C,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAA;CACpD"}