@medusajs/types 1.12.0-snapshot-20240406075900 → 1.12.0-snapshot-20240409114424

Sign up to get free protection for your applications and to get access to all the features.
Files changed (242) hide show
  1. package/dist/cart/common.d.ts +64 -47
  2. package/dist/cart/common.d.ts.map +1 -1
  3. package/dist/cart/mutations.d.ts +14 -13
  4. package/dist/cart/mutations.d.ts.map +1 -1
  5. package/dist/cart/mutations.js.map +1 -1
  6. package/dist/cart/workflows.d.ts +6 -5
  7. package/dist/cart/workflows.d.ts.map +1 -1
  8. package/dist/common/rule.d.ts +3 -0
  9. package/dist/common/rule.d.ts.map +1 -1
  10. package/dist/customer/common.d.ts +21 -13
  11. package/dist/customer/common.d.ts.map +1 -1
  12. package/dist/customer/mutations.d.ts +13 -13
  13. package/dist/customer/mutations.d.ts.map +1 -1
  14. package/dist/dal/repository-service.d.ts +1 -1
  15. package/dist/dal/repository-service.d.ts.map +1 -1
  16. package/dist/file/index.d.ts +1 -0
  17. package/dist/file/index.d.ts.map +1 -1
  18. package/dist/file/index.js +1 -0
  19. package/dist/file/index.js.map +1 -1
  20. package/dist/file/provider.d.ts +100 -0
  21. package/dist/file/provider.d.ts.map +1 -0
  22. package/dist/file/provider.js +3 -0
  23. package/dist/file/provider.js.map +1 -0
  24. package/dist/fulfillment/common/address.d.ts +51 -0
  25. package/dist/fulfillment/common/address.d.ts.map +1 -1
  26. package/dist/fulfillment/common/fulfillment-item.d.ts +39 -0
  27. package/dist/fulfillment/common/fulfillment-item.d.ts.map +1 -1
  28. package/dist/fulfillment/common/fulfillment-label.d.ts +30 -0
  29. package/dist/fulfillment/common/fulfillment-label.d.ts.map +1 -1
  30. package/dist/fulfillment/common/fulfillment-provider.d.ts +24 -0
  31. package/dist/fulfillment/common/fulfillment-provider.d.ts.map +1 -1
  32. package/dist/fulfillment/common/fulfillment-set.d.ts +42 -0
  33. package/dist/fulfillment/common/fulfillment-set.d.ts.map +1 -1
  34. package/dist/fulfillment/common/fulfillment.d.ts +91 -0
  35. package/dist/fulfillment/common/fulfillment.d.ts.map +1 -1
  36. package/dist/fulfillment/common/geo-zone.d.ts +54 -0
  37. package/dist/fulfillment/common/geo-zone.d.ts.map +1 -1
  38. package/dist/fulfillment/common/service-zone.d.ts +52 -0
  39. package/dist/fulfillment/common/service-zone.d.ts.map +1 -1
  40. package/dist/fulfillment/common/shipping-option-rule.d.ts +51 -0
  41. package/dist/fulfillment/common/shipping-option-rule.d.ts.map +1 -1
  42. package/dist/fulfillment/common/shipping-option-type.d.ts +45 -0
  43. package/dist/fulfillment/common/shipping-option-type.d.ts.map +1 -1
  44. package/dist/fulfillment/common/shipping-option.d.ts +117 -0
  45. package/dist/fulfillment/common/shipping-option.d.ts.map +1 -1
  46. package/dist/fulfillment/common/shipping-profile.d.ts +42 -0
  47. package/dist/fulfillment/common/shipping-profile.d.ts.map +1 -1
  48. package/dist/fulfillment/mutations/fulfillment-address.d.ts +39 -0
  49. package/dist/fulfillment/mutations/fulfillment-address.d.ts.map +1 -1
  50. package/dist/fulfillment/mutations/fulfillment-item.d.ts +24 -0
  51. package/dist/fulfillment/mutations/fulfillment-item.d.ts.map +1 -1
  52. package/dist/fulfillment/mutations/fulfillment-label.d.ts +15 -0
  53. package/dist/fulfillment/mutations/fulfillment-label.d.ts.map +1 -1
  54. package/dist/fulfillment/mutations/fulfillment-set.d.ts +32 -2
  55. package/dist/fulfillment/mutations/fulfillment-set.d.ts.map +1 -1
  56. package/dist/fulfillment/mutations/fulfillment.d.ts +66 -0
  57. package/dist/fulfillment/mutations/fulfillment.d.ts.map +1 -1
  58. package/dist/fulfillment/mutations/geo-zone.d.ts +123 -0
  59. package/dist/fulfillment/mutations/geo-zone.d.ts.map +1 -1
  60. package/dist/fulfillment/mutations/service-zone.d.ts +33 -1
  61. package/dist/fulfillment/mutations/service-zone.d.ts.map +1 -1
  62. package/dist/fulfillment/mutations/shipping-option-rule.d.ts +21 -0
  63. package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +1 -1
  64. package/dist/fulfillment/mutations/shipping-option-type.d.ts +21 -0
  65. package/dist/fulfillment/mutations/shipping-option-type.d.ts.map +1 -1
  66. package/dist/fulfillment/mutations/shipping-option.d.ts +71 -1
  67. package/dist/fulfillment/mutations/shipping-option.d.ts.map +1 -1
  68. package/dist/fulfillment/mutations/shipping-profile.d.ts +15 -0
  69. package/dist/fulfillment/mutations/shipping-profile.d.ts.map +1 -1
  70. package/dist/fulfillment/service.d.ts +1933 -218
  71. package/dist/fulfillment/service.d.ts.map +1 -1
  72. package/dist/http/api-key/admin/api-key.d.ts +31 -0
  73. package/dist/http/api-key/admin/api-key.d.ts.map +1 -0
  74. package/dist/http/api-key/admin/api-key.js +3 -0
  75. package/dist/http/api-key/admin/api-key.js.map +1 -0
  76. package/dist/http/api-key/admin/index.d.ts +2 -0
  77. package/dist/http/api-key/admin/index.d.ts.map +1 -0
  78. package/dist/http/api-key/admin/index.js +18 -0
  79. package/dist/http/api-key/admin/index.js.map +1 -0
  80. package/dist/http/api-key/index.d.ts +2 -0
  81. package/dist/http/api-key/index.d.ts.map +1 -0
  82. package/dist/http/api-key/index.js +18 -0
  83. package/dist/http/api-key/index.js.map +1 -0
  84. package/dist/http/common/index.d.ts +2 -0
  85. package/dist/http/common/index.d.ts.map +1 -0
  86. package/dist/http/common/index.js +18 -0
  87. package/dist/http/common/index.js.map +1 -0
  88. package/dist/http/common/paginated-response.d.ts +6 -0
  89. package/dist/http/common/paginated-response.d.ts.map +1 -0
  90. package/dist/http/common/paginated-response.js +3 -0
  91. package/dist/http/common/paginated-response.js.map +1 -0
  92. package/dist/http/customer/admin/customer.d.ts +79 -0
  93. package/dist/http/customer/admin/customer.d.ts.map +1 -0
  94. package/dist/http/customer/admin/customer.js +3 -0
  95. package/dist/http/customer/admin/customer.js.map +1 -0
  96. package/dist/http/customer/admin/index.d.ts +2 -0
  97. package/dist/http/customer/admin/index.d.ts.map +1 -0
  98. package/dist/http/customer/admin/index.js +18 -0
  99. package/dist/http/customer/admin/index.js.map +1 -0
  100. package/dist/http/customer/index.d.ts +2 -0
  101. package/dist/http/customer/index.d.ts.map +1 -0
  102. package/dist/http/customer/index.js +18 -0
  103. package/dist/http/customer/index.js.map +1 -0
  104. package/dist/http/fulfillment/admin/fulfillment-set.d.ts +9 -3
  105. package/dist/http/fulfillment/admin/fulfillment-set.d.ts.map +1 -1
  106. package/dist/http/fulfillment/admin/service-zone.d.ts +16 -0
  107. package/dist/http/fulfillment/admin/service-zone.d.ts.map +1 -1
  108. package/dist/http/fulfillment/admin/shipping-option.d.ts +11 -4
  109. package/dist/http/fulfillment/admin/shipping-option.d.ts.map +1 -1
  110. package/dist/http/fulfillment/admin/shipping-profile.d.ts +8 -1
  111. package/dist/http/fulfillment/admin/shipping-profile.d.ts.map +1 -1
  112. package/dist/http/index.d.ts +7 -1
  113. package/dist/http/index.d.ts.map +1 -1
  114. package/dist/http/index.js +7 -1
  115. package/dist/http/index.js.map +1 -1
  116. package/dist/http/pricing/index.d.ts +2 -0
  117. package/dist/http/pricing/index.d.ts.map +1 -0
  118. package/dist/http/pricing/index.js +18 -0
  119. package/dist/http/pricing/index.js.map +1 -0
  120. package/dist/http/pricing/price.d.ts +8 -0
  121. package/dist/http/pricing/price.d.ts.map +1 -0
  122. package/dist/http/pricing/price.js +3 -0
  123. package/dist/http/pricing/price.js.map +1 -0
  124. package/dist/http/product-category/admin/index.d.ts +2 -0
  125. package/dist/http/product-category/admin/index.d.ts.map +1 -0
  126. package/dist/http/product-category/admin/index.js +18 -0
  127. package/dist/http/product-category/admin/index.js.map +1 -0
  128. package/dist/http/product-category/admin/product-category.d.ts +32 -0
  129. package/dist/http/product-category/admin/product-category.d.ts.map +1 -0
  130. package/dist/http/product-category/admin/product-category.js +3 -0
  131. package/dist/http/product-category/admin/product-category.js.map +1 -0
  132. package/dist/http/product-category/index.d.ts +2 -0
  133. package/dist/http/product-category/index.d.ts.map +1 -0
  134. package/dist/http/product-category/index.js +18 -0
  135. package/dist/http/product-category/index.js.map +1 -0
  136. package/dist/http/sales-channel/admin/index.d.ts +2 -0
  137. package/dist/http/sales-channel/admin/index.d.ts.map +1 -0
  138. package/dist/http/sales-channel/admin/index.js +18 -0
  139. package/dist/http/sales-channel/admin/index.js.map +1 -0
  140. package/dist/http/sales-channel/admin/sales-channel.d.ts +25 -0
  141. package/dist/http/sales-channel/admin/sales-channel.d.ts.map +1 -0
  142. package/dist/http/sales-channel/admin/sales-channel.js +3 -0
  143. package/dist/http/sales-channel/admin/sales-channel.js.map +1 -0
  144. package/dist/http/sales-channel/index.d.ts +2 -0
  145. package/dist/http/sales-channel/index.d.ts.map +1 -0
  146. package/dist/http/sales-channel/index.js +18 -0
  147. package/dist/http/sales-channel/index.js.map +1 -0
  148. package/dist/http/tax/admin/index.d.ts +2 -0
  149. package/dist/http/tax/admin/index.d.ts.map +1 -0
  150. package/dist/http/tax/admin/index.js +18 -0
  151. package/dist/http/tax/admin/index.js.map +1 -0
  152. package/dist/http/tax/admin/tax-regions.d.ts +32 -0
  153. package/dist/http/tax/admin/tax-regions.d.ts.map +1 -0
  154. package/dist/http/tax/admin/tax-regions.js +3 -0
  155. package/dist/http/tax/admin/tax-regions.js.map +1 -0
  156. package/dist/http/tax/index.d.ts +2 -0
  157. package/dist/http/tax/index.d.ts.map +1 -0
  158. package/dist/http/tax/index.js +18 -0
  159. package/dist/http/tax/index.js.map +1 -0
  160. package/dist/joiner/index.d.ts +2 -2
  161. package/dist/joiner/index.d.ts.map +1 -1
  162. package/dist/modules-sdk/index.d.ts +12 -10
  163. package/dist/modules-sdk/index.d.ts.map +1 -1
  164. package/dist/order/common.d.ts +111 -45
  165. package/dist/order/common.d.ts.map +1 -1
  166. package/dist/order/index.d.ts +1 -0
  167. package/dist/order/index.d.ts.map +1 -1
  168. package/dist/order/index.js +1 -0
  169. package/dist/order/index.js.map +1 -1
  170. package/dist/order/mutations.d.ts +14 -14
  171. package/dist/order/mutations.d.ts.map +1 -1
  172. package/dist/order/mutations.js.map +1 -1
  173. package/dist/order/service.d.ts +60 -662
  174. package/dist/order/service.d.ts.map +1 -1
  175. package/dist/order/workflows.d.ts +8 -0
  176. package/dist/order/workflows.d.ts.map +1 -0
  177. package/dist/order/workflows.js +3 -0
  178. package/dist/order/workflows.js.map +1 -0
  179. package/dist/payment/common.d.ts +14 -13
  180. package/dist/payment/common.d.ts.map +1 -1
  181. package/dist/payment/common.js.map +1 -1
  182. package/dist/payment/mutations.d.ts +9 -8
  183. package/dist/payment/mutations.d.ts.map +1 -1
  184. package/dist/payment/provider.d.ts +6 -5
  185. package/dist/payment/provider.d.ts.map +1 -1
  186. package/dist/payment/provider.js.map +1 -1
  187. package/dist/payment/service.d.ts +1 -0
  188. package/dist/payment/service.d.ts.map +1 -1
  189. package/dist/pricing/common/money-amount.d.ts +10 -9
  190. package/dist/pricing/common/money-amount.d.ts.map +1 -1
  191. package/dist/pricing/common/price-set.d.ts +9 -8
  192. package/dist/pricing/common/price-set.d.ts.map +1 -1
  193. package/dist/pricing/common/price.d.ts +10 -9
  194. package/dist/pricing/common/price.d.ts.map +1 -1
  195. package/dist/pricing/workflows.d.ts +10 -20
  196. package/dist/pricing/workflows.d.ts.map +1 -1
  197. package/dist/product/common.d.ts +26 -40
  198. package/dist/product/common.d.ts.map +1 -1
  199. package/dist/promotion/http.d.ts +14 -0
  200. package/dist/promotion/http.d.ts.map +1 -0
  201. package/dist/promotion/http.js +3 -0
  202. package/dist/promotion/http.js.map +1 -0
  203. package/dist/promotion/index.d.ts +1 -0
  204. package/dist/promotion/index.d.ts.map +1 -1
  205. package/dist/promotion/index.js +1 -0
  206. package/dist/promotion/index.js.map +1 -1
  207. package/dist/region/common.d.ts +5 -0
  208. package/dist/region/common.d.ts.map +1 -1
  209. package/dist/region/mutations.d.ts +4 -0
  210. package/dist/region/mutations.d.ts.map +1 -1
  211. package/dist/tax/common.d.ts +4 -3
  212. package/dist/tax/common.d.ts.map +1 -1
  213. package/dist/totals/big-number.d.ts +1 -0
  214. package/dist/totals/big-number.d.ts.map +1 -1
  215. package/dist/totals/index.d.ts +24 -0
  216. package/dist/totals/index.d.ts.map +1 -1
  217. package/dist/totals/index.js.map +1 -1
  218. package/dist/workflow/fulfillment/create-shipping-options.d.ts +31 -0
  219. package/dist/workflow/fulfillment/create-shipping-options.d.ts.map +1 -0
  220. package/dist/workflow/fulfillment/create-shipping-options.js +3 -0
  221. package/dist/workflow/fulfillment/create-shipping-options.js.map +1 -0
  222. package/dist/workflow/fulfillment/index.d.ts +5 -0
  223. package/dist/workflow/fulfillment/index.d.ts.map +1 -0
  224. package/dist/workflow/fulfillment/index.js +21 -0
  225. package/dist/workflow/fulfillment/index.js.map +1 -0
  226. package/dist/workflow/fulfillment/service-zones.d.ts +21 -0
  227. package/dist/workflow/fulfillment/service-zones.d.ts.map +1 -0
  228. package/dist/workflow/fulfillment/service-zones.js +3 -0
  229. package/dist/workflow/fulfillment/service-zones.js.map +1 -0
  230. package/dist/workflow/fulfillment/shipping-profiles.d.ts +18 -0
  231. package/dist/workflow/fulfillment/shipping-profiles.d.ts.map +1 -0
  232. package/dist/workflow/fulfillment/shipping-profiles.js +3 -0
  233. package/dist/workflow/fulfillment/shipping-profiles.js.map +1 -0
  234. package/dist/workflow/fulfillment/update-shipping-options.d.ts +32 -0
  235. package/dist/workflow/fulfillment/update-shipping-options.d.ts.map +1 -0
  236. package/dist/workflow/fulfillment/update-shipping-options.js +3 -0
  237. package/dist/workflow/fulfillment/update-shipping-options.js.map +1 -0
  238. package/dist/workflow/index.d.ts +1 -0
  239. package/dist/workflow/index.d.ts.map +1 -1
  240. package/dist/workflow/index.js +2 -1
  241. package/dist/workflow/index.js.map +1 -1
  242. package/package.json +1 -1
@@ -1,19 +1,61 @@
1
1
  import { FilterableShippingOptionProps, ShippingOptionDTO } from "./shipping-option";
2
2
  import { BaseFilterable, OperatorMap } from "../../dal";
3
+ /**
4
+ * The shipping profile details.
5
+ */
3
6
  export interface ShippingProfileDTO {
7
+ /**
8
+ * The ID of the shipping profile.
9
+ */
4
10
  id: string;
11
+ /**
12
+ * The name of the shipping profile.
13
+ */
5
14
  name: string;
15
+ /**
16
+ * The type of the shipping profile.
17
+ */
6
18
  type: string;
19
+ /**
20
+ * Holds custom data in key-value pairs.
21
+ */
7
22
  metadata: Record<string, unknown> | null;
23
+ /**
24
+ * The shipping options associated with the shipping profile.
25
+ */
8
26
  shipping_options: ShippingOptionDTO[];
27
+ /**
28
+ * The creation date of the shipping profile.
29
+ */
9
30
  created_at: Date;
31
+ /**
32
+ * The update date of the shipping profile.
33
+ */
10
34
  updated_at: Date;
35
+ /**
36
+ * The deletion date of the shipping profile.
37
+ */
11
38
  deleted_at: Date | null;
12
39
  }
40
+ /**
41
+ * The filters to apply on the retrieved shipping profiles.
42
+ */
13
43
  export interface FilterableShippingProfileProps extends BaseFilterable<FilterableShippingProfileProps> {
44
+ /**
45
+ * The IDs to filter the shipping profiles by.
46
+ */
14
47
  id?: string | string[] | OperatorMap<string | string[]>;
48
+ /**
49
+ * Filter the shipping profiles by their name.
50
+ */
15
51
  name?: string | string[] | OperatorMap<string | string[]>;
52
+ /**
53
+ * Filter the shipping profiles by their type.
54
+ */
16
55
  type?: string | string[] | OperatorMap<string | string[]>;
56
+ /**
57
+ * The filters to apply on the retrieved shipping options.
58
+ */
17
59
  shipping_options?: FilterableShippingOptionProps;
18
60
  }
19
61
  //# sourceMappingURL=shipping-profile.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,8BACf,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IACtD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,gBAAgB,CAAC,EAAE,6BAA6B,CAAA;CACjD"}
1
+ {"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IAErC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,8BACf,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IACtD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAA;CACjD"}
@@ -1,15 +1,54 @@
1
+ /**
2
+ * The fulfillment address to be created.
3
+ */
1
4
  export interface CreateFulfillmentAddressDTO {
5
+ /**
6
+ * The associated fulfillment's ID.
7
+ */
2
8
  fulfillment_id: string;
9
+ /**
10
+ * The company of the fulfillment address.
11
+ */
3
12
  company?: string | null;
13
+ /**
14
+ * The first name of the fulfillment address.
15
+ */
4
16
  first_name?: string | null;
17
+ /**
18
+ * The last name of the fulfillment address.
19
+ */
5
20
  last_name?: string | null;
21
+ /**
22
+ * The first line of the fulfillment address.
23
+ */
6
24
  address_1?: string | null;
25
+ /**
26
+ * The second line of the fulfillment address.
27
+ */
7
28
  address_2?: string | null;
29
+ /**
30
+ * The city of the fulfillment address.
31
+ */
8
32
  city?: string | null;
33
+ /**
34
+ * The ISO 2 character country code of the fulfillment address.
35
+ */
9
36
  country_code?: string | null;
37
+ /**
38
+ * The province of the fulfillment address.
39
+ */
10
40
  province?: string | null;
41
+ /**
42
+ * The postal code of the fulfillment address.
43
+ */
11
44
  postal_code?: string | null;
45
+ /**
46
+ * The phone of the fulfillment address.
47
+ */
12
48
  phone?: string | null;
49
+ /**
50
+ * Holds custom data in key-value pairs.
51
+ */
13
52
  metadata?: Record<string, unknown> | null;
14
53
  }
15
54
  //# sourceMappingURL=fulfillment-address.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fulfillment-address.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-address.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
1
+ {"version":3,"file":"fulfillment-address.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-address.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
@@ -1,10 +1,34 @@
1
+ /**
2
+ * The fulfillment item to be created.
3
+ */
1
4
  export interface CreateFulfillmentItemDTO {
5
+ /**
6
+ * The associated fulfillment's ID.
7
+ */
2
8
  fulfillment_id: string;
9
+ /**
10
+ * The title of the fulfillment item.
11
+ */
3
12
  title: string;
13
+ /**
14
+ * The SKU of the fulfillment item.
15
+ */
4
16
  sku: string;
17
+ /**
18
+ * The quantity of the fulfillment item.
19
+ */
5
20
  quantity: number;
21
+ /**
22
+ * The barcode of the fulfillment item.
23
+ */
6
24
  barcode: string;
25
+ /**
26
+ * The associated line item's ID.
27
+ */
7
28
  line_item_id?: string | null;
29
+ /**
30
+ * The associated inventory item's ID.
31
+ */
8
32
  inventory_item_id?: string | null;
9
33
  }
10
34
  //# sourceMappingURL=fulfillment-item.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fulfillment-item.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-item.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC"}
1
+ {"version":3,"file":"fulfillment-item.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-item.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC"}
@@ -1,7 +1,22 @@
1
+ /**
2
+ * The fulfillment label to be created.
3
+ */
1
4
  export interface CreateFulfillmentLabelDTO {
5
+ /**
6
+ * The tracking number of the fulfillment label.
7
+ */
2
8
  tracking_number: string;
9
+ /**
10
+ * The tracking URL of the fulfillment label.
11
+ */
3
12
  tracking_url: string;
13
+ /**
14
+ * The URL of the label.
15
+ */
4
16
  label_url: string;
17
+ /**
18
+ * The associated fulfillment's ID.
19
+ */
5
20
  fulfillment_id: string;
6
21
  }
7
22
  //# sourceMappingURL=fulfillment-label.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fulfillment-label.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-label.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;CACvB"}
1
+ {"version":3,"file":"fulfillment-label.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-label.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;CACvB"}
@@ -1,14 +1,44 @@
1
1
  import { CreateServiceZoneDTO } from "./service-zone";
2
+ /**
3
+ * The fulfillment set to be created.
4
+ */
2
5
  export interface CreateFulfillmentSetDTO {
6
+ /**
7
+ * The name of the fulfillment set.
8
+ */
3
9
  name: string;
10
+ /**
11
+ * The type of the fulfillment set.
12
+ */
4
13
  type: string;
5
- service_zones?: Omit<CreateServiceZoneDTO, 'fulfillment_set_id'>[];
14
+ /**
15
+ * The service zones associated with the fulfillment set.
16
+ */
17
+ service_zones?: Omit<CreateServiceZoneDTO, "fulfillment_set_id">[];
6
18
  }
19
+ /**
20
+ * The attributes to update in the fulfillment set.
21
+ */
7
22
  export interface UpdateFulfillmentSetDTO {
23
+ /**
24
+ * The ID of the fulfillment set.
25
+ */
8
26
  id: string;
27
+ /**
28
+ * The name of the fulfillment set.
29
+ */
9
30
  name?: string;
31
+ /**
32
+ * The type of the fulfillment set.
33
+ */
10
34
  type?: string;
11
- service_zones?: (Omit<CreateServiceZoneDTO, 'fulfillment_set_id'> | {
35
+ /**
36
+ * The service zones associated with the fulfillment set.
37
+ */
38
+ service_zones?: (Omit<CreateServiceZoneDTO, "fulfillment_set_id"> | {
39
+ /**
40
+ * The ID of the service zone.
41
+ */
12
42
  id: string;
13
43
  })[];
14
44
  }
@@ -1 +1 @@
1
- {"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,CAAA;CACnE;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACtF"}
1
+ {"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,CAAA;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,CACZ,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAChD;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ"}
@@ -1,29 +1,95 @@
1
1
  import { CreateFulfillmentAddressDTO } from "./fulfillment-address";
2
2
  import { CreateFulfillmentItemDTO } from "./fulfillment-item";
3
3
  import { CreateFulfillmentLabelDTO } from "./fulfillment-label";
4
+ /**
5
+ * The fulfillment order to be created.
6
+ */
4
7
  export interface CreateFulfillmentOrderDTO {
5
8
  }
9
+ /**
10
+ * The fulfillment to be created.
11
+ */
6
12
  export interface CreateFulfillmentDTO {
13
+ /**
14
+ * The associated location's ID.
15
+ */
7
16
  location_id: string;
17
+ /**
18
+ * The date the fulfillment was packed.
19
+ */
8
20
  packed_at?: Date | null;
21
+ /**
22
+ * The date the fulfillment was shipped.
23
+ */
9
24
  shipped_at?: Date | null;
25
+ /**
26
+ * The date the fulfillment was delivered.
27
+ */
10
28
  delivered_at?: Date | null;
29
+ /**
30
+ * The date the fulfillment was canceled.
31
+ */
11
32
  canceled_at?: Date | null;
33
+ /**
34
+ * The data necessary for the associated fulfillment provider to process the fulfillment.
35
+ */
12
36
  data?: Record<string, unknown> | null;
37
+ /**
38
+ * The associated fulfillment provider's ID.
39
+ */
13
40
  provider_id: string;
41
+ /**
42
+ * The associated shipping option's ID.
43
+ */
14
44
  shipping_option_id?: string | null;
45
+ /**
46
+ * Holds custom data in key-value pairs.
47
+ */
15
48
  metadata?: Record<string, unknown> | null;
49
+ /**
50
+ * The address associated with the fulfillment. It's used for delivery.
51
+ */
16
52
  delivery_address: Omit<CreateFulfillmentAddressDTO, "fulfillment_id">;
53
+ /**
54
+ * The items associated with the fulfillment.
55
+ */
17
56
  items: Omit<CreateFulfillmentItemDTO, "fulfillment_id">[];
57
+ /**
58
+ * The labels associated with the fulfillment.
59
+ */
18
60
  labels: Omit<CreateFulfillmentLabelDTO, "fulfillment_id">[];
61
+ /**
62
+ * The associated fulfillment order.
63
+ */
19
64
  order: CreateFulfillmentOrderDTO;
20
65
  }
66
+ /**
67
+ * The attributes to update in the fulfillment.
68
+ */
21
69
  export interface UpdateFulfillmentDTO {
70
+ /**
71
+ * The associated location's ID.
72
+ */
22
73
  location_id?: string;
74
+ /**
75
+ * The date the fulfillment was packed.
76
+ */
23
77
  packed_at?: Date | null;
78
+ /**
79
+ * The date the fulfillment was shipped.
80
+ */
24
81
  shipped_at?: Date | null;
82
+ /**
83
+ * The date the fulfillment was delivered.
84
+ */
25
85
  delivered_at?: Date | null;
86
+ /**
87
+ * The data necessary for the associated fulfillment provider to process the fulfillment.
88
+ */
26
89
  data?: Record<string, unknown> | null;
90
+ /**
91
+ * Holds custom data in key-value pairs.
92
+ */
27
93
  metadata?: Record<string, unknown> | null;
28
94
  }
29
95
  //# sourceMappingURL=fulfillment.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAE/D,MAAM,WAAW,yBAAyB;CAAG;AAE7C,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAC1B,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,gBAAgB,EAAE,IAAI,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAA;IACrE,KAAK,EAAE,IAAI,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IACzD,MAAM,EAAE,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAC3D,KAAK,EAAE,yBAAyB,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
1
+ {"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB;CAAG;AAE7C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,gBAAgB,EAAE,IAAI,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAA;IAErE;;OAEG;IACH,KAAK,EAAE,IAAI,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAEzD;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAE3D;;OAEG;IACH,KAAK,EAAE,yBAAyB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
@@ -1,50 +1,173 @@
1
1
  import { GeoZoneType } from "../common";
2
+ /**
3
+ * The geo zone to be created.
4
+ */
2
5
  interface CreateGeoZoneBaseDTO {
6
+ /**
7
+ * The type of the geo zone.
8
+ */
3
9
  type: GeoZoneType;
10
+ /**
11
+ * The associated service zone's ID.
12
+ */
4
13
  service_zone_id: string;
14
+ /**
15
+ * The ISO 2 character country code of the geo zone.
16
+ */
5
17
  country_code: string;
18
+ /**
19
+ * Holds custom data in key-value pairs.
20
+ */
6
21
  metadata?: Record<string, any> | null;
7
22
  }
23
+ /**
24
+ * The geo zone to be created of type `country`.
25
+ */
8
26
  export interface CreateCountryGeoZoneDTO extends CreateGeoZoneBaseDTO {
27
+ /**
28
+ * The type of the geo zone.
29
+ * @defaultValue `"country"`
30
+ */
9
31
  type: "country";
10
32
  }
33
+ /**
34
+ * The geo zone to be created of type `province`.
35
+ */
11
36
  export interface CreateProvinceGeoZoneDTO extends CreateGeoZoneBaseDTO {
37
+ /**
38
+ * The type of the geo zone.
39
+ * @defaultValue `"province"`
40
+ */
12
41
  type: "province";
42
+ /**
43
+ * The province code of the geo zone.
44
+ */
13
45
  province_code: string;
14
46
  }
47
+ /**
48
+ * The geo zone to be created of type `city`.
49
+ */
15
50
  export interface CreateCityGeoZoneDTO extends CreateGeoZoneBaseDTO {
51
+ /**
52
+ * The type of the geo zone.
53
+ * @defaultValue `"city"`
54
+ */
16
55
  type: "city";
56
+ /**
57
+ * The province code of the geo zone.
58
+ */
17
59
  province_code: string;
60
+ /**
61
+ * The city of the geo zone.
62
+ */
18
63
  city: string;
19
64
  }
65
+ /**
66
+ * The geo zone to be created of type `zip`.
67
+ */
20
68
  export interface CreateZipGeoZoneDTO extends CreateGeoZoneBaseDTO {
69
+ /**
70
+ * The type of the geo zone.
71
+ * @defaultValue `"zip"`
72
+ */
21
73
  type: "zip";
74
+ /**
75
+ * The province code of the geo zone.
76
+ */
22
77
  province_code: string;
78
+ /**
79
+ * The city of the geo zone.
80
+ */
23
81
  city: string;
82
+ /**
83
+ * The postal expression of the geo zone.
84
+ */
24
85
  postal_expression: Record<string, any>;
25
86
  }
87
+ /**
88
+ * @interface
89
+ *
90
+ * The geo zone to be created. The value of the `type` attributes allows for passing more attributes.
91
+ */
26
92
  export type CreateGeoZoneDTO = CreateCountryGeoZoneDTO | CreateProvinceGeoZoneDTO | CreateCityGeoZoneDTO | CreateZipGeoZoneDTO;
93
+ /**
94
+ * The attributes to update in the geo zone.
95
+ */
27
96
  export interface UpdateGeoZoneBaseDTO extends Partial<CreateGeoZoneBaseDTO> {
97
+ /**
98
+ * The ID of the geo zone.
99
+ */
28
100
  id: string;
29
101
  }
102
+ /**
103
+ * The attributes to update in the geo zone of type `country`.
104
+ */
30
105
  export interface UpdateCountryGeoZoneDTO extends UpdateGeoZoneBaseDTO {
106
+ /**
107
+ * The type of the geo zone.
108
+ * @defaultValue `"country"`
109
+ */
31
110
  type: "country";
32
111
  }
112
+ /**
113
+ * The attributes to update in the geo zone of type `province`.
114
+ */
33
115
  export interface UpdateProvinceGeoZoneDTO extends UpdateGeoZoneBaseDTO {
116
+ /**
117
+ * The type of the geo zone.
118
+ * @defaultValue `"province"`
119
+ */
34
120
  type: "province";
121
+ /**
122
+ * The province code of the geo zone.
123
+ */
35
124
  province_code: string;
36
125
  }
126
+ /**
127
+ * The attributes to update in the geo zone of type `city`.
128
+ */
37
129
  export interface UpdateCityGeoZoneDTO extends UpdateGeoZoneBaseDTO {
130
+ /**
131
+ * The type of the geo zone.
132
+ * @defaultValue `"city"`
133
+ */
38
134
  type: "city";
135
+ /**
136
+ * The province code of the geo zone.
137
+ */
39
138
  province_code?: string;
139
+ /**
140
+ * The city of the geo zone.
141
+ */
40
142
  city?: string;
41
143
  }
144
+ /**
145
+ * The attributes to update in the geo zone of type `zip`.
146
+ */
42
147
  export interface UpdateZipGeoZoneDTO extends UpdateGeoZoneBaseDTO {
148
+ /**
149
+ * The type of the geo zone.
150
+ * @defaultValue `"zip"`
151
+ */
43
152
  type: "zip";
153
+ /**
154
+ * The province code of the geo zone.
155
+ */
44
156
  province_code?: string;
157
+ /**
158
+ * The city of the geo zone.
159
+ */
45
160
  city?: string;
161
+ /**
162
+ * The postal expression of the geo zone.
163
+ */
46
164
  postal_expression?: Record<string, any>;
47
165
  }
166
+ /**
167
+ * @interface
168
+ *
169
+ * The attributes to update in the geo zone. The value of the `type` attributes allows for passing more attributes.
170
+ */
48
171
  export type UpdateGeoZoneDTO = UpdateCountryGeoZoneDTO | UpdateProvinceGeoZoneDTO | UpdateCityGeoZoneDTO | UpdateZipGeoZoneDTO;
49
172
  export {};
50
173
  //# sourceMappingURL=geo-zone.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"geo-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/geo-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,UAAU,oBAAoB;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,IAAI,EAAE,KAAK,CAAA;IACX,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA;AAEvB,MAAM,WAAW,oBAAqB,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IACzE,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,IAAI,EAAE,KAAK,CAAA;IACX,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxC;AAED,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA"}
1
+ {"version":3,"file":"geo-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/geo-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;GAEG;AACH,UAAU,oBAAoB;IAC5B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA;AAEvB;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA"}
@@ -1,14 +1,46 @@
1
1
  import { CreateCityGeoZoneDTO, CreateCountryGeoZoneDTO, CreateProvinceGeoZoneDTO, CreateZipGeoZoneDTO } from "./geo-zone";
2
+ /**
3
+ * The service zone to be created.
4
+ */
2
5
  export interface CreateServiceZoneDTO {
6
+ /**
7
+ * The name of the service zone.
8
+ */
3
9
  name: string;
10
+ /**
11
+ * The associated fulfillment set's ID.
12
+ */
4
13
  fulfillment_set_id: string;
14
+ /**
15
+ * The geo zones associated with the service zone.
16
+ */
5
17
  geo_zones?: (Omit<CreateCountryGeoZoneDTO, "service_zone_id"> | Omit<CreateProvinceGeoZoneDTO, "service_zone_id"> | Omit<CreateCityGeoZoneDTO, "service_zone_id"> | Omit<CreateZipGeoZoneDTO, "service_zone_id">)[];
6
18
  }
19
+ /**
20
+ * The attributes to update in the service zone.
21
+ */
7
22
  export interface UpdateServiceZoneDTO {
8
- id: string;
23
+ /**
24
+ * The ID of the service zone.
25
+ */
26
+ id?: string;
27
+ /**
28
+ * The name of the service zone.
29
+ */
9
30
  name?: string;
31
+ /**
32
+ * The geo zones associated with the service zone.
33
+ */
10
34
  geo_zones?: (Omit<CreateCountryGeoZoneDTO, "service_zone_id"> | Omit<CreateProvinceGeoZoneDTO, "service_zone_id"> | Omit<CreateCityGeoZoneDTO, "service_zone_id"> | Omit<CreateZipGeoZoneDTO, "service_zone_id"> | {
35
+ /**
36
+ * The ID of the geo zone.
37
+ */
11
38
  id: string;
12
39
  })[];
13
40
  }
41
+ /**
42
+ * A service zone to be created or updated.
43
+ */
44
+ export interface UpsertServiceZoneDTO extends UpdateServiceZoneDTO {
45
+ }
14
46
  //# sourceMappingURL=service-zone.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAC/C,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,GAC5C;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CACjB,EAAE,CAAA;CACJ"}
1
+ {"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,YAAY,CAAA;AAEnB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAC/C,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,GAC5C;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;CAAG"}
@@ -1,11 +1,32 @@
1
1
  import { RuleOperatorType } from "../../common";
2
+ /**
3
+ * The shipping option rule to be created.
4
+ */
2
5
  export interface CreateShippingOptionRuleDTO {
6
+ /**
7
+ * The attribute of the shipping option rule.
8
+ */
3
9
  attribute: string;
10
+ /**
11
+ * The operator of the shipping option rule.
12
+ */
4
13
  operator: RuleOperatorType;
14
+ /**
15
+ * The value(s) of the shipping option rule.
16
+ */
5
17
  value: string | string[];
18
+ /**
19
+ * The associated shipping option's ID.
20
+ */
6
21
  shipping_option_id: string;
7
22
  }
23
+ /**
24
+ * The attributes to update in the shipping option rule.
25
+ */
8
26
  export interface UpdateShippingOptionRuleDTO extends Partial<CreateShippingOptionRuleDTO> {
27
+ /**
28
+ * The ID of the shipping option rule.
29
+ */
9
30
  id: string;
10
31
  }
11
32
  //# sourceMappingURL=shipping-option-rule.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C,EAAE,EAAE,MAAM,CAAA;CACX"}
1
+ {"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX"}
@@ -1,10 +1,31 @@
1
+ /**
2
+ * The shipping option type to be created.
3
+ */
1
4
  export interface CreateShippingOptionTypeDTO {
5
+ /**
6
+ * The label of the shipping option type.
7
+ */
2
8
  label: string;
9
+ /**
10
+ * The description of the shipping option type.
11
+ */
3
12
  description: string;
13
+ /**
14
+ * The code of the shipping option type.
15
+ */
4
16
  code: string;
17
+ /**
18
+ * The associated shipping option's ID.
19
+ */
5
20
  shipping_option_id: string;
6
21
  }
22
+ /**
23
+ * The attributes to update in the shipping option type.
24
+ */
7
25
  export interface UpdateShippingOptionTypeDTO extends Partial<CreateShippingOptionTypeDTO> {
26
+ /**
27
+ * The ID of the shipping option type.
28
+ */
8
29
  id: string;
9
30
  }
10
31
  //# sourceMappingURL=shipping-option-type.d.ts.map