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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (212) 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/fulfillment/common/address.d.ts +51 -0
  15. package/dist/fulfillment/common/address.d.ts.map +1 -1
  16. package/dist/fulfillment/common/fulfillment-item.d.ts +39 -0
  17. package/dist/fulfillment/common/fulfillment-item.d.ts.map +1 -1
  18. package/dist/fulfillment/common/fulfillment-label.d.ts +30 -0
  19. package/dist/fulfillment/common/fulfillment-label.d.ts.map +1 -1
  20. package/dist/fulfillment/common/fulfillment-provider.d.ts +24 -0
  21. package/dist/fulfillment/common/fulfillment-provider.d.ts.map +1 -1
  22. package/dist/fulfillment/common/fulfillment-set.d.ts +42 -0
  23. package/dist/fulfillment/common/fulfillment-set.d.ts.map +1 -1
  24. package/dist/fulfillment/common/fulfillment.d.ts +91 -0
  25. package/dist/fulfillment/common/fulfillment.d.ts.map +1 -1
  26. package/dist/fulfillment/common/geo-zone.d.ts +54 -0
  27. package/dist/fulfillment/common/geo-zone.d.ts.map +1 -1
  28. package/dist/fulfillment/common/service-zone.d.ts +52 -0
  29. package/dist/fulfillment/common/service-zone.d.ts.map +1 -1
  30. package/dist/fulfillment/common/shipping-option-rule.d.ts +51 -0
  31. package/dist/fulfillment/common/shipping-option-rule.d.ts.map +1 -1
  32. package/dist/fulfillment/common/shipping-option-type.d.ts +45 -0
  33. package/dist/fulfillment/common/shipping-option-type.d.ts.map +1 -1
  34. package/dist/fulfillment/common/shipping-option.d.ts +117 -0
  35. package/dist/fulfillment/common/shipping-option.d.ts.map +1 -1
  36. package/dist/fulfillment/common/shipping-profile.d.ts +42 -0
  37. package/dist/fulfillment/common/shipping-profile.d.ts.map +1 -1
  38. package/dist/fulfillment/mutations/fulfillment-address.d.ts +39 -0
  39. package/dist/fulfillment/mutations/fulfillment-address.d.ts.map +1 -1
  40. package/dist/fulfillment/mutations/fulfillment-item.d.ts +24 -0
  41. package/dist/fulfillment/mutations/fulfillment-item.d.ts.map +1 -1
  42. package/dist/fulfillment/mutations/fulfillment-label.d.ts +15 -0
  43. package/dist/fulfillment/mutations/fulfillment-label.d.ts.map +1 -1
  44. package/dist/fulfillment/mutations/fulfillment-set.d.ts +32 -2
  45. package/dist/fulfillment/mutations/fulfillment-set.d.ts.map +1 -1
  46. package/dist/fulfillment/mutations/fulfillment.d.ts +66 -0
  47. package/dist/fulfillment/mutations/fulfillment.d.ts.map +1 -1
  48. package/dist/fulfillment/mutations/geo-zone.d.ts +123 -0
  49. package/dist/fulfillment/mutations/geo-zone.d.ts.map +1 -1
  50. package/dist/fulfillment/mutations/service-zone.d.ts +33 -1
  51. package/dist/fulfillment/mutations/service-zone.d.ts.map +1 -1
  52. package/dist/fulfillment/mutations/shipping-option-rule.d.ts +21 -0
  53. package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +1 -1
  54. package/dist/fulfillment/mutations/shipping-option-type.d.ts +21 -0
  55. package/dist/fulfillment/mutations/shipping-option-type.d.ts.map +1 -1
  56. package/dist/fulfillment/mutations/shipping-option.d.ts +71 -1
  57. package/dist/fulfillment/mutations/shipping-option.d.ts.map +1 -1
  58. package/dist/fulfillment/mutations/shipping-profile.d.ts +15 -0
  59. package/dist/fulfillment/mutations/shipping-profile.d.ts.map +1 -1
  60. package/dist/fulfillment/service.d.ts +1933 -218
  61. package/dist/fulfillment/service.d.ts.map +1 -1
  62. package/dist/http/api-key/admin/api-key.d.ts +31 -0
  63. package/dist/http/api-key/admin/api-key.d.ts.map +1 -0
  64. package/dist/http/api-key/admin/api-key.js +3 -0
  65. package/dist/http/api-key/admin/api-key.js.map +1 -0
  66. package/dist/http/api-key/admin/index.d.ts +2 -0
  67. package/dist/http/api-key/admin/index.d.ts.map +1 -0
  68. package/dist/http/api-key/admin/index.js +18 -0
  69. package/dist/http/api-key/admin/index.js.map +1 -0
  70. package/dist/http/api-key/index.d.ts +2 -0
  71. package/dist/http/api-key/index.d.ts.map +1 -0
  72. package/dist/http/api-key/index.js +18 -0
  73. package/dist/http/api-key/index.js.map +1 -0
  74. package/dist/http/common/index.d.ts +2 -0
  75. package/dist/http/common/index.d.ts.map +1 -0
  76. package/dist/http/common/index.js +18 -0
  77. package/dist/http/common/index.js.map +1 -0
  78. package/dist/http/common/paginated-response.d.ts +6 -0
  79. package/dist/http/common/paginated-response.d.ts.map +1 -0
  80. package/dist/http/common/paginated-response.js +3 -0
  81. package/dist/http/common/paginated-response.js.map +1 -0
  82. package/dist/http/customer/admin/customer.d.ts +78 -0
  83. package/dist/http/customer/admin/customer.d.ts.map +1 -0
  84. package/dist/http/customer/admin/customer.js +3 -0
  85. package/dist/http/customer/admin/customer.js.map +1 -0
  86. package/dist/http/customer/admin/index.d.ts +2 -0
  87. package/dist/http/customer/admin/index.d.ts.map +1 -0
  88. package/dist/http/customer/admin/index.js +18 -0
  89. package/dist/http/customer/admin/index.js.map +1 -0
  90. package/dist/http/customer/index.d.ts +2 -0
  91. package/dist/http/customer/index.d.ts.map +1 -0
  92. package/dist/http/customer/index.js +18 -0
  93. package/dist/http/customer/index.js.map +1 -0
  94. package/dist/http/fulfillment/admin/fulfillment-set.d.ts +7 -1
  95. package/dist/http/fulfillment/admin/fulfillment-set.d.ts.map +1 -1
  96. package/dist/http/fulfillment/admin/service-zone.d.ts +10 -0
  97. package/dist/http/fulfillment/admin/service-zone.d.ts.map +1 -1
  98. package/dist/http/fulfillment/admin/shipping-option.d.ts +11 -4
  99. package/dist/http/fulfillment/admin/shipping-option.d.ts.map +1 -1
  100. package/dist/http/index.d.ts +6 -1
  101. package/dist/http/index.d.ts.map +1 -1
  102. package/dist/http/index.js +6 -1
  103. package/dist/http/index.js.map +1 -1
  104. package/dist/http/pricing/index.d.ts +2 -0
  105. package/dist/http/pricing/index.d.ts.map +1 -0
  106. package/dist/http/pricing/index.js +18 -0
  107. package/dist/http/pricing/index.js.map +1 -0
  108. package/dist/http/pricing/price.d.ts +8 -0
  109. package/dist/http/pricing/price.d.ts.map +1 -0
  110. package/dist/http/pricing/price.js +3 -0
  111. package/dist/http/pricing/price.js.map +1 -0
  112. package/dist/http/sales-channel/admin/index.d.ts +2 -0
  113. package/dist/http/sales-channel/admin/index.d.ts.map +1 -0
  114. package/dist/http/sales-channel/admin/index.js +18 -0
  115. package/dist/http/sales-channel/admin/index.js.map +1 -0
  116. package/dist/http/sales-channel/admin/sales-channel.d.ts +25 -0
  117. package/dist/http/sales-channel/admin/sales-channel.d.ts.map +1 -0
  118. package/dist/http/sales-channel/admin/sales-channel.js +3 -0
  119. package/dist/http/sales-channel/admin/sales-channel.js.map +1 -0
  120. package/dist/http/sales-channel/index.d.ts +2 -0
  121. package/dist/http/sales-channel/index.d.ts.map +1 -0
  122. package/dist/http/sales-channel/index.js +18 -0
  123. package/dist/http/sales-channel/index.js.map +1 -0
  124. package/dist/http/tax/admin/index.d.ts +2 -0
  125. package/dist/http/tax/admin/index.d.ts.map +1 -0
  126. package/dist/http/tax/admin/index.js +18 -0
  127. package/dist/http/tax/admin/index.js.map +1 -0
  128. package/dist/http/tax/admin/tax-regions.d.ts +32 -0
  129. package/dist/http/tax/admin/tax-regions.d.ts.map +1 -0
  130. package/dist/http/tax/admin/tax-regions.js +3 -0
  131. package/dist/http/tax/admin/tax-regions.js.map +1 -0
  132. package/dist/http/tax/index.d.ts +2 -0
  133. package/dist/http/tax/index.d.ts.map +1 -0
  134. package/dist/http/tax/index.js +18 -0
  135. package/dist/http/tax/index.js.map +1 -0
  136. package/dist/joiner/index.d.ts +2 -2
  137. package/dist/joiner/index.d.ts.map +1 -1
  138. package/dist/modules-sdk/index.d.ts +2 -1
  139. package/dist/modules-sdk/index.d.ts.map +1 -1
  140. package/dist/order/common.d.ts +111 -45
  141. package/dist/order/common.d.ts.map +1 -1
  142. package/dist/order/index.d.ts +1 -0
  143. package/dist/order/index.d.ts.map +1 -1
  144. package/dist/order/index.js +1 -0
  145. package/dist/order/index.js.map +1 -1
  146. package/dist/order/mutations.d.ts +14 -14
  147. package/dist/order/mutations.d.ts.map +1 -1
  148. package/dist/order/mutations.js.map +1 -1
  149. package/dist/order/service.d.ts +60 -662
  150. package/dist/order/service.d.ts.map +1 -1
  151. package/dist/order/workflows.d.ts +8 -0
  152. package/dist/order/workflows.d.ts.map +1 -0
  153. package/dist/order/workflows.js +3 -0
  154. package/dist/order/workflows.js.map +1 -0
  155. package/dist/payment/common.d.ts +14 -13
  156. package/dist/payment/common.d.ts.map +1 -1
  157. package/dist/payment/common.js.map +1 -1
  158. package/dist/payment/mutations.d.ts +9 -8
  159. package/dist/payment/mutations.d.ts.map +1 -1
  160. package/dist/payment/provider.d.ts +6 -5
  161. package/dist/payment/provider.d.ts.map +1 -1
  162. package/dist/payment/provider.js.map +1 -1
  163. package/dist/payment/service.d.ts +1 -0
  164. package/dist/payment/service.d.ts.map +1 -1
  165. package/dist/pricing/common/money-amount.d.ts +10 -9
  166. package/dist/pricing/common/money-amount.d.ts.map +1 -1
  167. package/dist/pricing/common/price-set.d.ts +9 -8
  168. package/dist/pricing/common/price-set.d.ts.map +1 -1
  169. package/dist/pricing/common/price.d.ts +10 -9
  170. package/dist/pricing/common/price.d.ts.map +1 -1
  171. package/dist/pricing/workflows.d.ts +10 -20
  172. package/dist/pricing/workflows.d.ts.map +1 -1
  173. package/dist/promotion/http.d.ts +14 -0
  174. package/dist/promotion/http.d.ts.map +1 -0
  175. package/dist/promotion/http.js +3 -0
  176. package/dist/promotion/http.js.map +1 -0
  177. package/dist/promotion/index.d.ts +1 -0
  178. package/dist/promotion/index.d.ts.map +1 -1
  179. package/dist/promotion/index.js +1 -0
  180. package/dist/promotion/index.js.map +1 -1
  181. package/dist/region/common.d.ts +5 -0
  182. package/dist/region/common.d.ts.map +1 -1
  183. package/dist/region/mutations.d.ts +4 -0
  184. package/dist/region/mutations.d.ts.map +1 -1
  185. package/dist/tax/common.d.ts +4 -3
  186. package/dist/tax/common.d.ts.map +1 -1
  187. package/dist/totals/big-number.d.ts +1 -0
  188. package/dist/totals/big-number.d.ts.map +1 -1
  189. package/dist/totals/index.d.ts +24 -0
  190. package/dist/totals/index.d.ts.map +1 -1
  191. package/dist/totals/index.js.map +1 -1
  192. package/dist/workflow/fulfillment/create-shipping-options.d.ts +31 -0
  193. package/dist/workflow/fulfillment/create-shipping-options.d.ts.map +1 -0
  194. package/dist/workflow/fulfillment/create-shipping-options.js +3 -0
  195. package/dist/workflow/fulfillment/create-shipping-options.js.map +1 -0
  196. package/dist/workflow/fulfillment/index.d.ts +4 -0
  197. package/dist/workflow/fulfillment/index.d.ts.map +1 -0
  198. package/dist/workflow/fulfillment/index.js +20 -0
  199. package/dist/workflow/fulfillment/index.js.map +1 -0
  200. package/dist/workflow/fulfillment/service-zones.d.ts +21 -0
  201. package/dist/workflow/fulfillment/service-zones.d.ts.map +1 -0
  202. package/dist/workflow/fulfillment/service-zones.js +3 -0
  203. package/dist/workflow/fulfillment/service-zones.js.map +1 -0
  204. package/dist/workflow/fulfillment/update-shipping-options.d.ts +32 -0
  205. package/dist/workflow/fulfillment/update-shipping-options.d.ts.map +1 -0
  206. package/dist/workflow/fulfillment/update-shipping-options.js +3 -0
  207. package/dist/workflow/fulfillment/update-shipping-options.js.map +1 -0
  208. package/dist/workflow/index.d.ts +1 -0
  209. package/dist/workflow/index.d.ts.map +1 -1
  210. package/dist/workflow/index.js +2 -1
  211. package/dist/workflow/index.js.map +1 -1
  212. package/package.json +1 -1
@@ -2,22 +2,74 @@ import { FilterableFulfillmentSetProps, FulfillmentSetDTO } from "./fulfillment-
2
2
  import { FilterableGeoZoneProps, GeoZoneDTO } from "./geo-zone";
3
3
  import { ShippingOptionDTO } from "./shipping-option";
4
4
  import { BaseFilterable, OperatorMap } from "../../dal";
5
+ /**
6
+ * The service zone details.
7
+ */
5
8
  export interface ServiceZoneDTO {
9
+ /**
10
+ * The ID of the service zone.
11
+ */
6
12
  id: string;
13
+ /**
14
+ * The name of the service zone.
15
+ */
7
16
  name: string;
17
+ /**
18
+ * Holds custom data in key-value pairs.
19
+ */
8
20
  metadata: Record<string, unknown> | null;
21
+ /**
22
+ * The fulfillment sets assoiated with the service zone.
23
+ */
9
24
  fulfillment_sets: FulfillmentSetDTO[];
25
+ /**
26
+ * The geo zones assoiated with the service zone.
27
+ */
10
28
  geo_zones: GeoZoneDTO[];
29
+ /**
30
+ * The shipping options assoiated with the service zone.
31
+ */
11
32
  shipping_options: ShippingOptionDTO[];
33
+ /**
34
+ * The creation date of the service zone.
35
+ */
12
36
  created_at: Date;
37
+ /**
38
+ * The update date of the service zone.
39
+ */
13
40
  updated_at: Date;
41
+ /**
42
+ * The deletion date of the service zone.
43
+ */
14
44
  deleted_at: Date | null;
15
45
  }
46
+ /**
47
+ * The filters to apply on the retrieved service zones.
48
+ */
16
49
  export interface FilterableServiceZoneProps extends BaseFilterable<FilterableServiceZoneProps> {
50
+ /**
51
+ * The IDs to filter the service zones by.
52
+ */
17
53
  id?: string | string[] | OperatorMap<string | string[]>;
54
+ /**
55
+ * Filter the service zones by their name.
56
+ */
18
57
  name?: string | string[] | OperatorMap<string | string[]>;
58
+ /**
59
+ * The filters to apply on the associated geo zones.
60
+ */
19
61
  geo_zones?: FilterableGeoZoneProps;
62
+ /**
63
+ * The filters to apply on the associated fulfillment sets.
64
+ */
20
65
  fulfillment_set?: FilterableFulfillmentSetProps;
66
+ /**
67
+ * @ignore
68
+ *
69
+ * @privateRemarks
70
+ * Added the `@\ignore` because of the `TODO`. Once implemented, the
71
+ * `@\ignore` (and this comment) should be removed.
72
+ */
21
73
  shipping_options?: any;
22
74
  }
23
75
  //# sourceMappingURL=service-zone.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IACrC,SAAS,EAAE,UAAU,EAAE,CAAA;IACvB,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,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD,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,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAClC,eAAe,CAAC,EAAE,6BAA6B,CAAA;IAC/C,gBAAgB,CAAC,EAAE,GAAG,CAAA;CACvB"}
1
+ {"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;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,SAAS,EAAE,UAAU,EAAE,CAAA;IAEvB;;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,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;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,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAElC;;OAEG;IACH,eAAe,CAAC,EAAE,6BAA6B,CAAA;IAE/C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,GAAG,CAAA;CACvB"}
@@ -1,22 +1,73 @@
1
1
  import { ShippingOptionDTO } from "./shipping-option";
2
2
  import { BaseFilterable, OperatorMap } from "../../dal";
3
+ /**
4
+ * The shipping option rule details.
5
+ */
3
6
  export interface ShippingOptionRuleDTO {
7
+ /**
8
+ * The ID of the shipping option rule.
9
+ */
4
10
  id: string;
11
+ /**
12
+ * The attribute of the shipping option rule.
13
+ */
5
14
  attribute: string;
15
+ /**
16
+ * The operator of the shipping option rule.
17
+ *
18
+ * @example
19
+ * in
20
+ */
6
21
  operator: string;
22
+ /**
23
+ * The values of the shipping option rule.
24
+ */
7
25
  value: {
26
+ /**
27
+ * The values of the shipping option rule.
28
+ */
8
29
  value: string | string[];
9
30
  } | null;
31
+ /**
32
+ * The associated shipping option's ID.
33
+ */
10
34
  shipping_option_id: string;
35
+ /**
36
+ * The associated shipping option.
37
+ */
11
38
  shipping_option: ShippingOptionDTO;
39
+ /**
40
+ * The creation date of the shipping option rule.
41
+ */
12
42
  created_at: Date;
43
+ /**
44
+ * The update date of the shipping option rule.
45
+ */
13
46
  updated_at: Date;
47
+ /**
48
+ * The deletion date of the shipping option rule.
49
+ */
14
50
  deleted_at: Date | null;
15
51
  }
52
+ /**
53
+ * The filters to apply on the retrieved shipping option rules.
54
+ */
16
55
  export interface FilterableShippingOptionRuleProps extends BaseFilterable<FilterableShippingOptionRuleProps> {
56
+ /**
57
+ * The IDs to filter the shipping option rules by.
58
+ */
17
59
  id?: string | string[] | OperatorMap<string | string[]>;
60
+ /**
61
+ * Filter the shipping option rules by their attribute.
62
+ */
18
63
  attribute?: string | string[] | OperatorMap<string | string[]>;
64
+ /**
65
+ * Filter the shipping option rules by their operator.
66
+ */
19
67
  operator?: string | string[] | OperatorMap<string | string[]>;
68
+ /**
69
+ * Filter the shipping option rules by their values.
70
+ */
20
71
  value?: string | string[] | OperatorMap<string | string[]>;
21
72
  }
22
73
  //# sourceMappingURL=shipping-option-rule.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI,CAAA;IAC1C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,iBAAiB,CAAA;IAClC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC9D,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC3D"}
1
+ {"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KACzB,GAAG,IAAI,CAAA;IAER;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,eAAe,EAAE,iBAAiB,CAAA;IAElC;;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,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC3D"}
@@ -1,20 +1,65 @@
1
1
  import { ShippingOptionDTO } from "./shipping-option";
2
2
  import { BaseFilterable, OperatorMap } from "../../dal";
3
+ /**
4
+ * The shipping option type details.
5
+ */
3
6
  export interface ShippingOptionTypeDTO {
7
+ /**
8
+ * The ID of the shipping option type.
9
+ */
4
10
  id: string;
11
+ /**
12
+ * The label of the shipping option type.
13
+ */
5
14
  label: string;
15
+ /**
16
+ * The description of the shipping option type.
17
+ */
6
18
  description: string;
19
+ /**
20
+ * The code of the shipping option type.
21
+ */
7
22
  code: string;
23
+ /**
24
+ * The associated shipping option's ID.
25
+ */
8
26
  shipping_option_id: string;
27
+ /**
28
+ * The associated shipping option.
29
+ */
9
30
  shipping_option: ShippingOptionDTO;
31
+ /**
32
+ * The creation date of the shipping option type.
33
+ */
10
34
  created_at: Date;
35
+ /**
36
+ * The update date of the shipping option type.
37
+ */
11
38
  updated_at: Date;
39
+ /**
40
+ * The deletion date of the shipping option type.
41
+ */
12
42
  deleted_at: Date | null;
13
43
  }
44
+ /**
45
+ * The filters to apply on the retrieved shipping option types.
46
+ */
14
47
  export interface FilterableShippingOptionTypeProps extends BaseFilterable<FilterableShippingOptionTypeProps> {
48
+ /**
49
+ * The IDs to filter the shipping option types by.
50
+ */
15
51
  id?: string | string[] | OperatorMap<string | string[]>;
52
+ /**
53
+ * Filter the shipping option types by their label.
54
+ */
16
55
  label?: string | string[] | OperatorMap<string | string[]>;
56
+ /**
57
+ * Filter the shipping option types by their description.
58
+ */
17
59
  description?: string | string[] | OperatorMap<string | string[]>;
60
+ /**
61
+ * Filter the shipping option types by their code.
62
+ */
18
63
  code?: string | string[] | OperatorMap<string | string[]>;
19
64
  }
20
65
  //# sourceMappingURL=shipping-option-type.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,iBAAiB,CAAA;IAClC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1D,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAChE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC1D"}
1
+ {"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,eAAe,EAAE,iBAAiB,CAAA;IAElC;;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,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE1D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEhE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC1D"}
@@ -5,50 +5,167 @@ import { FilterableServiceZoneProps, ServiceZoneDTO } from "./service-zone";
5
5
  import { FilterableShippingOptionRuleProps, ShippingOptionRuleDTO } from "./shipping-option-rule";
6
6
  import { FilterableShippingOptionTypeProps, ShippingOptionTypeDTO } from "./shipping-option-type";
7
7
  import { ShippingProfileDTO } from "./shipping-profile";
8
+ /**
9
+ * The shipping option's price type.
10
+ *
11
+ * - Use `calculated` if the shipping option's price amount is calculated by the fulfillment provider.
12
+ * - Use `flat_rate` if the shipping option's price is always the same amount.
13
+ *
14
+ */
8
15
  export type ShippingOptionPriceType = "calculated" | "flat";
16
+ /**
17
+ * The shipping option details.
18
+ */
9
19
  export interface ShippingOptionDTO {
20
+ /**
21
+ * The ID of the shipping option.
22
+ */
10
23
  id: string;
24
+ /**
25
+ * The name of the shipping option.
26
+ */
11
27
  name: string;
28
+ /**
29
+ * The type of the shipping option's price.
30
+ */
12
31
  price_type: ShippingOptionPriceType;
32
+ /**
33
+ * The associated service zone's ID.
34
+ */
13
35
  service_zone_id: string;
36
+ /**
37
+ * The associated shipping profile's ID.
38
+ */
14
39
  shipping_profile_id: string;
40
+ /**
41
+ * The associated fulfillment provider's ID.
42
+ */
15
43
  provider_id: string;
44
+ /**
45
+ * The associated shipping option type's ID.
46
+ */
16
47
  shipping_option_type_id: string | null;
48
+ /**
49
+ * The data necessary for the associated fulfillment provider to process the shipping option
50
+ * and, later, its associated fulfillments.
51
+ */
17
52
  data: Record<string, unknown> | null;
53
+ /**
54
+ * Holds custom data in key-value pairs.
55
+ */
18
56
  metadata: Record<string, unknown> | null;
57
+ /**
58
+ * The associated service zone.
59
+ */
19
60
  service_zone: ServiceZoneDTO;
61
+ /**
62
+ * The associated shipping profile.
63
+ */
20
64
  shipping_profile: ShippingProfileDTO;
65
+ /**
66
+ * The associated fulfillment provider.
67
+ */
21
68
  fulfillment_provider: FulfillmentProviderDTO;
69
+ /**
70
+ * The associated shipping option type.
71
+ */
22
72
  type: ShippingOptionTypeDTO;
73
+ /**
74
+ * The rules associated with the shipping option.
75
+ */
23
76
  rules: ShippingOptionRuleDTO[];
77
+ /**
78
+ * The fulfillments associated with the shipping option.
79
+ */
24
80
  fulfillments: FulfillmentDTO[];
81
+ /**
82
+ * The creation date of the shipping option.
83
+ */
25
84
  created_at: Date;
85
+ /**
86
+ * The update date of the shipping option.
87
+ */
26
88
  updated_at: Date;
89
+ /**
90
+ * The deletion date of the shipping option.
91
+ */
27
92
  deleted_at: Date | null;
28
93
  }
94
+ /**
95
+ * The filters to apply on the retrieved shipping options.
96
+ */
29
97
  export interface FilterableShippingOptionProps extends BaseFilterable<FilterableShippingOptionProps> {
98
+ /**
99
+ * The IDs to filter the shipping options by.
100
+ */
30
101
  id?: string | string[] | OperatorMap<string | string[]>;
102
+ /**
103
+ * Filter the shipping options by their name.
104
+ */
31
105
  name?: string | string[] | OperatorMap<string | string[]>;
106
+ /**
107
+ * Filter the shipping options by the ID of their associated shipping profile.
108
+ */
32
109
  shipping_profile_id?: string | string[] | OperatorMap<string | string[]>;
110
+ /**
111
+ * Filter the shipping options by their price type.
112
+ */
33
113
  price_type?: ShippingOptionPriceType | ShippingOptionPriceType[] | OperatorMap<ShippingOptionPriceType | ShippingOptionPriceType[]>;
114
+ /**
115
+ * The filters to apply on the retrieved service zones.
116
+ */
34
117
  service_zone?: FilterableServiceZoneProps;
118
+ /**
119
+ * The filters to apply on the retrieved shipping option types.
120
+ */
35
121
  shipping_option_type?: FilterableShippingOptionTypeProps;
122
+ /**
123
+ * The filters to apply on the retrieved shipping option rules.
124
+ */
36
125
  rules?: FilterableShippingOptionRuleProps;
37
126
  }
127
+ /**
128
+ * A context's details used to filter the shipping option.
129
+ */
38
130
  export interface FilterableShippingOptionForContextProps extends FilterableShippingOptionProps {
131
+ /**
132
+ * The fulfillment set's ID used in the context.
133
+ */
39
134
  fulfillment_set_id?: string | string[] | OperatorMap<string | string[]>;
135
+ /**
136
+ * The fulfillment set's type used in the context.
137
+ */
40
138
  fulfillment_set_type?: string | string[] | OperatorMap<string | string[]>;
41
139
  /**
140
+ * The address used in the context. It filters the shipping options based on
141
+ * the geo zones of their associated service zone.
142
+ *
143
+ * @privateRemarks
42
144
  * The address is a shortcut to filter through geo_zones
43
145
  * and build opinionated validation and filtering around the geo_zones.
44
146
  * For custom filtering you can go through the service_zone.geo_zones directly.
45
147
  */
46
148
  address?: {
149
+ /**
150
+ * The ISO 2 character country code.
151
+ */
47
152
  country_code?: string;
153
+ /**
154
+ * The province code.
155
+ */
48
156
  province_code?: string;
157
+ /**
158
+ * The city.
159
+ */
49
160
  city?: string;
161
+ /**
162
+ * The postal expression
163
+ */
50
164
  postal_expression?: string;
51
165
  };
166
+ /**
167
+ * The shipping option's context to filter directly.
168
+ */
52
169
  context?: Record<string, any>;
53
170
  }
54
171
  //# sourceMappingURL=shipping-option.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC3E,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,MAAM,CAAA;AAE3D,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,uBAAuB,CAAA;IACnC,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,YAAY,EAAE,cAAc,CAAA;IAC5B,gBAAgB,EAAE,kBAAkB,CAAA;IACpC,oBAAoB,EAAE,sBAAsB,CAAA;IAC5C,IAAI,EAAE,qBAAqB,CAAA;IAC3B,KAAK,EAAE,qBAAqB,EAAE,CAAA;IAC9B,YAAY,EAAE,cAAc,EAAE,CAAA;IAC9B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD,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,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACxE,UAAU,CAAC,EACP,uBAAuB,GACvB,uBAAuB,EAAE,GACzB,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,EAAE,CAAC,CAAA;IACpE,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,oBAAoB,CAAC,EAAE,iCAAiC,CAAA;IACxD,KAAK,CAAC,EAAE,iCAAiC,CAAA;CAC1C;AAED,MAAM,WAAW,uCACf,SAAQ,6BAA6B;IACrC,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvE,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzE;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B"}
1
+ {"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC3E,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,MAAM,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAA;IAEnC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc,CAAA;IAE5B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAA;IAEpC;;OAEG;IACH,oBAAoB,EAAE,sBAAsB,CAAA;IAE5C;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAA;IAE3B;;OAEG;IACH,KAAK,EAAE,qBAAqB,EAAE,CAAA;IAE9B;;OAEG;IACH,YAAY,EAAE,cAAc,EAAE,CAAA;IAE9B;;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,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD;;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,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAExE;;OAEG;IACH,UAAU,CAAC,EACP,uBAAuB,GACvB,uBAAuB,EAAE,GACzB,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,EAAE,CAAC,CAAA;IAEpE;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,CAAA;IAEzC;;OAEG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAA;IAExD;;OAEG;IACH,KAAK,CAAC,EAAE,iCAAiC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,uCACf,SAAQ,6BAA6B;IACrC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvE;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzE;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAC3B,CAAA;IAED;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B"}
@@ -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
  }