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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (189) 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 +175 -54
  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/region/common.d.ts +1 -1
  153. package/dist/region/common.d.ts.map +1 -1
  154. package/dist/region/service.d.ts +1 -1
  155. package/dist/stock-location/common.d.ts +14 -0
  156. package/dist/stock-location/common.d.ts.map +1 -1
  157. package/dist/stock-location/service-next.d.ts +178 -186
  158. package/dist/stock-location/service-next.d.ts.map +1 -1
  159. package/dist/store/common/store.d.ts +42 -0
  160. package/dist/store/common/store.d.ts.map +1 -1
  161. package/dist/store/mutations/store.d.ts +75 -0
  162. package/dist/store/mutations/store.d.ts.map +1 -1
  163. package/dist/store/service.d.ts +113 -75
  164. package/dist/store/service.d.ts.map +1 -1
  165. package/dist/tax/common.d.ts +298 -10
  166. package/dist/tax/common.d.ts.map +1 -1
  167. package/dist/tax/mutations.d.ts +157 -0
  168. package/dist/tax/mutations.d.ts.map +1 -1
  169. package/dist/tax/provider.d.ts +126 -0
  170. package/dist/tax/provider.d.ts.map +1 -1
  171. package/dist/tax/service.d.ts +600 -0
  172. package/dist/tax/service.d.ts.map +1 -1
  173. package/dist/workflow/index.d.ts +1 -0
  174. package/dist/workflow/index.d.ts.map +1 -1
  175. package/dist/workflow/index.js +2 -1
  176. package/dist/workflow/index.js.map +1 -1
  177. package/dist/workflow/region/create-regions.d.ts +8 -0
  178. package/dist/workflow/region/create-regions.d.ts.map +1 -0
  179. package/dist/workflow/region/create-regions.js +3 -0
  180. package/dist/workflow/region/create-regions.js.map +1 -0
  181. package/dist/workflow/region/index.d.ts +3 -0
  182. package/dist/workflow/region/index.d.ts.map +1 -0
  183. package/dist/workflow/region/index.js +19 -0
  184. package/dist/workflow/region/index.js.map +1 -0
  185. package/dist/workflow/region/update-regions.d.ts +9 -0
  186. package/dist/workflow/region/update-regions.d.ts.map +1 -0
  187. package/dist/workflow/region/update-regions.js +3 -0
  188. package/dist/workflow/region/update-regions.js.map +1 -0
  189. package/package.json +1 -1
@@ -1,64 +1,78 @@
1
1
  import { BaseFilterable } from "../dal";
2
2
  import { OperatorMap } from "../dal/utils";
3
+ /**
4
+ * The adjustment line details.
5
+ */
3
6
  export interface AdjustmentLineDTO {
4
7
  /**
5
8
  * The ID of the adjustment line
6
9
  */
7
10
  id: string;
8
11
  /**
9
- * The code of the adjustment line
12
+ * The code of the promotion that lead to
13
+ * this adjustment.
10
14
  */
11
15
  code?: string;
12
16
  /**
13
- * The amount of the adjustment line
17
+ * The amount to adjust the original amount with.
14
18
  */
15
19
  amount: number;
16
20
  /**
17
- * The ID of the associated cart
21
+ * The ID of the associated cart.
18
22
  */
19
23
  cart_id: string;
20
24
  /**
21
- * The description of the adjustment line
25
+ * The description of the adjustment line.
22
26
  */
23
27
  description?: string;
24
28
  /**
25
- * The ID of the associated promotion
29
+ * The ID of the associated promotion.
26
30
  */
27
31
  promotion_id?: string;
28
32
  /**
29
- * The ID of the associated provider
33
+ * The ID of the associated provider.
30
34
  */
31
35
  provider_id?: string;
32
36
  /**
33
- * When the adjustment line was created
37
+ * When the adjustment line was created.
34
38
  */
35
39
  created_at: Date | string;
36
40
  /**
37
- * When the adjustment line was updated
41
+ * When the adjustment line was updated.
38
42
  */
39
43
  updated_at: Date | string;
40
44
  }
45
+ /**
46
+ * The shipping method adjustment details.
47
+ */
41
48
  export interface ShippingMethodAdjustmentDTO extends AdjustmentLineDTO {
42
49
  /**
43
- * The associated shipping method
50
+ * The associated shipping method.
44
51
  */
45
52
  shipping_method: CartShippingMethodDTO;
46
53
  /**
47
- * The ID of the associated shipping method
54
+ * The ID of the associated shipping method.
48
55
  */
49
56
  shipping_method_id: string;
50
57
  }
58
+ /**
59
+ * The line item adjustment details.
60
+ */
51
61
  export interface LineItemAdjustmentDTO extends AdjustmentLineDTO {
52
62
  /**
53
- * The associated line item
63
+ * The associated line item.
64
+ *
54
65
  * @expandable
55
66
  */
56
67
  item: CartLineItemDTO;
57
68
  /**
58
- * The associated line item
69
+ * The ID of the associated line item.
59
70
  */
60
71
  item_id: string;
61
72
  }
73
+ /**
74
+ * The tax line details.
75
+ */
62
76
  export interface TaxLineDTO {
63
77
  /**
64
78
  * The ID of the tax line
@@ -69,97 +83,106 @@ export interface TaxLineDTO {
69
83
  */
70
84
  description?: string;
71
85
  /**
72
- * The ID of the associated tax rate
86
+ * The ID of the associated tax rate.
73
87
  */
74
88
  tax_rate_id?: string;
75
89
  /**
76
- * The code of the tax line
90
+ * The code of the tax line.
77
91
  */
78
92
  code: string;
79
93
  /**
80
- * The rate of the tax line
94
+ * The rate of the tax line.
81
95
  */
82
96
  rate: number;
83
97
  /**
84
- * The ID of the associated provider
98
+ * The ID of the associated provider.
85
99
  */
86
100
  provider_id?: string;
87
101
  /**
88
- * When the tax line was created
102
+ * When the tax line was created.
89
103
  */
90
104
  created_at: Date | string;
91
105
  /**
92
- * When the tax line was updated
106
+ * When the tax line was updated.
93
107
  */
94
108
  updated_at: Date | string;
95
109
  }
110
+ /**
111
+ * The shipping method tax line details.
112
+ */
96
113
  export interface ShippingMethodTaxLineDTO extends TaxLineDTO {
97
114
  /**
98
- * The associated shipping method
115
+ * The associated shipping method.
99
116
  */
100
117
  shipping_method: CartShippingMethodDTO;
101
118
  /**
102
- * The ID of the associated shipping method
119
+ * The ID of the associated shipping method.
103
120
  */
104
121
  shipping_method_id: string;
105
122
  }
123
+ /**
124
+ * The line item tax line details.
125
+ */
106
126
  export interface LineItemTaxLineDTO extends TaxLineDTO {
107
127
  /**
108
- * The associated line item
128
+ * The associated line item.
109
129
  */
110
130
  item: CartLineItemDTO;
111
131
  /**
112
- * The ID of the associated line item
132
+ * The ID of the associated line item.
113
133
  */
114
134
  item_id: string;
115
135
  }
136
+ /**
137
+ * The cart address details.
138
+ */
116
139
  export interface CartAddressDTO {
117
140
  /**
118
- * The ID of the address
141
+ * The ID of the address.
119
142
  */
120
143
  id: string;
121
144
  /**
122
- * The customer ID of the address
145
+ * The customer ID of the address.
123
146
  */
124
147
  customer_id?: string;
125
148
  /**
126
- * The first name of the address
149
+ * The first name of the address.
127
150
  */
128
151
  first_name?: string;
129
152
  /**
130
- * The last name of the address
153
+ * The last name of the address.
131
154
  */
132
155
  last_name?: string;
133
156
  /**
134
- * The phone number of the address
157
+ * The phone number of the address.
135
158
  */
136
159
  phone?: string;
137
160
  /**
138
- * The company of the address
161
+ * The company of the address.
139
162
  */
140
163
  company?: string;
141
164
  /**
142
- * The first address line of the address
165
+ * The first address line of the address.
143
166
  */
144
167
  address_1?: string;
145
168
  /**
146
- * The second address line of the address
169
+ * The second address line of the address.
147
170
  */
148
171
  address_2?: string;
149
172
  /**
150
- * The city of the address
173
+ * The city of the address.
151
174
  */
152
175
  city?: string;
153
176
  /**
154
- * The country code of the address
177
+ * The country code of the address.
155
178
  */
156
179
  country_code?: string;
157
180
  /**
158
- * The province/state of the address
181
+ * The province/state of the address.
159
182
  */
160
183
  province?: string;
161
184
  /**
162
- * The postal code of the address
185
+ * The postal code of the address.
163
186
  */
164
187
  postal_code?: string;
165
188
  /**
@@ -175,33 +198,36 @@ export interface CartAddressDTO {
175
198
  */
176
199
  updated_at: Date | string;
177
200
  }
201
+ /**
202
+ * The cart shipping method details.
203
+ */
178
204
  export interface CartShippingMethodDTO {
179
205
  /**
180
- * The ID of the shipping method
206
+ * The ID of the shipping method.
181
207
  */
182
208
  id: string;
183
209
  /**
184
- * The ID of the associated cart
210
+ * The ID of the associated cart.
185
211
  */
186
212
  cart_id: string;
187
213
  /**
188
- * The name of the shipping method
214
+ * The name of the shipping method.
189
215
  */
190
216
  name: string;
191
217
  /**
192
- * The description of the shipping method
218
+ * The description of the shipping method.
193
219
  */
194
220
  description?: string;
195
221
  /**
196
- * The price of the shipping method
222
+ * The price of the shipping method.
197
223
  */
198
224
  amount: number;
199
225
  /**
200
- * Whether the shipping method price is tax inclusive or not
226
+ * Whether the shipping method price is tax inclusive.
201
227
  */
202
228
  is_tax_inclusive: boolean;
203
229
  /**
204
- * The ID of the shipping option the method was created from
230
+ * The ID of the shipping option the method was created from.
205
231
  */
206
232
  shipping_option_id?: string;
207
233
  /**
@@ -232,28 +258,91 @@ export interface CartShippingMethodDTO {
232
258
  * When the shipping method was updated.
233
259
  */
234
260
  updated_at: Date | string;
261
+ /**
262
+ * The original total of the cart shipping method.
263
+ */
235
264
  original_total: number;
265
+ /**
266
+ * The original subtotal of the cart shipping method.
267
+ */
236
268
  original_subtotal: number;
269
+ /**
270
+ * The original tax total of the cart shipping method.
271
+ */
237
272
  original_tax_total: number;
273
+ /**
274
+ * The total of the cart shipping method.
275
+ */
238
276
  total: number;
277
+ /**
278
+ * The subtotal of the cart shipping method.
279
+ */
239
280
  subtotal: number;
281
+ /**
282
+ * The tax total of the cart shipping method.
283
+ */
240
284
  tax_total: number;
285
+ /**
286
+ * The discount total of the cart shipping method.
287
+ */
241
288
  discount_total: number;
289
+ /**
290
+ * The discount tax total of the cart shipping method.
291
+ */
242
292
  discount_tax_total: number;
243
293
  }
294
+ /**
295
+ * The cart line item totals details.
296
+ */
244
297
  export interface CartLineItemTotalsDTO {
298
+ /**
299
+ * The original total of the cart line item.
300
+ */
245
301
  original_total: number;
302
+ /**
303
+ * The original subtotal of the cart line item.
304
+ */
246
305
  original_subtotal: number;
306
+ /**
307
+ * The original tax total of the cart line item.
308
+ */
247
309
  original_tax_total: number;
310
+ /**
311
+ * The item total of the cart line item.
312
+ */
248
313
  item_total: number;
314
+ /**
315
+ * The item subtotal of the cart line item.
316
+ */
249
317
  item_subtotal: number;
318
+ /**
319
+ * The item tax total of the cart line item.
320
+ */
250
321
  item_tax_total: number;
322
+ /**
323
+ * The total of the cart line item.
324
+ */
251
325
  total: number;
326
+ /**
327
+ * The subtotal of the cart line item.
328
+ */
252
329
  subtotal: number;
330
+ /**
331
+ * The tax total of the cart line item.
332
+ */
253
333
  tax_total: number;
334
+ /**
335
+ * The discount total of the cart line item.
336
+ */
254
337
  discount_total: number;
338
+ /**
339
+ * The discount tax total of the cart line item.
340
+ */
255
341
  discount_tax_total: number;
256
342
  }
343
+ /**
344
+ * The cart line item details.
345
+ */
257
346
  export interface CartLineItemDTO extends CartLineItemTotalsDTO {
258
347
  /**
259
348
  * The ID of the line item.
@@ -268,79 +357,79 @@ export interface CartLineItemDTO extends CartLineItemTotalsDTO {
268
357
  */
269
358
  subtitle?: string;
270
359
  /**
271
- * The url of the line item thumbnail.
360
+ * The line item's thumbnail.
272
361
  */
273
362
  thumbnail?: string;
274
363
  /**
275
- * The line item quantity
364
+ * The line item's quantity in the cart.
276
365
  */
277
366
  quantity: number;
278
367
  /**
279
- * The product ID of the line item.
368
+ * The ID of the associated product.
280
369
  */
281
370
  product_id?: string;
282
371
  /**
283
- * The product title of the line item.
372
+ * The title of the associated product.
284
373
  */
285
374
  product_title?: string;
286
375
  /**
287
- * The product description of the line item.
376
+ * The description of the associated product.
288
377
  */
289
378
  product_description?: string;
290
379
  /**
291
- * The product subtitle of the line item.
380
+ * The subtitle of the associated product.
292
381
  */
293
382
  product_subtitle?: string;
294
383
  /**
295
- * The product type of the line item.
384
+ * The type of the associated product.
296
385
  */
297
386
  product_type?: string;
298
387
  /**
299
- * The product collection of the line item.
388
+ * The collection of the associated product.
300
389
  */
301
390
  product_collection?: string;
302
391
  /**
303
- * The product handle of the line item.
392
+ * The handle of the associated product.
304
393
  */
305
394
  product_handle?: string;
306
395
  /**
307
- * The variant ID of the line item.
396
+ * The associated variant's ID of the line item.
308
397
  */
309
398
  variant_id?: string;
310
399
  /**
311
- * The variant sku of the line item.
400
+ * The sku of the associated variant.
312
401
  */
313
402
  variant_sku?: string;
314
403
  /**
315
- * The variant barcode of the line item.
404
+ * The barcode of the associated variant.
316
405
  */
317
406
  variant_barcode?: string;
318
407
  /**
319
- * The variant title of the line item.
408
+ * The title of the associated variant.
320
409
  */
321
410
  variant_title?: string;
322
411
  /**
323
- * The variant option values of the line item.
412
+ * The option values of the associated variant.
324
413
  */
325
414
  variant_option_values?: Record<string, unknown>;
326
415
  /**
327
- * Whether the line item requires shipping or not
416
+ * Whether the line item requires shipping.
328
417
  */
329
418
  requires_shipping: boolean;
330
419
  /**
331
- * Whether the line item is discountable or not
420
+ * Whether the line item is discountable.
332
421
  */
333
422
  is_discountable: boolean;
334
423
  /**
335
- * Whether the line item price is tax inclusive or not
424
+ * Whether the line item price is tax inclusive.
336
425
  */
337
426
  is_tax_inclusive: boolean;
338
427
  /**
339
- * The original price of the item before an adjustment or a sale.
428
+ * The calculated price of the line item.
340
429
  */
341
430
  compare_at_unit_price?: number;
342
431
  /**
343
- * The price of the item
432
+ * The unit price of the item.
344
433
  */
345
434
  unit_price: number;
346
435
  /**
@@ -382,6 +471,9 @@ export interface CartLineItemDTO extends CartLineItemTotalsDTO {
382
471
  */
383
472
  deleted_at?: Date;
384
473
  }
474
+ /**
475
+ * The cart details.
476
+ */
385
477
  export interface CartDTO {
386
478
  /**
387
479
  * The ID of the cart.
@@ -392,7 +484,7 @@ export interface CartDTO {
392
484
  */
393
485
  region_id?: string;
394
486
  /**
395
- * The ID of the customer on the cart.
487
+ * The ID of the associated customer
396
488
  */
397
489
  customer_id?: string;
398
490
  /**
@@ -400,7 +492,7 @@ export interface CartDTO {
400
492
  */
401
493
  sales_channel_id?: string;
402
494
  /**
403
- * The email of the cart.
495
+ * The email of the customer that owns the cart.
404
496
  */
405
497
  email?: string;
406
498
  /**
@@ -443,115 +535,404 @@ export interface CartDTO {
443
535
  * When the cart was updated.
444
536
  */
445
537
  updated_at?: string | Date;
538
+ /**
539
+ * The original item total of the cart.
540
+ */
446
541
  original_item_total: number;
542
+ /**
543
+ * The original item subtotal of the cart.
544
+ */
447
545
  original_item_subtotal: number;
546
+ /**
547
+ * The original item tax total of the cart.
548
+ */
448
549
  original_item_tax_total: number;
550
+ /**
551
+ * The item total of the cart.
552
+ */
449
553
  item_total: number;
554
+ /**
555
+ * The item subtotal of the cart.
556
+ */
450
557
  item_subtotal: number;
558
+ /**
559
+ * The item tax total of the cart.
560
+ */
451
561
  item_tax_total: number;
562
+ /**
563
+ * The original total of the cart.
564
+ */
452
565
  original_total: number;
566
+ /**
567
+ * The original subtotal of the cart.
568
+ */
453
569
  original_subtotal: number;
570
+ /**
571
+ * The original tax total of the cart.
572
+ */
454
573
  original_tax_total: number;
574
+ /**
575
+ * The total of the cart.
576
+ */
455
577
  total: number;
578
+ /**
579
+ * The subtotal of the cart.
580
+ */
456
581
  subtotal: number;
582
+ /**
583
+ * The tax total of the cart.
584
+ */
457
585
  tax_total: number;
586
+ /**
587
+ * The discount total of the cart.
588
+ */
458
589
  discount_total: number;
590
+ /**
591
+ * The raw discount total of the cart.
592
+ */
459
593
  raw_discount_total: any;
594
+ /**
595
+ * The discount tax total of the cart.
596
+ */
460
597
  discount_tax_total: number;
598
+ /**
599
+ * The gift card total of the cart.
600
+ */
461
601
  gift_card_total: number;
602
+ /**
603
+ * The gift card tax total of the cart.
604
+ */
462
605
  gift_card_tax_total: number;
606
+ /**
607
+ * The shipping total of the cart.
608
+ */
463
609
  shipping_total: number;
610
+ /**
611
+ * The shipping subtotal of the cart.
612
+ */
464
613
  shipping_subtotal: number;
614
+ /**
615
+ * The shipping tax total of the cart.
616
+ */
465
617
  shipping_tax_total: number;
618
+ /**
619
+ * The original shipping total of the cart.
620
+ */
466
621
  original_shipping_total: number;
622
+ /**
623
+ * The original shipping subtotal of the cart.
624
+ */
467
625
  original_shipping_subtotal: number;
626
+ /**
627
+ * The original shipping tax total of the cart.
628
+ */
468
629
  original_shipping_tax_total: number;
469
630
  }
631
+ /**
632
+ * The filters to apply on the retrieved carts.
633
+ */
470
634
  export interface FilterableCartProps extends BaseFilterable<FilterableCartProps> {
635
+ /**
636
+ * The IDs to filter the carts by.
637
+ */
471
638
  id?: string | string[];
639
+ /**
640
+ * Filter the carts by the ID of their associated sales channel.
641
+ */
472
642
  sales_channel_id?: string | string[] | OperatorMap<string>;
643
+ /**
644
+ * Filter the carts by the ID of their associated customer.
645
+ */
473
646
  customer_id?: string | string[] | OperatorMap<string>;
647
+ /**
648
+ * Filter the carts by the ID of their associated region.
649
+ */
474
650
  region_id?: string | string[] | OperatorMap<string>;
651
+ /**
652
+ * Filter the carts by their creation date.
653
+ */
475
654
  created_at?: OperatorMap<string>;
655
+ /**
656
+ * Filter the carts by their update date.
657
+ */
476
658
  updated_at?: OperatorMap<string>;
477
659
  }
660
+ /**
661
+ * The filters to apply on the retrieved addresss.
662
+ */
478
663
  export interface FilterableAddressProps extends BaseFilterable<FilterableAddressProps> {
664
+ /**
665
+ * The IDs to filter the addresss by.
666
+ */
479
667
  id?: string | string[];
480
668
  }
669
+ /**
670
+ * The filters to apply on the retrieved line items.
671
+ */
481
672
  export interface FilterableLineItemProps extends BaseFilterable<FilterableLineItemProps> {
673
+ /**
674
+ * The IDs to filter the line items by.
675
+ */
482
676
  id?: string | string[];
677
+ /**
678
+ * Filter the line items by the ID of their associated cart.
679
+ */
483
680
  cart_id?: string | string[];
681
+ /**
682
+ * Filter the line items by their title.
683
+ */
484
684
  title?: string;
685
+ /**
686
+ * Filter the line items by the ID of their associated variant.
687
+ */
485
688
  variant_id?: string | string[];
689
+ /**
690
+ * Filter the line items by the ID of their associated product.
691
+ */
486
692
  product_id?: string | string[];
487
693
  }
694
+ /**
695
+ * The filters to apply on the retrieved line item adjustments.
696
+ */
488
697
  export interface FilterableLineItemAdjustmentProps extends BaseFilterable<FilterableLineItemAdjustmentProps> {
698
+ /**
699
+ * The IDs to filter the line item adjustments by.
700
+ */
489
701
  id?: string | string[];
702
+ /**
703
+ * Filter the adjustments by the ID of their associated line item.
704
+ */
490
705
  item_id?: string | string[];
706
+ /**
707
+ * Filter the line item adjustments by the ID of their associated promotion.
708
+ */
491
709
  promotion_id?: string | string[];
710
+ /**
711
+ * Filter the line item adjustments by the ID of their associated provider.
712
+ */
492
713
  provider_id?: string | string[];
714
+ /**
715
+ * Filter the adjustments by their associated line item.
716
+ */
493
717
  item?: FilterableLineItemProps;
494
718
  }
719
+ /**
720
+ * The filters to apply on the retrieved shipping methods.
721
+ */
495
722
  export interface FilterableShippingMethodProps extends BaseFilterable<FilterableShippingMethodProps> {
723
+ /**
724
+ * The IDs to filter the shipping methods by.
725
+ */
496
726
  id?: string | string[];
727
+ /**
728
+ * Filter the shipping methods by the ID of their associated cart.
729
+ */
497
730
  cart_id?: string | string[];
731
+ /**
732
+ * Filter the shipping methods by their name.
733
+ */
498
734
  name?: string;
735
+ /**
736
+ * Filter the shipping methods by the ID of their associated shipping option.
737
+ */
499
738
  shipping_option_id?: string | string[];
500
739
  }
740
+ /**
741
+ * The filters to apply on the retrieved shipping method adjustments.
742
+ */
501
743
  export interface FilterableShippingMethodAdjustmentProps extends BaseFilterable<FilterableShippingMethodAdjustmentProps> {
744
+ /**
745
+ * The IDs to filter the shipping method adjustments by.
746
+ */
502
747
  id?: string | string[];
748
+ /**
749
+ * Filter the adjustments by the ID of their associated shipping method.
750
+ */
503
751
  shipping_method_id?: string | string[];
752
+ /**
753
+ * Filter the shipping method adjustments by the ID of their associated promotion.
754
+ */
504
755
  promotion_id?: string | string[];
756
+ /**
757
+ * Filter the shipping method adjustments by the ID of their associated provider.
758
+ */
505
759
  provider_id?: string | string[];
760
+ /**
761
+ * Filter the adjustments by their associated shipping method.
762
+ */
506
763
  shipping_method?: FilterableShippingMethodProps;
507
764
  }
765
+ /**
766
+ * The filters to apply on the retrieved line item tax lines.
767
+ */
508
768
  export interface FilterableLineItemTaxLineProps extends BaseFilterable<FilterableLineItemTaxLineProps> {
769
+ /**
770
+ * The IDs to filter the line item tax lines by.
771
+ */
509
772
  id?: string | string[];
773
+ /**
774
+ * Filter the line item tax lines by their description.
775
+ */
510
776
  description?: string;
777
+ /**
778
+ * Filter the line item tax lines by their code.
779
+ */
511
780
  code?: string | string[];
781
+ /**
782
+ * Filter the line item tax lines by the ID of their associated tax rate.
783
+ */
512
784
  tax_rate_id?: string | string[];
785
+ /**
786
+ * Filter the line item tax lines by the ID of their associated provider.
787
+ */
513
788
  provider_id?: string | string[];
789
+ /**
790
+ * Filter the tax lines by the ID of their associated line item.
791
+ */
514
792
  item_id?: string | string[];
793
+ /**
794
+ * Filter the tax lines by their associated line item.
795
+ */
515
796
  item?: FilterableLineItemProps;
516
797
  }
798
+ /**
799
+ * The filters to apply on the retrieved shipping method tax lines.
800
+ */
517
801
  export interface FilterableShippingMethodTaxLineProps extends BaseFilterable<FilterableShippingMethodTaxLineProps> {
802
+ /**
803
+ * The IDs to filter the shipping method tax lines by.
804
+ */
518
805
  id?: string | string[];
806
+ /**
807
+ * Filter the shipping method tax lines by their description.
808
+ */
519
809
  description?: string;
810
+ /**
811
+ * Filter the shipping method tax lines by their code.
812
+ */
520
813
  code?: string | string[];
814
+ /**
815
+ * Filter the shipping method tax lines by the ID of their associated tax rate.
816
+ */
521
817
  tax_rate_id?: string | string[];
818
+ /**
819
+ * Filter the shipping method tax lines by the ID of their associated provider.
820
+ */
522
821
  provider_id?: string | string[];
822
+ /**
823
+ * Filter the tax lines by the ID of their associated shipping method.
824
+ */
523
825
  shipping_method_id?: string | string[];
826
+ /**
827
+ * Filter the tax lines by their associated shipping method.
828
+ */
524
829
  shipping_method?: FilterableShippingMethodProps;
525
830
  }
526
831
  /**
527
832
  * TODO: Remove this in favor of CartDTO, when module is released
833
+ *
528
834
  * @deprecated Use CartDTO instead
529
835
  */
530
836
  export type legacy_CartDTO = {
837
+ /**
838
+ * The ID of the cart.
839
+ */
531
840
  id?: string;
841
+ /**
842
+ * The email of the cart.
843
+ */
532
844
  email?: string;
845
+ /**
846
+ * The associated billing address's ID.
847
+ */
533
848
  billing_address_id?: string;
849
+ /**
850
+ * The associated shipping address's ID.
851
+ */
534
852
  shipping_address_id?: string;
853
+ /**
854
+ * The associated region's ID.
855
+ */
535
856
  region_id?: string;
857
+ /**
858
+ * The associated customer's ID.
859
+ */
536
860
  customer_id?: string;
861
+ /**
862
+ * The associated payment's ID.
863
+ */
537
864
  payment_id?: string;
865
+ /**
866
+ * The associated date.
867
+ */
538
868
  completed_at?: Date;
869
+ /**
870
+ * The associated date.
871
+ */
539
872
  payment_authorized_at?: Date;
873
+ /**
874
+ * The idempotency key of the cart.
875
+ */
540
876
  idempotency_key?: string;
877
+ /**
878
+ * The context of the cart.
879
+ */
541
880
  context?: Record<string, unknown>;
881
+ /**
882
+ * Holds custom data in key-value pairs.
883
+ */
542
884
  metadata?: Record<string, unknown>;
885
+ /**
886
+ * The associated sales channel's ID.
887
+ */
543
888
  sales_channel_id?: string | null;
889
+ /**
890
+ * The shipping total of the cart.
891
+ */
544
892
  shipping_total?: number;
893
+ /**
894
+ * The discount total of the cart.
895
+ */
545
896
  discount_total?: number;
897
+ /**
898
+ * The raw discount total of the cart.
899
+ */
546
900
  raw_discount_total?: number;
901
+ /**
902
+ * The item tax total of the cart.
903
+ */
547
904
  item_tax_total?: number | null;
905
+ /**
906
+ * The shipping tax total of the cart.
907
+ */
548
908
  shipping_tax_total?: number | null;
909
+ /**
910
+ * The tax total of the cart.
911
+ */
549
912
  tax_total?: number | null;
913
+ /**
914
+ * The refunded total of the cart.
915
+ */
550
916
  refunded_total?: number;
917
+ /**
918
+ * The total of the cart.
919
+ */
551
920
  total?: number;
921
+ /**
922
+ * The subtotal of the cart.
923
+ */
552
924
  subtotal?: number;
925
+ /**
926
+ * The refundable amount of the cart.
927
+ */
553
928
  refundable_amount?: number;
929
+ /**
930
+ * The gift card total of the cart.
931
+ */
554
932
  gift_card_total?: number;
933
+ /**
934
+ * The gift card tax total of the cart.
935
+ */
555
936
  gift_card_tax_total?: number;
556
937
  };
557
938
  //# sourceMappingURL=common.d.ts.map