@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240406075900
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/auth/common/auth-user.d.ts +21 -16
- package/dist/auth/common/auth-user.d.ts.map +1 -1
- package/dist/auth/common/provider.d.ts +28 -15
- package/dist/auth/common/provider.d.ts.map +1 -1
- package/dist/auth/service.d.ts +137 -75
- package/dist/auth/service.d.ts.map +1 -1
- package/dist/bundles.d.ts +2 -0
- package/dist/bundles.d.ts.map +1 -1
- package/dist/bundles.js +3 -1
- package/dist/bundles.js.map +1 -1
- package/dist/cart/common.d.ts +443 -62
- package/dist/cart/common.d.ts.map +1 -1
- package/dist/cart/mutations.d.ts +483 -0
- package/dist/cart/mutations.d.ts.map +1 -1
- package/dist/cart/mutations.js.map +1 -1
- package/dist/cart/service.d.ts +1607 -0
- package/dist/cart/service.d.ts.map +1 -1
- package/dist/common/index.d.ts +1 -0
- package/dist/common/index.d.ts.map +1 -1
- package/dist/common/index.js +1 -0
- package/dist/common/index.js.map +1 -1
- package/dist/common/rule.d.ts +2 -0
- package/dist/common/rule.d.ts.map +1 -0
- package/dist/common/rule.js +3 -0
- package/dist/common/rule.js.map +1 -0
- package/dist/customer/service.d.ts +445 -197
- package/dist/customer/service.d.ts.map +1 -1
- package/dist/file/common.d.ts +14 -0
- package/dist/file/common.d.ts.map +1 -0
- package/dist/file/common.js +3 -0
- package/dist/file/common.js.map +1 -0
- package/dist/file/index.d.ts +4 -0
- package/dist/file/index.d.ts.map +1 -0
- package/dist/file/index.js +20 -0
- package/dist/file/index.js.map +1 -0
- package/dist/file/mutations.d.ts +18 -0
- package/dist/file/mutations.d.ts.map +1 -0
- package/dist/file/mutations.js +3 -0
- package/dist/file/mutations.js.map +1 -0
- package/dist/file/service.d.ts +76 -0
- package/dist/file/service.d.ts.map +1 -0
- package/dist/file/service.js +3 -0
- package/dist/file/service.js.map +1 -0
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts +2 -2
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/fulfillment-address.d.ts +22 -0
- package/dist/http/fulfillment/admin/fulfillment-address.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-address.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment-address.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-item.d.ts +17 -0
- package/dist/http/fulfillment/admin/fulfillment-item.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-item.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment-item.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-label.d.ts +14 -0
- package/dist/http/fulfillment/admin/fulfillment-label.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-label.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment-label.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-provider.d.ts +12 -0
- package/dist/http/fulfillment/admin/fulfillment-provider.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-provider.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment-provider.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-set.d.ts +15 -0
- package/dist/http/fulfillment/admin/fulfillment-set.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-set.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment-set.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment.d.ts +27 -0
- package/dist/http/fulfillment/admin/fulfillment.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment.js +3 -0
- package/dist/http/fulfillment/admin/fulfillment.js.map +1 -0
- package/dist/http/fulfillment/admin/geo-zone.d.ts +17 -0
- package/dist/http/fulfillment/admin/geo-zone.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/geo-zone.js +3 -0
- package/dist/http/fulfillment/admin/geo-zone.js.map +1 -0
- package/dist/http/fulfillment/admin/index.d.ts +13 -0
- package/dist/http/fulfillment/admin/index.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/index.js +29 -0
- package/dist/http/fulfillment/admin/index.js.map +1 -0
- package/dist/http/fulfillment/admin/service-zone.d.ts +14 -0
- package/dist/http/fulfillment/admin/service-zone.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/service-zone.js +3 -0
- package/dist/http/fulfillment/admin/service-zone.js.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option-rule.d.ts +16 -0
- package/dist/http/fulfillment/admin/shipping-option-rule.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option-rule.js +3 -0
- package/dist/http/fulfillment/admin/shipping-option-rule.js.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option-type.d.ts +14 -0
- package/dist/http/fulfillment/admin/shipping-option-type.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option-type.js +3 -0
- package/dist/http/fulfillment/admin/shipping-option-type.js.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option.d.ts +31 -0
- package/dist/http/fulfillment/admin/shipping-option.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/shipping-option.js +3 -0
- package/dist/http/fulfillment/admin/shipping-option.js.map +1 -0
- package/dist/http/fulfillment/admin/shipping-profile.d.ts +13 -0
- package/dist/http/fulfillment/admin/shipping-profile.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/shipping-profile.js +3 -0
- package/dist/http/fulfillment/admin/shipping-profile.js.map +1 -0
- package/dist/http/fulfillment/index.d.ts +2 -0
- package/dist/http/fulfillment/index.d.ts.map +1 -0
- package/dist/http/fulfillment/index.js +18 -0
- package/dist/http/fulfillment/index.js.map +1 -0
- package/dist/http/index.d.ts +3 -0
- package/dist/http/index.d.ts.map +1 -0
- package/dist/http/index.js +19 -0
- package/dist/http/index.js.map +1 -0
- package/dist/http/stock-locations/common.d.ts +28 -0
- package/dist/http/stock-locations/common.d.ts.map +1 -0
- package/dist/http/stock-locations/common.js +3 -0
- package/dist/http/stock-locations/common.js.map +1 -0
- package/dist/http/stock-locations/index.d.ts +2 -0
- package/dist/http/stock-locations/index.d.ts.map +1 -0
- package/dist/http/stock-locations/index.js +18 -0
- package/dist/http/stock-locations/index.js.map +1 -0
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -1
- package/dist/index.js.map +1 -1
- package/dist/inventory/common/inventory-item.d.ts +55 -64
- package/dist/inventory/common/inventory-item.d.ts.map +1 -1
- package/dist/inventory/common/inventory-level.d.ts +37 -37
- package/dist/inventory/common/inventory-level.d.ts.map +1 -1
- package/dist/inventory/common/reservation-item.d.ts +34 -44
- package/dist/inventory/common/reservation-item.d.ts.map +1 -1
- package/dist/inventory/service-next.d.ts +596 -534
- package/dist/inventory/service-next.d.ts.map +1 -1
- package/dist/payment/common.d.ts +174 -53
- package/dist/payment/common.d.ts.map +1 -1
- package/dist/payment/common.js +3 -3
- package/dist/payment/common.js.map +1 -1
- package/dist/payment/mutations.d.ts +58 -17
- package/dist/payment/mutations.d.ts.map +1 -1
- package/dist/payment/provider.d.ts +128 -43
- package/dist/payment/provider.d.ts.map +1 -1
- package/dist/payment/provider.js.map +1 -1
- package/dist/payment/service.d.ts +460 -39
- package/dist/payment/service.d.ts.map +1 -1
- package/dist/pricing/common/price-list.d.ts +2 -2
- package/dist/pricing/common/price-set.d.ts +6 -4
- package/dist/pricing/common/price-set.d.ts.map +1 -1
- package/dist/pricing/service.d.ts +731 -1695
- package/dist/pricing/service.d.ts.map +1 -1
- package/dist/product/common.d.ts +4 -0
- package/dist/product/common.d.ts.map +1 -1
- package/dist/product-category/repository.d.ts +2 -1
- package/dist/product-category/repository.d.ts.map +1 -1
- package/dist/promotion/common/application-method.d.ts +153 -0
- package/dist/promotion/common/application-method.d.ts.map +1 -1
- package/dist/promotion/common/campaign-budget.d.ts +37 -0
- package/dist/promotion/common/campaign-budget.d.ts.map +1 -1
- package/dist/promotion/common/campaign.d.ts +36 -0
- package/dist/promotion/common/campaign.d.ts.map +1 -1
- package/dist/promotion/common/compute-actions.d.ts +135 -0
- package/dist/promotion/common/compute-actions.d.ts.map +1 -1
- package/dist/promotion/common/promotion-rule-value.d.ts +30 -0
- package/dist/promotion/common/promotion-rule-value.d.ts.map +1 -1
- package/dist/promotion/common/promotion-rule.d.ts +77 -0
- package/dist/promotion/common/promotion-rule.d.ts.map +1 -1
- package/dist/promotion/common/promotion.d.ts +100 -0
- package/dist/promotion/common/promotion.d.ts.map +1 -1
- package/dist/promotion/mutations.d.ts +84 -0
- package/dist/promotion/mutations.d.ts.map +1 -1
- package/dist/promotion/service.d.ts +786 -0
- package/dist/promotion/service.d.ts.map +1 -1
- package/dist/region/common.d.ts +9 -0
- package/dist/region/common.d.ts.map +1 -1
- package/dist/region/mutations.d.ts +11 -3
- package/dist/region/mutations.d.ts.map +1 -1
- package/dist/region/service.d.ts +210 -85
- package/dist/region/service.d.ts.map +1 -1
- package/dist/stock-location/common.d.ts +14 -0
- package/dist/stock-location/common.d.ts.map +1 -1
- package/dist/stock-location/service-next.d.ts +178 -186
- package/dist/stock-location/service-next.d.ts.map +1 -1
- package/dist/store/common/store.d.ts +42 -0
- package/dist/store/common/store.d.ts.map +1 -1
- package/dist/store/mutations/store.d.ts +75 -0
- package/dist/store/mutations/store.d.ts.map +1 -1
- package/dist/store/service.d.ts +113 -75
- package/dist/store/service.d.ts.map +1 -1
- package/dist/tax/common.d.ts +298 -10
- package/dist/tax/common.d.ts.map +1 -1
- package/dist/tax/mutations.d.ts +157 -0
- package/dist/tax/mutations.d.ts.map +1 -1
- package/dist/tax/provider.d.ts +126 -0
- package/dist/tax/provider.d.ts.map +1 -1
- package/dist/tax/service.d.ts +600 -0
- package/dist/tax/service.d.ts.map +1 -1
- package/dist/workflows/index.d.ts +2 -0
- package/dist/workflows/index.d.ts.map +1 -0
- package/dist/workflows/index.js +18 -0
- package/dist/workflows/index.js.map +1 -0
- package/dist/workflows/stock-locations/index.d.ts +2 -0
- package/dist/workflows/stock-locations/index.d.ts.map +1 -0
- package/dist/workflows/stock-locations/index.js +18 -0
- package/dist/workflows/stock-locations/index.js.map +1 -0
- package/dist/workflows/stock-locations/mutations.d.ts +8 -0
- package/dist/workflows/stock-locations/mutations.d.ts.map +1 -0
- package/dist/workflows/stock-locations/mutations.js +3 -0
- package/dist/workflows/stock-locations/mutations.js.map +1 -0
- package/package.json +1 -1
package/dist/tax/service.d.ts
CHANGED
@@ -4,35 +4,635 @@ import { IModuleService } from "../modules-sdk";
|
|
4
4
|
import { Context } from "../shared-context";
|
5
5
|
import { FilterableTaxRegionProps, FilterableTaxRateProps, TaxRateDTO, TaxRegionDTO, TaxRateRuleDTO, FilterableTaxRateRuleProps, TaxableItemDTO, TaxCalculationContext, ItemTaxLineDTO, ShippingTaxLineDTO, TaxableShippingDTO } from "./common";
|
6
6
|
import { CreateTaxRateRuleDTO, CreateTaxRateDTO, CreateTaxRegionDTO, UpdateTaxRateDTO, UpsertTaxRateDTO } from "./mutations";
|
7
|
+
/**
|
8
|
+
* The main service interface for the Tax Module.
|
9
|
+
*/
|
7
10
|
export interface ITaxModuleService extends IModuleService {
|
11
|
+
/**
|
12
|
+
* This method retrieves a tax by its ID.
|
13
|
+
*
|
14
|
+
* @param {string} taxRateId - The tax rate's ID.
|
15
|
+
* @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
|
16
|
+
* attributes or relations associated with a tax rate.
|
17
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
18
|
+
* @returns {Promise<TaxRateDTO>} The retrieved tax.
|
19
|
+
*
|
20
|
+
* @example
|
21
|
+
* A simple example that retrieves a tax rate by its ID:
|
22
|
+
*
|
23
|
+
* ```ts
|
24
|
+
* const taxRate = await taxModuleService.retrieve("txr_123")
|
25
|
+
* ```
|
26
|
+
*
|
27
|
+
* To specify relations that should be retrieved:
|
28
|
+
*
|
29
|
+
* ```ts
|
30
|
+
* const taxRate = await taxModuleService.retrieve("txr_123", {
|
31
|
+
* relations: ["tax_region"],
|
32
|
+
* })
|
33
|
+
* ```
|
34
|
+
*/
|
8
35
|
retrieve(taxRateId: string, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<TaxRateDTO>;
|
36
|
+
/**
|
37
|
+
* This method retrieves a paginated list of tax rates based on optional filters and configuration.
|
38
|
+
*
|
39
|
+
* @param {FilterableTaxRateProps} filters - The filters to apply on the retrieved tax rates.
|
40
|
+
* @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
|
41
|
+
* attributes or relations associated with a tax rate.
|
42
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
43
|
+
* @returns {Promise<TaxRateDTO[]>} The list of tax rates.
|
44
|
+
*
|
45
|
+
* @example
|
46
|
+
* To retrieve a list of tax rates using their IDs:
|
47
|
+
*
|
48
|
+
* ```ts
|
49
|
+
* const taxRates = await taxModuleService.list({
|
50
|
+
* id: ["txr_123", "txr_321"],
|
51
|
+
* })
|
52
|
+
* ```
|
53
|
+
*
|
54
|
+
* To specify relations that should be retrieved within the tax rate:
|
55
|
+
*
|
56
|
+
* ```ts
|
57
|
+
* const taxRates = await taxModuleService.list(
|
58
|
+
* {
|
59
|
+
* id: ["txr_123", "txr_321"],
|
60
|
+
* },
|
61
|
+
* {
|
62
|
+
* relations: ["tax_region"],
|
63
|
+
* }
|
64
|
+
* )
|
65
|
+
* ```
|
66
|
+
*
|
67
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
68
|
+
*
|
69
|
+
* ```ts
|
70
|
+
* const taxRates = await taxModuleService.list(
|
71
|
+
* {
|
72
|
+
* id: ["txr_123", "txr_321"],
|
73
|
+
* },
|
74
|
+
* {
|
75
|
+
* relations: ["tax_region"],
|
76
|
+
* take: 20,
|
77
|
+
* skip: 2,
|
78
|
+
* }
|
79
|
+
* )
|
80
|
+
* ```
|
81
|
+
*/
|
9
82
|
list(filters?: FilterableTaxRateProps, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<TaxRateDTO[]>;
|
83
|
+
/**
|
84
|
+
* This method retrieves a paginated list of tax rates along with the total count of available tax rates satisfying the provided filters.
|
85
|
+
*
|
86
|
+
* @param {FilterableTaxRateProps} filters - The filters to apply on the retrieved tax rates.
|
87
|
+
* @param {FindConfig<TaxRateDTO>} config - The configurations determining how the tax rate is retrieved. Its properties, such as `select` or `relations`, accept the
|
88
|
+
* attributes or relations associated with a tax rate.
|
89
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
90
|
+
* @returns {Promise<[TaxRateDTO[], number]>} The list of tax rates along with their total count.
|
91
|
+
*
|
92
|
+
* @example
|
93
|
+
* To retrieve a list of tax rates using their IDs:
|
94
|
+
*
|
95
|
+
* ```ts
|
96
|
+
* const [taxRates, count] = await taxModuleService.listAndCount(
|
97
|
+
* {
|
98
|
+
* id: ["txr_123", "txr_321"],
|
99
|
+
* }
|
100
|
+
* )
|
101
|
+
* ```
|
102
|
+
*
|
103
|
+
* To specify relations that should be retrieved within the tax rate:
|
104
|
+
*
|
105
|
+
* ```ts
|
106
|
+
* const [taxRates, count] = await taxModuleService.listAndCount(
|
107
|
+
* {
|
108
|
+
* id: ["txr_123", "txr_321"],
|
109
|
+
* },
|
110
|
+
* {
|
111
|
+
* relations: ["tax_region"],
|
112
|
+
* }
|
113
|
+
* )
|
114
|
+
* ```
|
115
|
+
*
|
116
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
117
|
+
*
|
118
|
+
* ```ts
|
119
|
+
* const [taxRates, count] = await taxModuleService.listAndCount(
|
120
|
+
* {
|
121
|
+
* id: ["txr_123", "txr_321"],
|
122
|
+
* },
|
123
|
+
* {
|
124
|
+
* relations: ["tax_region"],
|
125
|
+
* take: 20,
|
126
|
+
* skip: 2,
|
127
|
+
* }
|
128
|
+
* )
|
129
|
+
* ```
|
130
|
+
*/
|
10
131
|
listAndCount(filters?: FilterableTaxRateProps, config?: FindConfig<TaxRateDTO>, sharedContext?: Context): Promise<[TaxRateDTO[], number]>;
|
132
|
+
/**
|
133
|
+
* This method creates tax rates.
|
134
|
+
*
|
135
|
+
* @param {CreateTaxRateDTO[]} data - The tax rates to be created.
|
136
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
137
|
+
* @returns {Promise<TaxRateDTO[]>} The created tax rates.
|
138
|
+
*
|
139
|
+
* @example
|
140
|
+
* const taxRates = await taxModuleService.create([
|
141
|
+
* {
|
142
|
+
* tax_region_id: "txreg_123",
|
143
|
+
* name: "Default rate",
|
144
|
+
* rate: 10,
|
145
|
+
* },
|
146
|
+
* {
|
147
|
+
* tax_region_id: "txreg_123",
|
148
|
+
* name: "Custom rate",
|
149
|
+
* rate: 15,
|
150
|
+
* rules: [
|
151
|
+
* {
|
152
|
+
* reference: "product_type",
|
153
|
+
* reference_id: "ptyp_1",
|
154
|
+
* },
|
155
|
+
* {
|
156
|
+
* reference: "product",
|
157
|
+
* reference_id: "prod_123",
|
158
|
+
* },
|
159
|
+
* ],
|
160
|
+
* },
|
161
|
+
* ])
|
162
|
+
*/
|
11
163
|
create(data: CreateTaxRateDTO[], sharedContext?: Context): Promise<TaxRateDTO[]>;
|
164
|
+
/**
|
165
|
+
* This method creates a tax rate.
|
166
|
+
*
|
167
|
+
* @param {CreateTaxRateDTO} data - The tax rate to be created.
|
168
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
169
|
+
* @returns {Promise<TaxRateDTO>} The created tax rate.
|
170
|
+
*
|
171
|
+
* @example
|
172
|
+
* const taxRate = await taxModuleService.create({
|
173
|
+
* tax_region_id: "txreg_123",
|
174
|
+
* name: "Default rate",
|
175
|
+
* rate: 10,
|
176
|
+
* })
|
177
|
+
*/
|
12
178
|
create(data: CreateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
|
179
|
+
/**
|
180
|
+
* This method updates an existing tax rate.
|
181
|
+
*
|
182
|
+
* @param {string} taxRateId - The tax rate's ID.
|
183
|
+
* @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
|
184
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
185
|
+
* @returns {Promise<TaxRateDTO>} The updated tax rate.
|
186
|
+
*
|
187
|
+
* @example
|
188
|
+
* const taxRate = await taxModuleService.update("txr_123", {
|
189
|
+
* rate: 10,
|
190
|
+
* })
|
191
|
+
*/
|
13
192
|
update(taxRateId: string, data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
|
193
|
+
/**
|
194
|
+
* This method updates existing tax rates.
|
195
|
+
*
|
196
|
+
* @param {string[]} taxRateIds - The IDs of tax rates to update.
|
197
|
+
* @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
|
198
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
199
|
+
* @returns {Promise<TaxRateDTO[]>} The updated tax rates.
|
200
|
+
*
|
201
|
+
* @example
|
202
|
+
* const taxRates = await taxModuleService.update(
|
203
|
+
* ["txr_123", "txr_321"],
|
204
|
+
* {
|
205
|
+
* rate: 10,
|
206
|
+
* }
|
207
|
+
* )
|
208
|
+
*/
|
14
209
|
update(taxRateIds: string[], data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO[]>;
|
210
|
+
/**
|
211
|
+
* This method updates existing tax rates matching the specified filters.
|
212
|
+
*
|
213
|
+
* @param {FilterableTaxRateProps} selector - The filters specifying which tax rates to update.
|
214
|
+
* @param {UpdateTaxRateDTO} data - The attributes to update in the tax rate.
|
215
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
216
|
+
* @returns {Promise<TaxRateDTO[]>} The updated tax rates.
|
217
|
+
*
|
218
|
+
* @example
|
219
|
+
* const taxRates = await taxModuleService.update(
|
220
|
+
* {
|
221
|
+
* id: ["txr_123", "txr_321"],
|
222
|
+
* },
|
223
|
+
* {
|
224
|
+
* rate: 10,
|
225
|
+
* }
|
226
|
+
* )
|
227
|
+
*/
|
15
228
|
update(selector: FilterableTaxRateProps, data: UpdateTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO[]>;
|
229
|
+
/**
|
230
|
+
* This method updates or creates a tax rate if it doesn't exist.
|
231
|
+
*
|
232
|
+
* @param {UpsertTaxRateDTO} data - The attributes in the tax rate to be created or updated.
|
233
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
234
|
+
* @returns {Promise<TaxRateDTO>} The created or updated tax rate.
|
235
|
+
*
|
236
|
+
* @example
|
237
|
+
* const taxRate = await taxModuleService.upsert({
|
238
|
+
* id: "txr_123",
|
239
|
+
* rate: 10,
|
240
|
+
* })
|
241
|
+
*/
|
16
242
|
upsert(data: UpsertTaxRateDTO, sharedContext?: Context): Promise<TaxRateDTO>;
|
243
|
+
/**
|
244
|
+
* This method updates or creates tax rates if they don't exist.
|
245
|
+
*
|
246
|
+
* @param {UpsertTaxRateDTO[]} data - The attributes in the tax rates to be created or updated.
|
247
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
248
|
+
* @returns {Promise<TaxRateDTO[]>} The created or updated tax rates.
|
249
|
+
*
|
250
|
+
* @example
|
251
|
+
* const taxRates = await taxModuleService.upsert([
|
252
|
+
* {
|
253
|
+
* id: "txr_123",
|
254
|
+
* rate: 10,
|
255
|
+
* },
|
256
|
+
* ])
|
257
|
+
*/
|
17
258
|
upsert(data: UpsertTaxRateDTO[], sharedContext?: Context): Promise<TaxRateDTO[]>;
|
259
|
+
/**
|
260
|
+
* This method deletes tax rates by their IDs.
|
261
|
+
*
|
262
|
+
* @param {string[]} taxRateIds - The IDs of tax rates to delete.
|
263
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
264
|
+
* @returns {Promise<void>} Resolves when the tax rates are deleted successfully.
|
265
|
+
*
|
266
|
+
* @example
|
267
|
+
* await taxModuleService.delete(["txr_123", "txr_321"])
|
268
|
+
*/
|
18
269
|
delete(taxRateIds: string[], sharedContext?: Context): Promise<void>;
|
270
|
+
/**
|
271
|
+
* This method deletes a tax rate by its ID.
|
272
|
+
*
|
273
|
+
* @param {string} taxRateId - The tax rate's ID.
|
274
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
275
|
+
* @returns {Promise<void>} Resolves when the tax rate is deleted successfully.
|
276
|
+
*
|
277
|
+
* @example
|
278
|
+
* await taxModuleService.delete("txr_123")
|
279
|
+
*/
|
19
280
|
delete(taxRateId: string, sharedContext?: Context): Promise<void>;
|
281
|
+
/**
|
282
|
+
* This method restores soft deleted tax rates by their IDs.
|
283
|
+
*
|
284
|
+
* @param {string[]} taxRateIds - The IDs of the tax rates.
|
285
|
+
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
|
286
|
+
* property any of the tax rate's relation attribute names, such as `rules`.
|
287
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
288
|
+
* @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.
|
289
|
+
* The object's keys are the ID attribute names of the tax rate entity's relations, such as `rule_id`,
|
290
|
+
* and its value is an array of strings, each being the ID of the record associated with the tax rate through this relation,
|
291
|
+
* such as the IDs of associated rules.
|
292
|
+
*
|
293
|
+
* If there are no related records restored, the promise resolves to `void`.
|
294
|
+
*
|
295
|
+
* @example
|
296
|
+
* await taxModuleService.restore(["txr_123", "txr_321"])
|
297
|
+
*/
|
20
298
|
restore<TReturnableLinkableKeys extends string = string>(taxRateIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
299
|
+
/**
|
300
|
+
* This method creates a tax region.
|
301
|
+
*
|
302
|
+
* @param {CreateTaxRegionDTO} data - The tax region to be created.
|
303
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
304
|
+
* @returns {Promise<TaxRegionDTO>} The created tax region.
|
305
|
+
*
|
306
|
+
* @example
|
307
|
+
* const taxRegion = await taxModuleService.createTaxRegions({
|
308
|
+
* country_code: "us",
|
309
|
+
* })
|
310
|
+
*/
|
21
311
|
createTaxRegions(data: CreateTaxRegionDTO, sharedContext?: Context): Promise<TaxRegionDTO>;
|
312
|
+
/**
|
313
|
+
* This method creates tax regions.
|
314
|
+
*
|
315
|
+
* @param {CreateTaxRegionDTO[]} data - The tax regions to be created.
|
316
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
317
|
+
* @returns {Promise<TaxRegionDTO[]>} The created tax regions.
|
318
|
+
*
|
319
|
+
* @example
|
320
|
+
* const taxRegions = await taxModuleService.createTaxRegions([
|
321
|
+
* {
|
322
|
+
* country_code: "us",
|
323
|
+
* },
|
324
|
+
* {
|
325
|
+
* country_code: "gb",
|
326
|
+
* },
|
327
|
+
* ])
|
328
|
+
*/
|
22
329
|
createTaxRegions(data: CreateTaxRegionDTO[], sharedContext?: Context): Promise<TaxRegionDTO[]>;
|
330
|
+
/**
|
331
|
+
* This method deletes tax regions by their IDs.
|
332
|
+
*
|
333
|
+
* @param {string[]} taxRegionIds - The IDs of the tax regions.
|
334
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
335
|
+
* @returns {Promise<void>} Resolves when the tax regions are deleted.
|
336
|
+
*
|
337
|
+
* @example
|
338
|
+
* await taxModuleService.deleteTaxRegions([
|
339
|
+
* "txreg_123",
|
340
|
+
* "txreg_321",
|
341
|
+
* ])
|
342
|
+
*/
|
23
343
|
deleteTaxRegions(taxRegionIds: string[], sharedContext?: Context): Promise<void>;
|
344
|
+
/**
|
345
|
+
* This method deletes a tax region by its ID.
|
346
|
+
*
|
347
|
+
* @param {string} taxRegionId - The tax region's ID.
|
348
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
349
|
+
* @returns {Promise<void>} Resolves when the tax region is successfully deleted.
|
350
|
+
*
|
351
|
+
* @example
|
352
|
+
* await taxModuleService.deleteTaxRegions("txreg_123")
|
353
|
+
*/
|
24
354
|
deleteTaxRegions(taxRegionId: string, sharedContext?: Context): Promise<void>;
|
355
|
+
/**
|
356
|
+
* This method retrieves a paginated list of tax regions based on optional filters and configuration.
|
357
|
+
*
|
358
|
+
* @param {FilterableTaxRegionProps} filters - The filters to apply on the retrieved tax regions.
|
359
|
+
* @param {FindConfig<TaxRegionDTO>} config - The configurations determining how the tax region is retrieved. Its properties, such as `select` or `relations`, accept the
|
360
|
+
* attributes or relations associated with a tax region.
|
361
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
362
|
+
* @returns {Promise<TaxRegionDTO[]>} The list of tax regions.
|
363
|
+
*
|
364
|
+
* @example
|
365
|
+
* To retrieve a list of tax regions using their IDs:
|
366
|
+
*
|
367
|
+
* ```ts
|
368
|
+
* const taxRegions = await taxModuleService.listTaxRegions({
|
369
|
+
* id: ["txreg_123", "txreg_321"],
|
370
|
+
* })
|
371
|
+
* ```
|
372
|
+
*
|
373
|
+
* To specify relations that should be retrieved within the tax region:
|
374
|
+
*
|
375
|
+
* ```ts
|
376
|
+
* const taxRegions = await taxModuleService.listTaxRegions(
|
377
|
+
* {
|
378
|
+
* id: ["txreg_123", "txreg_321"],
|
379
|
+
* },
|
380
|
+
* {
|
381
|
+
* relations: ["tax_rates"],
|
382
|
+
* }
|
383
|
+
* )
|
384
|
+
* ```
|
385
|
+
*
|
386
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
387
|
+
*
|
388
|
+
* ```ts
|
389
|
+
* const taxRegions = await taxModuleService.listTaxRegions(
|
390
|
+
* {
|
391
|
+
* id: ["txreg_123", "txreg_321"],
|
392
|
+
* },
|
393
|
+
* {
|
394
|
+
* relations: ["tax_rates"],
|
395
|
+
* take: 20,
|
396
|
+
* skip: 2,
|
397
|
+
* }
|
398
|
+
* )
|
399
|
+
* ```
|
400
|
+
*/
|
25
401
|
listTaxRegions(filters?: FilterableTaxRegionProps, config?: FindConfig<TaxRegionDTO>, sharedContext?: Context): Promise<TaxRegionDTO[]>;
|
402
|
+
/**
|
403
|
+
* This method creates a tax rate rule.
|
404
|
+
*
|
405
|
+
* @param {CreateTaxRateRuleDTO} data - The tax rate rule to be created.
|
406
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
407
|
+
* @returns {Promise<TaxRateRuleDTO>} The created tax rate rule.
|
408
|
+
*
|
409
|
+
* @example
|
410
|
+
* const taxRateRule = await taxModuleService.createTaxRateRules(
|
411
|
+
* {
|
412
|
+
* reference: "product_type",
|
413
|
+
* reference_id: "ptyp_123",
|
414
|
+
* tax_rate_id: "txr_123",
|
415
|
+
* }
|
416
|
+
* )
|
417
|
+
*/
|
26
418
|
createTaxRateRules(data: CreateTaxRateRuleDTO, sharedContext?: Context): Promise<TaxRateRuleDTO>;
|
419
|
+
/**
|
420
|
+
* This method creates tax rate rules.
|
421
|
+
*
|
422
|
+
* @param {CreateTaxRateRuleDTO[]} data - The tax rate rules to be created.
|
423
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
424
|
+
* @returns {Promise<TaxRateRuleDTO[]>} The created tax rate rules.
|
425
|
+
*
|
426
|
+
* @example
|
427
|
+
* const taxRateRules =
|
428
|
+
* await taxModuleService.createTaxRateRules([
|
429
|
+
* {
|
430
|
+
* reference: "product_type",
|
431
|
+
* reference_id: "ptyp_123",
|
432
|
+
* tax_rate_id: "txr_123",
|
433
|
+
* },
|
434
|
+
* {
|
435
|
+
* reference: "product",
|
436
|
+
* reference_id: "prod_123",
|
437
|
+
* tax_rate_id: "txr_321",
|
438
|
+
* },
|
439
|
+
* ])
|
440
|
+
*/
|
27
441
|
createTaxRateRules(data: CreateTaxRateRuleDTO[], sharedContext?: Context): Promise<TaxRateRuleDTO[]>;
|
442
|
+
/**
|
443
|
+
* This method deletes a tax rate rule by its ID.
|
444
|
+
*
|
445
|
+
* @param {string} taxRateRuleId - The tax rate rule's ID.
|
446
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
447
|
+
* @returns {Promise<void>} Resolves when the tax rate rule is deleted successfully.
|
448
|
+
*
|
449
|
+
* @example
|
450
|
+
* await taxModuleService.deleteTaxRateRules("txrule_123")
|
451
|
+
*/
|
28
452
|
deleteTaxRateRules(taxRateRuleId: string, sharedContext?: Context): Promise<void>;
|
453
|
+
/**
|
454
|
+
* This method deletes tax rate rules by their IDs.
|
455
|
+
*
|
456
|
+
* @param {string[]} taxRateRuleIds - The tax rate rules' IDs.
|
457
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
458
|
+
* @returns {Promise<void>} Resolves when the tax rate rules are deleted successfully.
|
459
|
+
*
|
460
|
+
* @example
|
461
|
+
* await taxModuleService.deleteTaxRateRules([
|
462
|
+
* "txrule_123",
|
463
|
+
* "txrule_321",
|
464
|
+
* ])
|
465
|
+
*/
|
29
466
|
deleteTaxRateRules(taxRateRuleIds: string[], sharedContext?: Context): Promise<void>;
|
467
|
+
/**
|
468
|
+
* This method retrieves a paginated list of tax rate rules based on optional filters and configuration.
|
469
|
+
*
|
470
|
+
* @param {FilterableTaxRateRuleProps} filters - The filters to apply on the retrieved tax rate rules.
|
471
|
+
* @param {FindConfig<TaxRateRuleDTO>} config - The configurations determining how the tax rate rule is retrieved. Its properties, such as `select` or `relations`, accept the
|
472
|
+
* attributes or relations associated with a tax rate rule.
|
473
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
474
|
+
* @returns {Promise<TaxRateRuleDTO[]>} The list of tax rate rules.
|
475
|
+
*
|
476
|
+
* @example
|
477
|
+
* To retrieve a list of tax rate rules using their associated tax rate's ID:
|
478
|
+
*
|
479
|
+
* ```ts
|
480
|
+
* const taxRateRules = await taxModuleService.listTaxRateRules({
|
481
|
+
* tax_rate_id: ["txr_123", "txr_321"],
|
482
|
+
* })
|
483
|
+
* ```
|
484
|
+
*
|
485
|
+
* To specify relations that should be retrieved within the tax rate rule:
|
486
|
+
*
|
487
|
+
* ```ts
|
488
|
+
* const taxRateRules = await taxModuleService.listTaxRateRules(
|
489
|
+
* {
|
490
|
+
* tax_rate_id: ["txr_123", "txr_321"],
|
491
|
+
* },
|
492
|
+
* {
|
493
|
+
* relations: ["tax_rate"],
|
494
|
+
* }
|
495
|
+
* )
|
496
|
+
* ```
|
497
|
+
*
|
498
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
499
|
+
*
|
500
|
+
* ```ts
|
501
|
+
* const taxRateRules = await taxModuleService.listTaxRateRules(
|
502
|
+
* {
|
503
|
+
* tax_rate_id: ["txr_123", "txr_321"],
|
504
|
+
* },
|
505
|
+
* {
|
506
|
+
* relations: ["tax_rate"],
|
507
|
+
* take: 20,
|
508
|
+
* skip: 2,
|
509
|
+
* }
|
510
|
+
* )
|
511
|
+
* ```
|
512
|
+
*/
|
30
513
|
listTaxRateRules(filters?: FilterableTaxRateRuleProps, config?: FindConfig<TaxRateRuleDTO>, sharedContext?: Context): Promise<TaxRateRuleDTO[]>;
|
514
|
+
/**
|
515
|
+
* This method retrieves tax lines for taxable items and shipping methods in a cart.
|
516
|
+
*
|
517
|
+
* Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-calculation-with-provider/).
|
518
|
+
*
|
519
|
+
* @param {(TaxableItemDTO | TaxableShippingDTO)[]} items - The items and shipping methods to retrieve their tax lines.
|
520
|
+
* @param {TaxCalculationContext} calculationContext - The context to pass to the underlying tax provider. It provides more
|
521
|
+
* details that are useful to provide accurate tax lines.
|
522
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
523
|
+
* @returns {Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>} The item and shipping methods' tax lines.
|
524
|
+
*
|
525
|
+
* @example
|
526
|
+
* const taxLines = await taxModuleService.getTaxLines(
|
527
|
+
* [
|
528
|
+
* {
|
529
|
+
* id: "cali_123",
|
530
|
+
* product_id: "prod_123",
|
531
|
+
* unit_price: 1000,
|
532
|
+
* quantity: 1,
|
533
|
+
* },
|
534
|
+
* {
|
535
|
+
* id: "casm_123",
|
536
|
+
* shipping_option_id: "so_123",
|
537
|
+
* unit_price: 2000,
|
538
|
+
* },
|
539
|
+
* ],
|
540
|
+
* {
|
541
|
+
* address: {
|
542
|
+
* country_code: "us",
|
543
|
+
* },
|
544
|
+
* }
|
545
|
+
* )
|
546
|
+
*/
|
31
547
|
getTaxLines(items: (TaxableItemDTO | TaxableShippingDTO)[], calculationContext: TaxCalculationContext, sharedContext?: Context): Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>;
|
548
|
+
/**
|
549
|
+
* This method soft deletes tax raes by their IDs.
|
550
|
+
*
|
551
|
+
* @param {string[]} taxRateIds - The IDs of the tax rates.
|
552
|
+
* @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.
|
553
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
554
|
+
* @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.
|
555
|
+
* 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
|
556
|
+
* with the tax rate through this relation, such as the IDs of associated rules.
|
557
|
+
*
|
558
|
+
* If there are no related records, the promise resolves to `void`.
|
559
|
+
*
|
560
|
+
* @example
|
561
|
+
* await taxModuleService.softDelete(["txr_123", "txr_321"])
|
562
|
+
*/
|
32
563
|
softDelete<TReturnableLinkableKeys extends string = string>(taxRateIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
564
|
+
/**
|
565
|
+
* This method soft deletes tax regions by their IDs.
|
566
|
+
*
|
567
|
+
* @param {string[]} taxRegionIds - The IDs of the tax regions.
|
568
|
+
* @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.
|
569
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
570
|
+
* @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.
|
571
|
+
* 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
|
572
|
+
* with the tax region through this relation, such as the IDs of associated tax rates.
|
573
|
+
*
|
574
|
+
* If there are no related records, the promise resolves to `void`.
|
575
|
+
*
|
576
|
+
* @example
|
577
|
+
* await taxModuleService.softDeleteTaxRegions([
|
578
|
+
* "txreg_123",
|
579
|
+
* "txreg_321",
|
580
|
+
* ])
|
581
|
+
*/
|
33
582
|
softDeleteTaxRegions<TReturnableLinkableKeys extends string = string>(taxRegionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
583
|
+
/**
|
584
|
+
* This method restores soft deleted tax regions by their IDs.
|
585
|
+
*
|
586
|
+
* @param {string[]} taxRegionIds - The IDs of the tax regions.
|
587
|
+
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
|
588
|
+
* property any of the tax region's relation attribute names, such as `tax_rates`.
|
589
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
590
|
+
* @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.
|
591
|
+
* The object's keys are the ID attribute names of the tax region entity's relations, such as `tax_rate_id`,
|
592
|
+
* and its value is an array of strings, each being the ID of the record associated with the tax region through this relation,
|
593
|
+
* such as the IDs of associated tax rates.
|
594
|
+
*
|
595
|
+
* If there are no related records restored, the promise resolves to `void`.
|
596
|
+
*
|
597
|
+
* @example
|
598
|
+
* await taxModuleService.restoreTaxRegions([
|
599
|
+
* "txreg_123",
|
600
|
+
* "txreg_321",
|
601
|
+
* ])
|
602
|
+
*/
|
34
603
|
restoreTaxRegions<TReturnableLinkableKeys extends string = string>(taxRegionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
604
|
+
/**
|
605
|
+
* This method soft deletes tax rate rules by their IDs.
|
606
|
+
*
|
607
|
+
* @param {string[]} taxRateRuleIds - The IDs of the tax rate rules.
|
608
|
+
* @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.
|
609
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
610
|
+
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
611
|
+
* If there are no related records, the promise resolves to `void`.
|
612
|
+
*
|
613
|
+
* @example
|
614
|
+
* await taxModuleService.softDeleteTaxRateRules([
|
615
|
+
* "txrule_123",
|
616
|
+
* "txrule_321",
|
617
|
+
* ])
|
618
|
+
*/
|
35
619
|
softDeleteTaxRateRules<TReturnableLinkableKeys extends string = string>(taxRateRuleIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
620
|
+
/**
|
621
|
+
* This method restores soft deleted tax rate rules by their IDs.
|
622
|
+
*
|
623
|
+
* @param {string[]} taxRateRuleIds - The IDs of the tax rate rules.
|
624
|
+
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the tax. You can pass to its `returnLinkableKeys`
|
625
|
+
* property any of the tax rate rule's relation attribute names.
|
626
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
627
|
+
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
628
|
+
* If there are no related records restored, the promise resolves to `void`.
|
629
|
+
*
|
630
|
+
* @example
|
631
|
+
* await taxModuleService.restoreTaxRateRules([
|
632
|
+
* "txrule_123",
|
633
|
+
* "txrule_321",
|
634
|
+
* ])
|
635
|
+
*/
|
36
636
|
restoreTaxRateRules<TReturnableLinkableKeys extends string = string>(taxRateRuleIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
37
637
|
}
|
38
638
|
//# sourceMappingURL=service.d.ts.map
|
@@ -1 +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;
|
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;;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"}
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
|