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

package/dist/tax/service.d.ts

@@ -4,35 +4,635 @@ import { IModuleService } from "../modules-sdk";
 import { Context } from "../shared-context";
 import { FilterableTaxRegionProps, FilterableTaxRateProps, TaxRateDTO, TaxRegionDTO, TaxRateRuleDTO, FilterableTaxRateRuleProps, TaxableItemDTO, TaxCalculationContext, ItemTaxLineDTO, ShippingTaxLineDTO, TaxableShippingDTO } from "./common";
 import { CreateTaxRateRuleDTO, CreateTaxRateDTO, CreateTaxRegionDTO, UpdateTaxRateDTO, UpsertTaxRateDTO } from "./mutations";
+/**
+ * The main service interface for the Tax Module.
+ */
 export interface ITaxModuleService extends IModuleService {
+    /**
+     * This method retrieves a tax by its ID.
+     *
+     * @param {string} taxRateId - The tax rate's ID.
+     * @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO>} The retrieved tax.
+     *
+     * @example
+     * A simple example that retrieves a tax rate by its ID:
+     *
+     * ```ts
+     * const taxRate = await taxModuleService.retrieve("txr_123")
+     * ```
+     *
+     * To specify relations that should be retrieved:
+     *
+     * ```ts
+     * const taxRate = await taxModuleService.retrieve("txr_123", {
+     *   relations: ["tax_region"],
+     * })
+     * ```
+     */
     retrieve(taxRateId: string, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<TaxRateDTO>;
+    /**
+     * This method retrieves a paginated list of tax rates based on optional filters and configuration.
+     *
+     * @param {FilterableTaxRateProps} filters - The filters to apply on the retrieved tax rates.
+     * @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO[]>} The list of tax rates.
+     *
+     * @example
+     * To retrieve a list of tax rates using their IDs:
+     *
+     * ```ts
+     * const taxRates = await taxModuleService.list({
+     *   id: ["txr_123", "txr_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the tax rate:
+     *
+     * ```ts
+     * const taxRates = await taxModuleService.list(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_region"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const taxRates = await taxModuleService.list(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_region"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
     list(filters?: FilterableTaxRateProps, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<TaxRateDTO[]>;
+    /**
+     * This method retrieves a paginated list of tax rates along with the total count of available tax rates satisfying the provided filters.
+     *
+     * @param {FilterableTaxRateProps} filters - The filters to apply on the retrieved tax rates.
+     * @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[TaxRateDTO[], number]>} The list of tax rates along with their total count.
+     *
+     * @example
+     * To retrieve a list of tax rates using their IDs:
+     *
+     * ```ts
+     * const [taxRates, count] = await taxModuleService.listAndCount(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   }
+     * )
+     * ```
+     *
+     * To specify relations that should be retrieved within the tax rate:
+     *
+     * ```ts
+     * const [taxRates, count] = await taxModuleService.listAndCount(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_region"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [taxRates, count] = await taxModuleService.listAndCount(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_region"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
     listAndCount(filters?: FilterableTaxRateProps, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<[TaxRateDTO[], number]>;
+    /**
+     * This method creates tax rates.
+     *
+     * @param {CreateTaxRateDTO[]} data - The tax rates to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO[]>} The created tax rates.
+     *
+     * @example
+     * const taxRates = await taxModuleService.create([
+     *   {
+     *     tax_region_id: "txreg_123",
+     *     name: "Default rate",
+     *     rate: 10,
+     *   },
+     *   {
+     *     tax_region_id: "txreg_123",
+     *     name: "Custom rate",
+     *     rate: 15,
+     *     rules: [
+     *       {
+     *         reference: "product_type",
+     *         reference_id: "ptyp_1",
+     *       },
+     *       {
+     *         reference: "product",
+     *         reference_id: "prod_123",
+     *       },
+     *     ],
+     *   },
+     * ])
+     */
     create(data: CreateTaxRateDTO[], sharedContext?: Context): Promise<TaxRateDTO[]>;
+    /**
+     * This method creates a tax rate.
+     *
+     * @param {CreateTaxRateDTO} data - The tax rate to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO>} The created tax rate.
+     *
+     * @example
+     * const taxRate = await taxModuleService.create({
+     *   tax_region_id: "txreg_123",
+     *   name: "Default rate",
+     *   rate: 10,
+     * })
+     */
     create(data: CreateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
+    /**
+     * This method updates an existing tax rate.
+     *
+     * @param {string} taxRateId - The tax rate's ID.
+     * @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO>} The updated tax rate.
+     *
+     * @example
+     * const taxRate = await taxModuleService.update("txr_123", {
+     *   rate: 10,
+     * })
+     */
     update(taxRateId: string, data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
+    /**
+     * This method updates existing tax rates.
+     *
+     * @param {string[]} taxRateIds - The IDs of tax rates to update.
+     * @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO[]>} The updated tax rates.
+     *
+     * @example
+     * const taxRates = await taxModuleService.update(
+     *   ["txr_123", "txr_321"],
+     *   {
+     *     rate: 10,
+     *   }
+     * )
+     */
     update(taxRateIds: string[], data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO[]>;
+    /**
+     * This method updates existing tax rates matching the specified filters.
+     *
+     * @param {FilterableTaxRateProps} selector - The filters specifying which tax rates to update.
+     * @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO[]>} The updated tax rates.
+     *
+     * @example
+     * const taxRates = await taxModuleService.update(
+     *   {
+     *     id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     rate: 10,
+     *   }
+     * )
+     */
     update(selector: FilterableTaxRateProps, data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO[]>;
+    /**
+     * This method updates or creates a tax rate if it doesn't exist.
+     *
+     * @param {UpsertTaxRateDTO} data - The attributes in the tax rate to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO>} The created or updated tax rate.
+     *
+     * @example
+     * const taxRate = await taxModuleService.upsert({
+     *   id: "txr_123",
+     *   rate: 10,
+     * })
+     */
     upsert(data: UpsertTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
+    /**
+     * This method updates or creates tax rates if they don't exist.
+     *
+     * @param {UpsertTaxRateDTO[]} data - The attributes in the tax rates to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateDTO[]>} The created or updated tax rates.
+     *
+     * @example
+     * const taxRates = await taxModuleService.upsert([
+     *   {
+     *     id: "txr_123",
+     *     rate: 10,
+     *   },
+     * ])
+     */
     upsert(data: UpsertTaxRateDTO[], sharedContext?: Context): Promise<TaxRateDTO[]>;
+    /**
+     * This method deletes tax rates by their IDs.
+     *
+     * @param {string[]} taxRateIds - The IDs of tax rates to delete.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax rates are deleted successfully.
+     *
+     * @example
+     * await taxModuleService.delete(["txr_123", "txr_321"])
+     */
     delete(taxRateIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes a tax rate by its ID.
+     *
+     * @param {string} taxRateId - The tax rate's ID.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax rate is deleted successfully.
+     *
+     * @example
+     * await taxModuleService.delete("txr_123")
+     */
     delete(taxRateId: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method restores soft deleted tax rates by their IDs.
+     *
+     * @param {string[]} taxRateIds - The IDs of the tax rates.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
+     * property any of the tax rate's relation attribute names, such as `rules`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated rules.
+     * The object's keys are the ID attribute names of the tax rate entity's relations, such as `rule_id`,
+     * and its value is an array of strings, each being the ID of the record associated with the tax rate through this relation,
+     * such as the IDs of associated rules.
+     *
+     * If there are no related records restored, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.restore(["txr_123", "txr_321"])
+     */
     restore<TReturnableLinkableKeys extends string = string>(taxRateIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method creates a tax region.
+     *
+     * @param {CreateTaxRegionDTO} data - The tax region to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRegionDTO>} The created tax region.
+     *
+     * @example
+     * const taxRegion = await taxModuleService.createTaxRegions({
+     *   country_code: "us",
+     * })
+     */
     createTaxRegions(data: CreateTaxRegionDTO, sharedContext?: Context): Promise<TaxRegionDTO>;
+    /**
+     * This method creates tax regions.
+     *
+     * @param {CreateTaxRegionDTO[]} data - The tax regions to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRegionDTO[]>} The created tax regions.
+     *
+     * @example
+     * const taxRegions = await taxModuleService.createTaxRegions([
+     *   {
+     *     country_code: "us",
+     *   },
+     *   {
+     *     country_code: "gb",
+     *   },
+     * ])
+     */
     createTaxRegions(data: CreateTaxRegionDTO[], sharedContext?: Context): Promise<TaxRegionDTO[]>;
+    /**
+     * This method deletes tax regions by their IDs.
+     *
+     * @param {string[]} taxRegionIds - The IDs of the tax regions.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax regions are deleted.
+     *
+     * @example
+     * await taxModuleService.deleteTaxRegions([
+     *   "txreg_123",
+     *   "txreg_321",
+     * ])
+     */
     deleteTaxRegions(taxRegionIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes a tax region by its ID.
+     *
+     * @param {string} taxRegionId - The tax region's ID.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax region is successfully deleted.
+     *
+     * @example
+     * await taxModuleService.deleteTaxRegions("txreg_123")
+     */
     deleteTaxRegions(taxRegionId: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves a paginated list of tax regions based on optional filters and configuration.
+     *
+     * @param {FilterableTaxRegionProps} filters - The filters to apply on the retrieved tax regions.
+     * @param {FindConfig<TaxRegionDTO>} config - The configurations determining how the tax region is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a tax region.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRegionDTO[]>} The list of tax regions.
+     *
+     * @example
+     * To retrieve a list of tax regions using their IDs:
+     *
+     * ```ts
+     * const taxRegions = await taxModuleService.listTaxRegions({
+     *   id: ["txreg_123", "txreg_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the tax region:
+     *
+     * ```ts
+     * const taxRegions = await taxModuleService.listTaxRegions(
+     *   {
+     *     id: ["txreg_123", "txreg_321"],
+     *   },
+     *   {
+     *     relations: ["tax_rates"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const taxRegions = await taxModuleService.listTaxRegions(
+     *   {
+     *     id: ["txreg_123", "txreg_321"],
+     *   },
+     *   {
+     *     relations: ["tax_rates"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
     listTaxRegions(filters?: FilterableTaxRegionProps, config?: FindConfig<TaxRegionDTO>, sharedContext?: Context): Promise<TaxRegionDTO[]>;
+    /**
+     * This method creates a tax rate rule.
+     *
+     * @param {CreateTaxRateRuleDTO} data - The tax rate rule to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateRuleDTO>} The created tax rate rule.
+     *
+     * @example
+     * const taxRateRule = await taxModuleService.createTaxRateRules(
+     *   {
+     *     reference: "product_type",
+     *     reference_id: "ptyp_123",
+     *     tax_rate_id: "txr_123",
+     *   }
+     * )
+     */
     createTaxRateRules(data: CreateTaxRateRuleDTO, sharedContext?: Context): Promise<TaxRateRuleDTO>;
+    /**
+     * This method creates tax rate rules.
+     *
+     * @param {CreateTaxRateRuleDTO[]} data - The tax rate rules to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateRuleDTO[]>} The created tax rate rules.
+     *
+     * @example
+     * const taxRateRules =
+     *   await taxModuleService.createTaxRateRules([
+     *     {
+     *       reference: "product_type",
+     *       reference_id: "ptyp_123",
+     *       tax_rate_id: "txr_123",
+     *     },
+     *     {
+     *       reference: "product",
+     *       reference_id: "prod_123",
+     *       tax_rate_id: "txr_321",
+     *     },
+     *   ])
+     */
     createTaxRateRules(data: CreateTaxRateRuleDTO[], sharedContext?: Context): Promise<TaxRateRuleDTO[]>;
+    /**
+     * This method deletes a tax rate rule by its ID.
+     *
+     * @param {string} taxRateRuleId - The tax rate rule's ID.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax rate rule is deleted successfully.
+     *
+     * @example
+     * await taxModuleService.deleteTaxRateRules("txrule_123")
+     */
     deleteTaxRateRules(taxRateRuleId: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes tax rate rules by their IDs.
+     *
+     * @param {string[]} taxRateRuleIds - The tax rate rules' IDs.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the tax rate rules are deleted successfully.
+     *
+     * @example
+     * await taxModuleService.deleteTaxRateRules([
+     *   "txrule_123",
+     *   "txrule_321",
+     * ])
+     */
     deleteTaxRateRules(taxRateRuleIds: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves a paginated list of tax rate rules based on optional filters and configuration.
+     *
+     * @param {FilterableTaxRateRuleProps} filters - The filters to apply on the retrieved tax rate rules.
+     * @param {FindConfig<TaxRateRuleDTO>} config - The configurations determining how the tax rate rule is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a tax rate rule.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<TaxRateRuleDTO[]>} The list of tax rate rules.
+     *
+     * @example
+     * To retrieve a list of tax rate rules using their associated tax rate's ID:
+     *
+     * ```ts
+     * const taxRateRules = await taxModuleService.listTaxRateRules({
+     *   tax_rate_id: ["txr_123", "txr_321"],
+     * })
+     * ```
+     *
+     * To specify relations that should be retrieved within the tax rate rule:
+     *
+     * ```ts
+     * const taxRateRules = await taxModuleService.listTaxRateRules(
+     *   {
+     *     tax_rate_id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_rate"],
+     *   }
+     * )
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const taxRateRules = await taxModuleService.listTaxRateRules(
+     *   {
+     *     tax_rate_id: ["txr_123", "txr_321"],
+     *   },
+     *   {
+     *     relations: ["tax_rate"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
     listTaxRateRules(filters?: FilterableTaxRateRuleProps, config?: FindConfig<TaxRateRuleDTO>, sharedContext?: Context): Promise<TaxRateRuleDTO[]>;
+    /**
+     * This method retrieves tax lines for taxable items and shipping methods in a cart.
+     *
+     * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-calculation-with-provider/).
+     *
+     * @param {(TaxableItemDTO | TaxableShippingDTO)[]} items - The items and shipping methods to retrieve their tax lines.
+     * @param {TaxCalculationContext} calculationContext - The context to pass to the underlying tax provider. It provides more
+     * details that are useful to provide accurate tax lines.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>} The item and shipping methods' tax lines.
+     *
+     * @example
+     * const taxLines = await taxModuleService.getTaxLines(
+     *   [
+     *     {
+     *       id: "cali_123",
+     *       product_id: "prod_123",
+     *       unit_price: 1000,
+     *       quantity: 1,
+     *     },
+     *     {
+     *       id: "casm_123",
+     *       shipping_option_id: "so_123",
+     *       unit_price: 2000,
+     *     },
+     *   ],
+     *   {
+     *     address: {
+     *       country_code: "us",
+     *     },
+     *   }
+     * )
+     */
     getTaxLines(items: (TaxableItemDTO | TaxableShippingDTO)[], calculationContext: TaxCalculationContext, sharedContext?: Context): Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>;
+    /**
+     * This method soft deletes tax raes by their IDs.
+     *
+     * @param {string[]} taxRateIds - The IDs of the tax rates.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated rules.
+     * The object's keys are the ID attribute names of the tax rate entity's relations, such as `rule_id`, and its value is an array of strings, each being the ID of a record associated
+     * with the tax rate through this relation, such as the IDs of associated rules.
+     *
+     * If there are no related records, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.softDelete(["txr_123", "txr_321"])
+     */
     softDelete<TReturnableLinkableKeys extends string = string>(taxRateIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method soft deletes tax regions by their IDs.
+     *
+     * @param {string[]} taxRegionIds - The IDs of the tax regions.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated tax rates.
+     * The object's keys are the ID attribute names of the tax region entity's relations, such as `tax_rate_id`, and its value is an array of strings, each being the ID of a record associated
+     * with the tax region through this relation, such as the IDs of associated tax rates.
+     *
+     * If there are no related records, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.softDeleteTaxRegions([
+     *   "txreg_123",
+     *   "txreg_321",
+     * ])
+     */
     softDeleteTaxRegions<TReturnableLinkableKeys extends string = string>(taxRegionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method restores soft deleted tax regions by their IDs.
+     *
+     * @param {string[]} taxRegionIds - The IDs of the tax regions.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
+     * property any of the tax region's relation attribute names, such as `tax_rates`.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated tax rates.
+     * The object's keys are the ID attribute names of the tax region entity's relations, such as `tax_rate_id`,
+     * and its value is an array of strings, each being the ID of the record associated with the tax region through this relation,
+     * such as the IDs of associated tax rates.
+     *
+     * If there are no related records restored, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.restoreTaxRegions([
+     *   "txreg_123",
+     *   "txreg_321",
+     * ])
+     */
     restoreTaxRegions<TReturnableLinkableKeys extends string = string>(taxRegionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method soft deletes tax rate rules by their IDs.
+     *
+     * @param {string[]} taxRateRuleIds - The IDs of the tax rate rules.
+     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
+     * If there are no related records, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.softDeleteTaxRateRules([
+     *   "txrule_123",
+     *   "txrule_321",
+     * ])
+     */
     softDeleteTaxRateRules<TReturnableLinkableKeys extends string = string>(taxRateRuleIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
+    /**
+     * This method restores soft deleted tax rate rules by their IDs.
+     *
+     * @param {string[]} taxRateRuleIds - The IDs of the tax rate rules.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
+     * property any of the tax rate rule's relation attribute names.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
+     * If there are no related records restored, the promise resolves to `void`.
+     *
+     * @example
+     * await taxModuleService.restoreTaxRateRules([
+     *   "txrule_123",
+     *   "txrule_321",
+     * ])
+     */
     restoreTaxRateRules<TReturnableLinkableKeys extends string = string>(taxRateRuleIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
 }
 //# sourceMappingURL=service.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/tax/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,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,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB,IAAI,CACF,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB,YAAY,CACV,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAElC,MAAM,CACJ,IAAI,EAAE,gBAAgB,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IACxB,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5E,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IACtB,MAAM,CACJ,UAAU,EAAE,MAAM,EAAE,EACpB,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IACxB,MAAM,CACJ,QAAQ,EAAE,sBAAsB,EAChC,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAC5E,MAAM,CACJ,IAAI,EAAE,gBAAgB,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,UAAU,EAAE,MAAM,EAAE,EACpB,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,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IACxB,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B,gBAAgB,CACd,YAAY,EAAE,MAAM,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E,cAAc,CACZ,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B,kBAAkB,CAChB,IAAI,EAAE,oBAAoB,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,CAAC,CAAA;IAC1B,kBAAkB,CAChB,IAAI,EAAE,oBAAoB,EAAE,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B,kBAAkB,CAChB,aAAa,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,kBAAkB,CAChB,cAAc,EAAE,MAAM,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,gBAAgB,CACd,OAAO,CAAC,EAAE,0BAA0B,EACpC,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B,WAAW,CACT,KAAK,EAAE,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,EAC9C,kBAAkB,EAAE,qBAAqB,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAA;IAEnD,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,UAAU,EAAE,MAAM,EAAE,EACpB,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,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,YAAY,EAAE,MAAM,EAAE,EACtB,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,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,YAAY,EAAE,MAAM,EAAE,EACtB,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,sBAAsB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACpE,cAAc,EAAE,MAAM,EAAE,EACxB,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,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,cAAc,EAAE,MAAM,EAAE,EACxB,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;CAC5C"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/tax/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,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,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,aAAa,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CACJ,IAAI,EAAE,gBAAgB,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5E;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAAE,EACpB,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,QAAQ,EAAE,sBAAsB,EAChC,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAI,EAAE,gBAAgB,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,UAAU,EAAE,MAAM,EAAE,EACpB,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;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,YAAY,EAAE,MAAM,EAAE,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAChB,IAAI,EAAE,oBAAoB,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,CAChB,IAAI,EAAE,oBAAoB,EAAE,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B;;;;;;;;;OASG;IACH,kBAAkB,CAChB,aAAa,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,cAAc,EAAE,MAAM,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,gBAAgB,CACd,OAAO,CAAC,EAAE,0BAA0B,EACpC,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,WAAW,CACT,KAAK,EAAE,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,EAC9C,kBAAkB,EAAE,qBAAqB,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAA;IAEnD;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,UAAU,EAAE,MAAM,EAAE,EACpB,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;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,YAAY,EAAE,MAAM,EAAE,EACtB,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,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,YAAY,EAAE,MAAM,EAAE,EACtB,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;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACpE,cAAc,EAAE,MAAM,EAAE,EACxB,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;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,cAAc,EAAE,MAAM,EAAE,EACxB,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;CAC5C"}

package/dist/workflow/index.d.ts

@@ -4,5 +4,6 @@ export * as ProductWorkflow from "./product";
 export * as InventoryWorkflow from "./inventory";
 export * as PriceListWorkflow from "./price-list";
 export * as UserWorkflow from "./user";
+export * as RegionWorkflow from "./region";
 export * as InviteWorkflow from "./invite";
 //# sourceMappingURL=index.d.ts.map

package/dist/workflow/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workflow/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,cAAc,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,eAAe,MAAM,WAAW,CAAA;AAC5C,OAAO,KAAK,iBAAiB,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,iBAAiB,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,cAAc,MAAM,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workflow/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,cAAc,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,eAAe,MAAM,WAAW,CAAA;AAC5C,OAAO,KAAK,iBAAiB,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,iBAAiB,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,cAAc,MAAM,UAAU,CAAA;AAC1C,OAAO,KAAK,cAAc,MAAM,UAAU,CAAA"}