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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (170) hide show
  1. package/dist/auth/common/auth-user.d.ts +21 -16
  2. package/dist/auth/common/auth-user.d.ts.map +1 -1
  3. package/dist/auth/common/provider.d.ts +28 -15
  4. package/dist/auth/common/provider.d.ts.map +1 -1
  5. package/dist/auth/service.d.ts +137 -75
  6. package/dist/auth/service.d.ts.map +1 -1
  7. package/dist/bundles.d.ts +2 -0
  8. package/dist/bundles.d.ts.map +1 -1
  9. package/dist/bundles.js +3 -1
  10. package/dist/bundles.js.map +1 -1
  11. package/dist/cart/common.d.ts +443 -62
  12. package/dist/cart/common.d.ts.map +1 -1
  13. package/dist/cart/mutations.d.ts +483 -0
  14. package/dist/cart/mutations.d.ts.map +1 -1
  15. package/dist/cart/mutations.js.map +1 -1
  16. package/dist/cart/service.d.ts +1607 -0
  17. package/dist/cart/service.d.ts.map +1 -1
  18. package/dist/common/index.d.ts +1 -0
  19. package/dist/common/index.d.ts.map +1 -1
  20. package/dist/common/index.js +1 -0
  21. package/dist/common/index.js.map +1 -1
  22. package/dist/common/rule.d.ts +2 -0
  23. package/dist/common/rule.d.ts.map +1 -0
  24. package/dist/common/rule.js +3 -0
  25. package/dist/common/rule.js.map +1 -0
  26. package/dist/customer/service.d.ts +445 -197
  27. package/dist/customer/service.d.ts.map +1 -1
  28. package/dist/file/common.d.ts +14 -0
  29. package/dist/file/common.d.ts.map +1 -0
  30. package/dist/file/common.js +3 -0
  31. package/dist/file/common.js.map +1 -0
  32. package/dist/file/index.d.ts +4 -0
  33. package/dist/file/index.d.ts.map +1 -0
  34. package/dist/file/index.js +20 -0
  35. package/dist/file/index.js.map +1 -0
  36. package/dist/file/mutations.d.ts +18 -0
  37. package/dist/file/mutations.d.ts.map +1 -0
  38. package/dist/file/mutations.js +3 -0
  39. package/dist/file/mutations.js.map +1 -0
  40. package/dist/file/service.d.ts +76 -0
  41. package/dist/file/service.d.ts.map +1 -0
  42. package/dist/file/service.js +3 -0
  43. package/dist/file/service.js.map +1 -0
  44. package/dist/fulfillment/mutations/shipping-option-rule.d.ts +2 -2
  45. package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +1 -1
  46. package/dist/http/fulfillment/admin/fulfillment-address.d.ts +22 -0
  47. package/dist/http/fulfillment/admin/fulfillment-address.d.ts.map +1 -0
  48. package/dist/http/fulfillment/admin/fulfillment-address.js +3 -0
  49. package/dist/http/fulfillment/admin/fulfillment-address.js.map +1 -0
  50. package/dist/http/fulfillment/admin/fulfillment-item.d.ts +17 -0
  51. package/dist/http/fulfillment/admin/fulfillment-item.d.ts.map +1 -0
  52. package/dist/http/fulfillment/admin/fulfillment-item.js +3 -0
  53. package/dist/http/fulfillment/admin/fulfillment-item.js.map +1 -0
  54. package/dist/http/fulfillment/admin/fulfillment-label.d.ts +14 -0
  55. package/dist/http/fulfillment/admin/fulfillment-label.d.ts.map +1 -0
  56. package/dist/http/fulfillment/admin/fulfillment-label.js +3 -0
  57. package/dist/http/fulfillment/admin/fulfillment-label.js.map +1 -0
  58. package/dist/http/fulfillment/admin/fulfillment-provider.d.ts +12 -0
  59. package/dist/http/fulfillment/admin/fulfillment-provider.d.ts.map +1 -0
  60. package/dist/http/fulfillment/admin/fulfillment-provider.js +3 -0
  61. package/dist/http/fulfillment/admin/fulfillment-provider.js.map +1 -0
  62. package/dist/http/fulfillment/admin/fulfillment-set.d.ts +15 -0
  63. package/dist/http/fulfillment/admin/fulfillment-set.d.ts.map +1 -0
  64. package/dist/http/fulfillment/admin/fulfillment-set.js +3 -0
  65. package/dist/http/fulfillment/admin/fulfillment-set.js.map +1 -0
  66. package/dist/http/fulfillment/admin/fulfillment.d.ts +27 -0
  67. package/dist/http/fulfillment/admin/fulfillment.d.ts.map +1 -0
  68. package/dist/http/fulfillment/admin/fulfillment.js +3 -0
  69. package/dist/http/fulfillment/admin/fulfillment.js.map +1 -0
  70. package/dist/http/fulfillment/admin/geo-zone.d.ts +17 -0
  71. package/dist/http/fulfillment/admin/geo-zone.d.ts.map +1 -0
  72. package/dist/http/fulfillment/admin/geo-zone.js +3 -0
  73. package/dist/http/fulfillment/admin/geo-zone.js.map +1 -0
  74. package/dist/http/fulfillment/admin/index.d.ts +13 -0
  75. package/dist/http/fulfillment/admin/index.d.ts.map +1 -0
  76. package/dist/http/fulfillment/admin/index.js +29 -0
  77. package/dist/http/fulfillment/admin/index.js.map +1 -0
  78. package/dist/http/fulfillment/admin/service-zone.d.ts +14 -0
  79. package/dist/http/fulfillment/admin/service-zone.d.ts.map +1 -0
  80. package/dist/http/fulfillment/admin/service-zone.js +3 -0
  81. package/dist/http/fulfillment/admin/service-zone.js.map +1 -0
  82. package/dist/http/fulfillment/admin/shipping-option-rule.d.ts +16 -0
  83. package/dist/http/fulfillment/admin/shipping-option-rule.d.ts.map +1 -0
  84. package/dist/http/fulfillment/admin/shipping-option-rule.js +3 -0
  85. package/dist/http/fulfillment/admin/shipping-option-rule.js.map +1 -0
  86. package/dist/http/fulfillment/admin/shipping-option-type.d.ts +14 -0
  87. package/dist/http/fulfillment/admin/shipping-option-type.d.ts.map +1 -0
  88. package/dist/http/fulfillment/admin/shipping-option-type.js +3 -0
  89. package/dist/http/fulfillment/admin/shipping-option-type.js.map +1 -0
  90. package/dist/http/fulfillment/admin/shipping-option.d.ts +31 -0
  91. package/dist/http/fulfillment/admin/shipping-option.d.ts.map +1 -0
  92. package/dist/http/fulfillment/admin/shipping-option.js +3 -0
  93. package/dist/http/fulfillment/admin/shipping-option.js.map +1 -0
  94. package/dist/http/fulfillment/admin/shipping-profile.d.ts +13 -0
  95. package/dist/http/fulfillment/admin/shipping-profile.d.ts.map +1 -0
  96. package/dist/http/fulfillment/admin/shipping-profile.js +3 -0
  97. package/dist/http/fulfillment/admin/shipping-profile.js.map +1 -0
  98. package/dist/http/fulfillment/index.d.ts +2 -0
  99. package/dist/http/fulfillment/index.d.ts.map +1 -0
  100. package/dist/http/fulfillment/index.js +18 -0
  101. package/dist/http/fulfillment/index.js.map +1 -0
  102. package/dist/http/index.d.ts +2 -0
  103. package/dist/http/index.d.ts.map +1 -0
  104. package/dist/http/index.js +18 -0
  105. package/dist/http/index.js.map +1 -0
  106. package/dist/index.d.ts +2 -0
  107. package/dist/index.d.ts.map +1 -1
  108. package/dist/index.js +2 -0
  109. package/dist/index.js.map +1 -1
  110. package/dist/inventory/common/inventory-item.d.ts +55 -64
  111. package/dist/inventory/common/inventory-item.d.ts.map +1 -1
  112. package/dist/inventory/common/inventory-level.d.ts +37 -37
  113. package/dist/inventory/common/inventory-level.d.ts.map +1 -1
  114. package/dist/inventory/common/reservation-item.d.ts +34 -44
  115. package/dist/inventory/common/reservation-item.d.ts.map +1 -1
  116. package/dist/inventory/service-next.d.ts +596 -534
  117. package/dist/inventory/service-next.d.ts.map +1 -1
  118. package/dist/payment/common.d.ts +174 -53
  119. package/dist/payment/common.d.ts.map +1 -1
  120. package/dist/payment/common.js +3 -3
  121. package/dist/payment/common.js.map +1 -1
  122. package/dist/payment/mutations.d.ts +58 -17
  123. package/dist/payment/mutations.d.ts.map +1 -1
  124. package/dist/payment/provider.d.ts +128 -43
  125. package/dist/payment/provider.d.ts.map +1 -1
  126. package/dist/payment/provider.js.map +1 -1
  127. package/dist/payment/service.d.ts +460 -39
  128. package/dist/payment/service.d.ts.map +1 -1
  129. package/dist/pricing/common/price-list.d.ts +2 -2
  130. package/dist/pricing/common/price-set.d.ts +6 -4
  131. package/dist/pricing/common/price-set.d.ts.map +1 -1
  132. package/dist/pricing/service.d.ts +731 -1695
  133. package/dist/pricing/service.d.ts.map +1 -1
  134. package/dist/promotion/common/application-method.d.ts +153 -0
  135. package/dist/promotion/common/application-method.d.ts.map +1 -1
  136. package/dist/promotion/common/campaign-budget.d.ts +37 -0
  137. package/dist/promotion/common/campaign-budget.d.ts.map +1 -1
  138. package/dist/promotion/common/campaign.d.ts +36 -0
  139. package/dist/promotion/common/campaign.d.ts.map +1 -1
  140. package/dist/promotion/common/compute-actions.d.ts +135 -0
  141. package/dist/promotion/common/compute-actions.d.ts.map +1 -1
  142. package/dist/promotion/common/promotion-rule-value.d.ts +30 -0
  143. package/dist/promotion/common/promotion-rule-value.d.ts.map +1 -1
  144. package/dist/promotion/common/promotion-rule.d.ts +77 -0
  145. package/dist/promotion/common/promotion-rule.d.ts.map +1 -1
  146. package/dist/promotion/common/promotion.d.ts +100 -0
  147. package/dist/promotion/common/promotion.d.ts.map +1 -1
  148. package/dist/promotion/mutations.d.ts +84 -0
  149. package/dist/promotion/mutations.d.ts.map +1 -1
  150. package/dist/promotion/service.d.ts +786 -0
  151. package/dist/promotion/service.d.ts.map +1 -1
  152. package/dist/stock-location/common.d.ts +14 -0
  153. package/dist/stock-location/common.d.ts.map +1 -1
  154. package/dist/stock-location/service-next.d.ts +178 -186
  155. package/dist/stock-location/service-next.d.ts.map +1 -1
  156. package/dist/store/common/store.d.ts +42 -0
  157. package/dist/store/common/store.d.ts.map +1 -1
  158. package/dist/store/mutations/store.d.ts +75 -0
  159. package/dist/store/mutations/store.d.ts.map +1 -1
  160. package/dist/store/service.d.ts +113 -75
  161. package/dist/store/service.d.ts.map +1 -1
  162. package/dist/tax/common.d.ts +298 -10
  163. package/dist/tax/common.d.ts.map +1 -1
  164. package/dist/tax/mutations.d.ts +157 -0
  165. package/dist/tax/mutations.d.ts.map +1 -1
  166. package/dist/tax/provider.d.ts +126 -0
  167. package/dist/tax/provider.d.ts.map +1 -1
  168. package/dist/tax/service.d.ts +600 -0
  169. package/dist/tax/service.d.ts.map +1 -1
  170. package/package.json +1 -1
@@ -1,12 +1,17 @@
1
1
  import { BaseFilterable } from "../dal";
2
2
  import { OperatorMap } from "../dal/utils";
3
+ /**
4
+ * The tax rate details.
5
+ */
3
6
  export interface TaxRateDTO {
4
7
  /**
5
- * The ID of the Tax Rate.
8
+ * The ID of the tax rate.
6
9
  */
7
10
  id: string;
8
11
  /**
9
- * The numerical rate to charge.
12
+ * The rate to charge.
13
+ * @example
14
+ * 10
10
15
  */
11
16
  rate: number | null;
12
17
  /**
@@ -14,7 +19,9 @@ export interface TaxRateDTO {
14
19
  */
15
20
  code: string | null;
16
21
  /**
17
- * The name of the Tax Rate. E.g. "VAT".
22
+ * The name of the Tax Rate.
23
+ * @example
24
+ * VAT
18
25
  */
19
26
  name: string;
20
27
  /**
@@ -22,136 +29,417 @@ export interface TaxRateDTO {
22
29
  */
23
30
  metadata: Record<string, unknown> | null;
24
31
  /**
25
- * The id of the Tax Region the rate is associated with.
32
+ * The ID of the associated tax region.
26
33
  */
27
34
  tax_region_id: string;
28
35
  /**
29
- * Flag to indicate if the Tax Rate should be combined with parent rates.
36
+ * Whether the tax rate should be combined with parent rates.
37
+ *
38
+ * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).
30
39
  */
31
40
  is_combinable: boolean;
32
41
  /**
33
- * Flag to indicate if the Tax Rate is the default rate for the region.
42
+ * Whether the tax rate is the default rate for the region.
34
43
  */
35
44
  is_default: boolean;
36
45
  /**
37
- * When the Tax Rate was created.
46
+ * The creation date of the tax rate.
38
47
  */
39
48
  created_at: string | Date;
40
49
  /**
41
- * When the Tax Rate was updated.
50
+ * The update date of the tax rate.
42
51
  */
43
52
  updated_at: string | Date;
44
53
  /**
45
- * When the Tax Rate was deleted.
54
+ * The deletion date of the tax rate.
46
55
  */
47
56
  deleted_at: Date | null;
48
57
  /**
49
- * The ID of the user that created the Tax Rate.
58
+ * Who created the tax rate. For example, the ID of the user that created the tax rate.
50
59
  */
51
60
  created_by: string | null;
52
61
  }
62
+ /**
63
+ * The tax provider details.
64
+ */
53
65
  export interface TaxProviderDTO {
66
+ /**
67
+ * The ID of the tax provider.
68
+ */
54
69
  id: string;
70
+ /**
71
+ * Whether the tax provider is enabled.
72
+ */
55
73
  is_enabled: boolean;
56
74
  }
75
+ /**
76
+ * The filters to apply on the retrieved tax rates.
77
+ */
57
78
  export interface FilterableTaxRateProps extends BaseFilterable<FilterableTaxRateProps> {
79
+ /**
80
+ * The IDs to filter the tax rates by.
81
+ */
58
82
  id?: string | string[];
83
+ /**
84
+ * Filter the tax rates by their associated tax regions.
85
+ */
59
86
  tax_region_id?: string | string[];
87
+ /**
88
+ * Filter the tax rates by their rate.
89
+ */
60
90
  rate?: number | number[] | OperatorMap<number>;
91
+ /**
92
+ * Filter the tax rates by their code.
93
+ */
61
94
  code?: string | string[] | OperatorMap<string>;
95
+ /**
96
+ * Filter the tax rates by their name.
97
+ */
62
98
  name?: string | string[] | OperatorMap<string>;
99
+ /**
100
+ * Filter the tax rates by their creation date.
101
+ */
63
102
  created_at?: OperatorMap<string>;
103
+ /**
104
+ * Filter the tax rates by their update date.
105
+ */
64
106
  updated_at?: OperatorMap<string>;
107
+ /**
108
+ * Filter the tax rates by who created it.
109
+ */
65
110
  created_by?: string | string[] | OperatorMap<string>;
66
111
  }
112
+ /**
113
+ * The tax region details.
114
+ */
67
115
  export interface TaxRegionDTO {
116
+ /**
117
+ * The ID of the tax region.
118
+ */
68
119
  id: string;
120
+ /**
121
+ * The ISO 2 character country code of the tax region.
122
+ */
69
123
  country_code: string;
124
+ /**
125
+ * The province code of the tax region.
126
+ */
70
127
  province_code: string | null;
128
+ /**
129
+ * The ID of the tax region's parent tax region.
130
+ */
71
131
  parent_id: string | null;
132
+ /**
133
+ * Holds custom data in key-value pairs.
134
+ */
72
135
  metadata: Record<string, unknown> | null;
136
+ /**
137
+ * The creation date of the tax region.
138
+ */
73
139
  created_at: string | Date;
140
+ /**
141
+ * The update date of the tax region.
142
+ */
74
143
  updated_at: string | Date;
144
+ /**
145
+ * Who created the tax region. For example, the ID of the user
146
+ * that created the tax region.
147
+ */
75
148
  created_by: string | null;
149
+ /**
150
+ * The deletion date of the tax region.
151
+ */
76
152
  deleted_at: string | Date | null;
77
153
  }
154
+ /**
155
+ * The filters to apply on the retrieved tax regions.
156
+ */
78
157
  export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRegionProps> {
158
+ /**
159
+ * The IDs to filter the tax regions by.
160
+ */
79
161
  id?: string | string[];
162
+ /**
163
+ * Filter the tax regions by their country code.
164
+ */
80
165
  country_code?: string | string[] | OperatorMap<string>;
166
+ /**
167
+ * Filter the tax regions by their province code.
168
+ */
81
169
  province_code?: string | string[] | OperatorMap<string>;
170
+ /**
171
+ * Filter the tax regions by the ID of their parent tax region.
172
+ */
82
173
  parent_id?: string | string[] | OperatorMap<string>;
174
+ /**
175
+ * Filter the tax regions by their metadata.
176
+ */
83
177
  metadata?: Record<string, unknown> | Record<string, unknown>[] | OperatorMap<Record<string, unknown>>;
178
+ /**
179
+ * Filter the tax regions by their creation date.
180
+ */
84
181
  created_at?: OperatorMap<string>;
182
+ /**
183
+ * Filter the tax regions by their update date.
184
+ */
85
185
  updated_at?: OperatorMap<string>;
186
+ /**
187
+ * Filter the tax regions by who created it.
188
+ */
86
189
  created_by?: string | string[] | OperatorMap<string>;
87
190
  }
191
+ /**
192
+ * The tax rate rule details.
193
+ */
88
194
  export interface TaxRateRuleDTO {
195
+ /**
196
+ * The ID of the tax rate rule.
197
+ */
89
198
  id: string;
199
+ /**
200
+ * The snake-case name of the data model that the tax rule references.
201
+ * For example, `product`.
202
+ *
203
+ * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
204
+ */
90
205
  reference: string;
206
+ /**
207
+ * The ID of the record of the data model that the tax rule references.
208
+ * For example, `prod_123`.
209
+ *
210
+ * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
211
+ */
91
212
  reference_id: string;
213
+ /**
214
+ * The associated tax rate's ID.
215
+ */
92
216
  tax_rate_id: string;
217
+ /**
218
+ * The associated tax rate.
219
+ */
93
220
  tax_rate?: TaxRateDTO;
221
+ /**
222
+ * Holds custom data in key-value pairs.
223
+ */
94
224
  metadata?: Record<string, unknown> | null;
225
+ /**
226
+ * The creation date of the tax rate rule.
227
+ */
95
228
  created_at: string | Date;
229
+ /**
230
+ * The update date of the tax rate rule.
231
+ */
96
232
  updated_at: string | Date;
233
+ /**
234
+ * Who created the tax rate rule. For example, the ID of the user
235
+ * that created the tax rate rule.
236
+ */
97
237
  created_by: string | null;
98
238
  }
239
+ /**
240
+ * The filters to apply on the retrieved tax rate rules.
241
+ */
99
242
  export interface FilterableTaxRateRuleProps extends BaseFilterable<FilterableTaxRateRuleProps> {
243
+ /**
244
+ * Filter the tax rate rule by what it references.
245
+ */
100
246
  reference?: string | string[] | OperatorMap<string>;
247
+ /**
248
+ * Filter the tax rate rule by the ID of the record it references.
249
+ */
101
250
  reference_id?: string | string[] | OperatorMap<string>;
251
+ /**
252
+ * Filter the tax rate rule by the ID of their associated tax rate.
253
+ */
102
254
  tax_rate_id?: string | string[] | OperatorMap<string>;
255
+ /**
256
+ * Filter the tax rate rule by their associated tax rate.
257
+ */
103
258
  tax_rate?: FilterableTaxRateProps;
259
+ /**
260
+ * Filter the tax rate rule by what its metadata.
261
+ */
104
262
  metadata?: Record<string, unknown> | Record<string, unknown>[] | OperatorMap<Record<string, unknown>>;
263
+ /**
264
+ * Filter the tax rate rule by its creation date.
265
+ */
105
266
  created_at?: OperatorMap<string>;
267
+ /**
268
+ * Filter the tax rate rule by its update date.
269
+ */
106
270
  updated_at?: OperatorMap<string>;
271
+ /**
272
+ * Filter the tax rate rule by who created it.
273
+ */
107
274
  created_by?: string | string[] | OperatorMap<string>;
108
275
  }
276
+ /**
277
+ * The taxable item details.
278
+ */
109
279
  export interface TaxableItemDTO {
280
+ /**
281
+ * The ID of the taxable item.
282
+ */
110
283
  id: string;
284
+ /**
285
+ * The associated product's ID.
286
+ */
111
287
  product_id: string;
288
+ /**
289
+ * The name of the item's product.
290
+ */
112
291
  product_name?: string;
292
+ /**
293
+ * The ID of the category of the item's product.
294
+ */
113
295
  product_category_id?: string;
296
+ /**
297
+ * The categories of the item's product.
298
+ */
114
299
  product_categories?: string[];
300
+ /**
301
+ * The SKU of the item's product.
302
+ */
115
303
  product_sku?: string;
304
+ /**
305
+ * The type of the item's product.
306
+ */
116
307
  product_type?: string;
308
+ /**
309
+ * The ID of the type of the item's product.
310
+ */
117
311
  product_type_id?: string;
312
+ /**
313
+ * The quantity of the taxable item.
314
+ */
118
315
  quantity?: number;
316
+ /**
317
+ * The unit price of the taxable item.
318
+ */
119
319
  unit_price?: number;
320
+ /**
321
+ * The ISO 3 character currency code of the taxable item.
322
+ */
120
323
  currency_code?: string;
121
324
  }
325
+ /**
326
+ * The taxable shipping details.
327
+ */
122
328
  export interface TaxableShippingDTO {
329
+ /**
330
+ * The ID of the taxable shipping.
331
+ */
123
332
  id: string;
333
+ /**
334
+ * The associated shipping option's ID.
335
+ */
124
336
  shipping_option_id: string;
337
+ /**
338
+ * The unit price of the taxable shipping.
339
+ */
125
340
  unit_price?: number;
341
+ /**
342
+ * The ISO 3 character currency code of the taxable shipping.
343
+ */
126
344
  currency_code?: string;
127
345
  }
346
+ /**
347
+ * The context provided when tax lines are calculated and retrieved. This
348
+ * context is later passed to the underlying tax provider.
349
+ */
128
350
  export interface TaxCalculationContext {
351
+ /**
352
+ * The customer's address
353
+ */
129
354
  address: {
355
+ /**
356
+ * The ISO 2 character currency code.
357
+ */
130
358
  country_code: string;
359
+ /**
360
+ * The province code.
361
+ */
131
362
  province_code?: string | null;
363
+ /**
364
+ * The first line of the address.
365
+ */
132
366
  address_1?: string;
367
+ /**
368
+ * The second line of the address
369
+ */
133
370
  address_2?: string | null;
371
+ /**
372
+ * The city.
373
+ */
134
374
  city?: string;
375
+ /**
376
+ * The postal code.
377
+ */
135
378
  postal_code?: string;
136
379
  };
380
+ /**
381
+ * The customer's details.
382
+ */
137
383
  customer?: {
384
+ /**
385
+ * The ID of the customer.
386
+ */
138
387
  id: string;
388
+ /**
389
+ * The email of the customer.
390
+ */
139
391
  email: string;
392
+ /**
393
+ * The groups that the customer belongs to.
394
+ */
140
395
  customer_groups: string[];
141
396
  };
397
+ /**
398
+ * Whether the tax lines are calculated for an order return.
399
+ */
142
400
  is_return?: boolean;
143
401
  }
402
+ /**
403
+ * The tax line details.
404
+ */
144
405
  interface TaxLineDTO {
406
+ /**
407
+ * The associated rate's ID.
408
+ */
145
409
  rate_id?: string;
410
+ /**
411
+ * The rate of the tax line.
412
+ */
146
413
  rate: number | null;
414
+ /**
415
+ * The code of the tax line.
416
+ */
147
417
  code: string | null;
418
+ /**
419
+ * The name of the tax line.
420
+ */
148
421
  name: string;
422
+ /**
423
+ * The ID of the tax provider used to calculate and retrieve the tax line.
424
+ */
149
425
  provider_id: string;
150
426
  }
427
+ /**
428
+ * The item tax line details.
429
+ */
151
430
  export interface ItemTaxLineDTO extends TaxLineDTO {
431
+ /**
432
+ * The associated line item's ID.
433
+ */
152
434
  line_item_id: string;
153
435
  }
436
+ /**
437
+ * The shipping tax line details.
438
+ */
154
439
  export interface ShippingTaxLineDTO extends TaxLineDTO {
440
+ /**
441
+ * The associated shipping line's ID.
442
+ */
155
443
  shipping_line_id: string;
156
444
  }
157
445
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACtD,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnD,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnD,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACtD,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACrD,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IACjC,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AACD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACzB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IACD,QAAQ,CAAC,EAAE;QACT,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,EAAE,CAAA;KAC1B,CAAA;IACD,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,UAAU,UAAU;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,gBAAgB,EAAE,MAAM,CAAA;CACzB"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAE7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QAEV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;KAC1B,CAAA;IAED;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB"}
@@ -1,50 +1,207 @@
1
+ /**
2
+ * The tax rate to be created.
3
+ */
1
4
  export interface CreateTaxRateDTO {
5
+ /**
6
+ * The associated tax region's ID.
7
+ */
2
8
  tax_region_id: string;
9
+ /**
10
+ * The rate to charge.
11
+ *
12
+ * @example
13
+ * 10
14
+ */
3
15
  rate?: number | null;
16
+ /**
17
+ * The code of the tax rate.
18
+ */
4
19
  code?: string | null;
20
+ /**
21
+ * The name of the tax rate.
22
+ */
5
23
  name: string;
24
+ /**
25
+ * The rules of the tax rate.
26
+ */
6
27
  rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
28
+ /**
29
+ * Whether the tax rate is default.
30
+ */
7
31
  is_default?: boolean;
32
+ /**
33
+ * Who created the tax rate. For example, the ID of the user
34
+ * that created the tax rate.
35
+ */
8
36
  created_by?: string;
37
+ /**
38
+ * Holds custom data in key-value pairs.
39
+ */
9
40
  metadata?: Record<string, unknown>;
10
41
  }
42
+ /**
43
+ * The attributes in the tax rate to be created or updated.
44
+ */
11
45
  export interface UpsertTaxRateDTO {
46
+ /**
47
+ * The ID of the tax rate. If not provided, the tax rate
48
+ * is created.
49
+ */
12
50
  id?: string;
51
+ /**
52
+ * The rate to charge
53
+ *
54
+ * @example
55
+ * 10
56
+ */
13
57
  rate?: number | null;
58
+ /**
59
+ * The code of the tax rate.
60
+ */
14
61
  code?: string | null;
62
+ /**
63
+ * The name of the tax rate.
64
+ */
15
65
  name?: string;
66
+ /**
67
+ * Whether the tax rate is default.
68
+ */
16
69
  is_default?: boolean;
70
+ /**
71
+ * Who created the tax rate. For example, the
72
+ * ID of the user that created it.
73
+ */
17
74
  created_by?: string | null;
75
+ /**
76
+ * Holds custom data in key-value pairs.
77
+ */
18
78
  metadata?: Record<string, unknown> | null;
19
79
  }
80
+ /**
81
+ * The attributes to update in the tax rate.
82
+ */
20
83
  export interface UpdateTaxRateDTO {
84
+ /**
85
+ * The rate to charge.
86
+ *
87
+ * @example
88
+ * 10
89
+ */
21
90
  rate?: number | null;
91
+ /**
92
+ * The code of the tax rate.
93
+ */
22
94
  code?: string | null;
95
+ /**
96
+ * The name of the tax rate.
97
+ */
23
98
  name?: string;
99
+ /**
100
+ * The rules of the tax rate.
101
+ */
24
102
  rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
103
+ /**
104
+ * Whether the tax rate is default.
105
+ */
25
106
  is_default?: boolean;
107
+ /**
108
+ * Whether the tax rate is combinable.
109
+ *
110
+ * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).
111
+ */
26
112
  is_combinable?: boolean;
113
+ /**
114
+ * @ignore
115
+ *
116
+ * @privateRemarks
117
+ * This should be `created_by`.
118
+ */
27
119
  updated_by?: string;
120
+ /**
121
+ * Holds custom data in key-value pairs.
122
+ */
28
123
  metadata?: Record<string, unknown>;
29
124
  }
125
+ /**
126
+ * The tax region to be created.
127
+ */
30
128
  export interface CreateTaxRegionDTO {
129
+ /**
130
+ * The ISO 3 character country code of the tax region.
131
+ */
31
132
  country_code: string;
133
+ /**
134
+ * The province code of the tax region.
135
+ */
32
136
  province_code?: string | null;
137
+ /**
138
+ * The ID of the tax region's parent.
139
+ */
33
140
  parent_id?: string | null;
141
+ /**
142
+ * Holds custom data in key-value pairs.
143
+ */
34
144
  metadata?: Record<string, unknown>;
145
+ /**
146
+ * Who created the tax region. For example, the ID of
147
+ * the user that created the tax region.
148
+ */
35
149
  created_by?: string;
150
+ /**
151
+ * The default tax rate of the tax region.
152
+ */
36
153
  default_tax_rate?: {
154
+ /**
155
+ * The rate to charge.
156
+ *
157
+ * @example
158
+ * 10
159
+ */
37
160
  rate?: number | null;
161
+ /**
162
+ * The code of the tax rate.
163
+ */
38
164
  code?: string | null;
165
+ /**
166
+ * The name of the tax rate.
167
+ */
39
168
  name: string;
169
+ /**
170
+ * Holds custom data in key-value pairs.
171
+ */
40
172
  metadata?: Record<string, unknown>;
41
173
  };
42
174
  }
175
+ /**
176
+ * The tax rate rule to be created.
177
+ */
43
178
  export interface CreateTaxRateRuleDTO {
179
+ /**
180
+ * The snake-case name of the data model that the tax rule references.
181
+ * For example, `product`.
182
+ *
183
+ * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
184
+ */
44
185
  reference: string;
186
+ /**
187
+ * The ID of the record of the data model that the tax rule references.
188
+ * For example, `prod_123`.
189
+ *
190
+ * Learn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).
191
+ */
45
192
  reference_id: string;
193
+ /**
194
+ * The associated tax rate's ID.
195
+ */
46
196
  tax_rate_id: string;
197
+ /**
198
+ * Holds custom data in key-value pairs.
199
+ */
47
200
  metadata?: Record<string, unknown>;
201
+ /**
202
+ * Who created the tax rate rule. For example, the ID of the
203
+ * user that created it.
204
+ */
48
205
  created_by?: string | null;
49
206
  }
50
207
  //# sourceMappingURL=mutations.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IACnD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IACnD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE;QACjB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}
1
+ {"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACjB;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}