@commercelayer/sdk 5.0.0-beta.8 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +18 -0
  3. package/lib/cjs/api.d.ts +27 -2
  4. package/lib/cjs/api.js +17 -15
  5. package/lib/cjs/client.d.ts +3 -5
  6. package/lib/cjs/commercelayer.d.ts +10 -5
  7. package/lib/cjs/commercelayer.js +8 -3
  8. package/lib/cjs/common.d.ts +1 -0
  9. package/lib/cjs/common.js +11 -0
  10. package/lib/cjs/index.d.ts +1 -1
  11. package/lib/cjs/index.js +0 -16
  12. package/lib/cjs/interceptor.d.ts +1 -1
  13. package/lib/cjs/model.d.ts +6 -1
  14. package/lib/cjs/query.d.ts +6 -14
  15. package/lib/cjs/resource.d.ts +14 -20
  16. package/lib/cjs/resources/addresses.d.ts +51 -50
  17. package/lib/cjs/resources/adjustments.d.ts +5 -4
  18. package/lib/cjs/resources/adyen_gateways.d.ts +21 -20
  19. package/lib/cjs/resources/adyen_payments.d.ts +15 -14
  20. package/lib/cjs/resources/application.d.ts +7 -6
  21. package/lib/cjs/resources/attachments.d.ts +11 -10
  22. package/lib/cjs/resources/authorizations.d.ts +28 -27
  23. package/lib/cjs/resources/avalara_accounts.d.ts +17 -16
  24. package/lib/cjs/resources/axerve_gateways.d.ts +9 -8
  25. package/lib/cjs/resources/axerve_payments.d.ts +12 -11
  26. package/lib/cjs/resources/billing_info_validation_rules.d.ts +5 -4
  27. package/lib/cjs/resources/bing_geocoders.d.ts +6 -5
  28. package/lib/cjs/resources/braintree_gateways.d.ts +21 -20
  29. package/lib/cjs/resources/braintree_payments.d.ts +17 -16
  30. package/lib/cjs/resources/bundles.d.ts +27 -26
  31. package/lib/cjs/resources/captures.d.ts +19 -18
  32. package/lib/cjs/resources/carrier_accounts.d.ts +7 -6
  33. package/lib/cjs/resources/checkout_com_gateways.d.ts +12 -11
  34. package/lib/cjs/resources/checkout_com_payments.d.ts +25 -24
  35. package/lib/cjs/resources/cleanups.d.ts +13 -12
  36. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -6
  37. package/lib/cjs/resources/coupon_recipients.d.ts +13 -12
  38. package/lib/cjs/resources/coupons.d.ts +13 -12
  39. package/lib/cjs/resources/customer_addresses.d.ts +8 -7
  40. package/lib/cjs/resources/customer_groups.d.ts +6 -5
  41. package/lib/cjs/resources/customer_password_resets.d.ts +8 -7
  42. package/lib/cjs/resources/customer_payment_sources.d.ts +9 -8
  43. package/lib/cjs/resources/customer_subscriptions.d.ts +4 -3
  44. package/lib/cjs/resources/customers.d.ts +19 -18
  45. package/lib/cjs/resources/delivery_lead_times.d.ts +11 -10
  46. package/lib/cjs/resources/event_callbacks.d.ts +6 -5
  47. package/lib/cjs/resources/events.d.ts +4 -3
  48. package/lib/cjs/resources/exports.d.ts +17 -16
  49. package/lib/cjs/resources/external_gateways.d.ts +20 -19
  50. package/lib/cjs/resources/external_payments.d.ts +10 -9
  51. package/lib/cjs/resources/external_promotions.d.ts +29 -28
  52. package/lib/cjs/resources/external_tax_calculators.d.ts +6 -5
  53. package/lib/cjs/resources/fixed_amount_promotions.d.ts +31 -30
  54. package/lib/cjs/resources/fixed_price_promotions.d.ts +36 -35
  55. package/lib/cjs/resources/fixed_price_promotions.js +4 -4
  56. package/lib/cjs/resources/free_gift_promotions.d.ts +36 -35
  57. package/lib/cjs/resources/free_gift_promotions.js +4 -4
  58. package/lib/cjs/resources/free_shipping_promotions.d.ts +30 -26
  59. package/lib/cjs/resources/free_shipping_promotions.js +4 -0
  60. package/lib/cjs/resources/geocoders.d.ts +4 -3
  61. package/lib/cjs/resources/gift_card_recipients.d.ts +13 -12
  62. package/lib/cjs/resources/gift_cards.d.ts +41 -40
  63. package/lib/cjs/resources/google_geocoders.d.ts +6 -5
  64. package/lib/cjs/resources/imports.d.ts +20 -19
  65. package/lib/cjs/resources/in_stock_subscriptions.d.ts +20 -19
  66. package/lib/cjs/resources/inventory_models.d.ts +12 -11
  67. package/lib/cjs/resources/inventory_return_locations.d.ts +7 -6
  68. package/lib/cjs/resources/inventory_stock_locations.d.ts +10 -9
  69. package/lib/cjs/resources/klarna_gateways.d.ts +10 -9
  70. package/lib/cjs/resources/klarna_payments.d.ts +14 -13
  71. package/lib/cjs/resources/line_item_options.d.ts +18 -17
  72. package/lib/cjs/resources/line_items.d.ts +47 -43
  73. package/lib/cjs/resources/manual_gateways.d.ts +4 -3
  74. package/lib/cjs/resources/manual_tax_calculators.d.ts +8 -7
  75. package/lib/cjs/resources/markets.d.ts +41 -32
  76. package/lib/cjs/resources/markets.js +4 -0
  77. package/lib/cjs/resources/merchants.d.ts +6 -5
  78. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +9 -8
  79. package/lib/cjs/resources/order_copies.d.ts +23 -20
  80. package/lib/cjs/resources/order_copies.js +7 -4
  81. package/lib/cjs/resources/order_factories.d.ts +34 -0
  82. package/lib/cjs/resources/order_factories.js +28 -0
  83. package/lib/cjs/resources/order_subscription_items.d.ts +61 -0
  84. package/lib/cjs/resources/order_subscription_items.js +29 -0
  85. package/lib/cjs/resources/order_subscriptions.d.ts +52 -29
  86. package/lib/cjs/resources/order_subscriptions.js +18 -2
  87. package/lib/cjs/resources/order_validation_rules.d.ts +4 -3
  88. package/lib/cjs/resources/orders.d.ts +192 -183
  89. package/lib/cjs/resources/orders.js +8 -0
  90. package/lib/cjs/resources/organization.d.ts +18 -17
  91. package/lib/cjs/resources/packages.d.ts +14 -13
  92. package/lib/cjs/resources/parcel_line_items.d.ts +7 -6
  93. package/lib/cjs/resources/parcels.d.ts +75 -74
  94. package/lib/cjs/resources/payment_gateways.d.ts +3 -2
  95. package/lib/cjs/resources/payment_methods.d.ts +33 -32
  96. package/lib/cjs/resources/paypal_gateways.d.ts +7 -6
  97. package/lib/cjs/resources/paypal_payments.d.ts +17 -16
  98. package/lib/cjs/resources/percentage_discount_promotions.d.ts +35 -34
  99. package/lib/cjs/resources/percentage_discount_promotions.js +4 -4
  100. package/lib/cjs/resources/price_frequency_tiers.d.ts +50 -0
  101. package/lib/cjs/resources/price_frequency_tiers.js +37 -0
  102. package/lib/cjs/resources/price_lists.d.ts +9 -8
  103. package/lib/cjs/resources/price_tiers.d.ts +7 -6
  104. package/lib/cjs/resources/price_volume_tiers.d.ts +15 -11
  105. package/lib/cjs/resources/price_volume_tiers.js +4 -0
  106. package/lib/cjs/resources/prices.d.ts +20 -16
  107. package/lib/cjs/resources/prices.js +4 -0
  108. package/lib/cjs/resources/promotion_rules.d.ts +3 -2
  109. package/lib/cjs/resources/promotions.d.ts +14 -10
  110. package/lib/cjs/resources/promotions.js +4 -0
  111. package/lib/cjs/resources/recurring_order_copies.d.ts +53 -0
  112. package/lib/cjs/resources/recurring_order_copies.js +41 -0
  113. package/lib/cjs/resources/refunds.d.ts +10 -9
  114. package/lib/cjs/resources/return_line_items.d.ts +13 -12
  115. package/lib/cjs/resources/returns.d.ts +31 -30
  116. package/lib/cjs/resources/satispay_gateways.d.ts +8 -7
  117. package/lib/cjs/resources/satispay_payments.d.ts +12 -11
  118. package/lib/cjs/resources/shipments.d.ts +42 -41
  119. package/lib/cjs/resources/shipping_categories.d.ts +5 -4
  120. package/lib/cjs/resources/shipping_method_tiers.d.ts +7 -6
  121. package/lib/cjs/resources/shipping_methods.d.ts +50 -49
  122. package/lib/cjs/resources/shipping_weight_tiers.d.ts +12 -11
  123. package/lib/cjs/resources/shipping_zones.d.ts +22 -21
  124. package/lib/cjs/resources/sku_list_items.d.ts +13 -12
  125. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +14 -13
  126. package/lib/cjs/resources/sku_lists.d.ts +22 -21
  127. package/lib/cjs/resources/sku_options.d.ts +25 -24
  128. package/lib/cjs/resources/skus.d.ts +36 -35
  129. package/lib/cjs/resources/stock_items.d.ts +12 -11
  130. package/lib/cjs/resources/stock_line_items.d.ts +7 -6
  131. package/lib/cjs/resources/stock_locations.d.ts +17 -16
  132. package/lib/cjs/resources/stock_transfers.d.ts +24 -23
  133. package/lib/cjs/resources/stripe_gateways.d.ts +12 -11
  134. package/lib/cjs/resources/stripe_payments.d.ts +15 -14
  135. package/lib/cjs/resources/subscription_models.d.ts +49 -0
  136. package/lib/cjs/resources/subscription_models.js +37 -0
  137. package/lib/cjs/resources/tax_calculators.d.ts +4 -3
  138. package/lib/cjs/resources/tax_categories.d.ts +10 -9
  139. package/lib/cjs/resources/tax_rules.d.ts +39 -38
  140. package/lib/cjs/resources/taxjar_accounts.d.ts +9 -8
  141. package/lib/cjs/resources/transactions.d.ts +8 -7
  142. package/lib/cjs/resources/voids.d.ts +10 -9
  143. package/lib/cjs/resources/webhooks.d.ts +14 -13
  144. package/lib/cjs/resources/wire_transfers.d.ts +5 -4
  145. package/lib/cjs/static.d.ts +1 -1
  146. package/lib/cjs/util.d.ts +1 -3
  147. package/lib/esm/api.d.ts +27 -2
  148. package/lib/esm/api.js +10 -13
  149. package/lib/esm/client.d.ts +3 -5
  150. package/lib/esm/commercelayer.d.ts +10 -5
  151. package/lib/esm/commercelayer.js +8 -3
  152. package/lib/esm/common.d.ts +1 -0
  153. package/lib/esm/common.js +11 -0
  154. package/lib/esm/index.d.ts +1 -1
  155. package/lib/esm/index.js +0 -2
  156. package/lib/esm/interceptor.d.ts +1 -1
  157. package/lib/esm/model.d.ts +6 -1
  158. package/lib/esm/query.d.ts +6 -14
  159. package/lib/esm/resource.d.ts +14 -20
  160. package/lib/esm/resources/addresses.d.ts +51 -50
  161. package/lib/esm/resources/adjustments.d.ts +5 -4
  162. package/lib/esm/resources/adyen_gateways.d.ts +21 -20
  163. package/lib/esm/resources/adyen_payments.d.ts +15 -14
  164. package/lib/esm/resources/application.d.ts +7 -6
  165. package/lib/esm/resources/attachments.d.ts +11 -10
  166. package/lib/esm/resources/authorizations.d.ts +28 -27
  167. package/lib/esm/resources/avalara_accounts.d.ts +17 -16
  168. package/lib/esm/resources/axerve_gateways.d.ts +9 -8
  169. package/lib/esm/resources/axerve_payments.d.ts +12 -11
  170. package/lib/esm/resources/billing_info_validation_rules.d.ts +5 -4
  171. package/lib/esm/resources/bing_geocoders.d.ts +6 -5
  172. package/lib/esm/resources/braintree_gateways.d.ts +21 -20
  173. package/lib/esm/resources/braintree_payments.d.ts +17 -16
  174. package/lib/esm/resources/bundles.d.ts +27 -26
  175. package/lib/esm/resources/captures.d.ts +19 -18
  176. package/lib/esm/resources/carrier_accounts.d.ts +7 -6
  177. package/lib/esm/resources/checkout_com_gateways.d.ts +12 -11
  178. package/lib/esm/resources/checkout_com_payments.d.ts +25 -24
  179. package/lib/esm/resources/cleanups.d.ts +13 -12
  180. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -6
  181. package/lib/esm/resources/coupon_recipients.d.ts +13 -12
  182. package/lib/esm/resources/coupons.d.ts +13 -12
  183. package/lib/esm/resources/customer_addresses.d.ts +8 -7
  184. package/lib/esm/resources/customer_groups.d.ts +6 -5
  185. package/lib/esm/resources/customer_password_resets.d.ts +8 -7
  186. package/lib/esm/resources/customer_payment_sources.d.ts +9 -8
  187. package/lib/esm/resources/customer_subscriptions.d.ts +4 -3
  188. package/lib/esm/resources/customers.d.ts +19 -18
  189. package/lib/esm/resources/delivery_lead_times.d.ts +11 -10
  190. package/lib/esm/resources/event_callbacks.d.ts +6 -5
  191. package/lib/esm/resources/events.d.ts +4 -3
  192. package/lib/esm/resources/exports.d.ts +17 -16
  193. package/lib/esm/resources/external_gateways.d.ts +20 -19
  194. package/lib/esm/resources/external_payments.d.ts +10 -9
  195. package/lib/esm/resources/external_promotions.d.ts +29 -28
  196. package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
  197. package/lib/esm/resources/fixed_amount_promotions.d.ts +31 -30
  198. package/lib/esm/resources/fixed_price_promotions.d.ts +36 -35
  199. package/lib/esm/resources/fixed_price_promotions.js +4 -4
  200. package/lib/esm/resources/free_gift_promotions.d.ts +36 -35
  201. package/lib/esm/resources/free_gift_promotions.js +4 -4
  202. package/lib/esm/resources/free_shipping_promotions.d.ts +30 -26
  203. package/lib/esm/resources/free_shipping_promotions.js +4 -0
  204. package/lib/esm/resources/geocoders.d.ts +4 -3
  205. package/lib/esm/resources/gift_card_recipients.d.ts +13 -12
  206. package/lib/esm/resources/gift_cards.d.ts +41 -40
  207. package/lib/esm/resources/google_geocoders.d.ts +6 -5
  208. package/lib/esm/resources/imports.d.ts +20 -19
  209. package/lib/esm/resources/in_stock_subscriptions.d.ts +20 -19
  210. package/lib/esm/resources/inventory_models.d.ts +12 -11
  211. package/lib/esm/resources/inventory_return_locations.d.ts +7 -6
  212. package/lib/esm/resources/inventory_stock_locations.d.ts +10 -9
  213. package/lib/esm/resources/klarna_gateways.d.ts +10 -9
  214. package/lib/esm/resources/klarna_payments.d.ts +14 -13
  215. package/lib/esm/resources/line_item_options.d.ts +18 -17
  216. package/lib/esm/resources/line_items.d.ts +47 -43
  217. package/lib/esm/resources/manual_gateways.d.ts +4 -3
  218. package/lib/esm/resources/manual_tax_calculators.d.ts +8 -7
  219. package/lib/esm/resources/markets.d.ts +41 -32
  220. package/lib/esm/resources/markets.js +4 -0
  221. package/lib/esm/resources/merchants.d.ts +6 -5
  222. package/lib/esm/resources/order_amount_promotion_rules.d.ts +9 -8
  223. package/lib/esm/resources/order_copies.d.ts +23 -20
  224. package/lib/esm/resources/order_copies.js +7 -4
  225. package/lib/esm/resources/order_factories.d.ts +34 -0
  226. package/lib/esm/resources/order_factories.js +26 -0
  227. package/lib/esm/resources/order_subscription_items.d.ts +61 -0
  228. package/lib/esm/resources/order_subscription_items.js +27 -0
  229. package/lib/esm/resources/order_subscriptions.d.ts +52 -29
  230. package/lib/esm/resources/order_subscriptions.js +18 -2
  231. package/lib/esm/resources/order_validation_rules.d.ts +4 -3
  232. package/lib/esm/resources/orders.d.ts +192 -183
  233. package/lib/esm/resources/orders.js +8 -0
  234. package/lib/esm/resources/organization.d.ts +18 -17
  235. package/lib/esm/resources/packages.d.ts +14 -13
  236. package/lib/esm/resources/parcel_line_items.d.ts +7 -6
  237. package/lib/esm/resources/parcels.d.ts +75 -74
  238. package/lib/esm/resources/payment_gateways.d.ts +3 -2
  239. package/lib/esm/resources/payment_methods.d.ts +33 -32
  240. package/lib/esm/resources/paypal_gateways.d.ts +7 -6
  241. package/lib/esm/resources/paypal_payments.d.ts +17 -16
  242. package/lib/esm/resources/percentage_discount_promotions.d.ts +35 -34
  243. package/lib/esm/resources/percentage_discount_promotions.js +4 -4
  244. package/lib/esm/resources/price_frequency_tiers.d.ts +50 -0
  245. package/lib/esm/resources/price_frequency_tiers.js +35 -0
  246. package/lib/esm/resources/price_lists.d.ts +9 -8
  247. package/lib/esm/resources/price_tiers.d.ts +7 -6
  248. package/lib/esm/resources/price_volume_tiers.d.ts +15 -11
  249. package/lib/esm/resources/price_volume_tiers.js +4 -0
  250. package/lib/esm/resources/prices.d.ts +20 -16
  251. package/lib/esm/resources/prices.js +4 -0
  252. package/lib/esm/resources/promotion_rules.d.ts +3 -2
  253. package/lib/esm/resources/promotions.d.ts +14 -10
  254. package/lib/esm/resources/promotions.js +4 -0
  255. package/lib/esm/resources/recurring_order_copies.d.ts +53 -0
  256. package/lib/esm/resources/recurring_order_copies.js +39 -0
  257. package/lib/esm/resources/refunds.d.ts +10 -9
  258. package/lib/esm/resources/return_line_items.d.ts +13 -12
  259. package/lib/esm/resources/returns.d.ts +31 -30
  260. package/lib/esm/resources/satispay_gateways.d.ts +8 -7
  261. package/lib/esm/resources/satispay_payments.d.ts +12 -11
  262. package/lib/esm/resources/shipments.d.ts +42 -41
  263. package/lib/esm/resources/shipping_categories.d.ts +5 -4
  264. package/lib/esm/resources/shipping_method_tiers.d.ts +7 -6
  265. package/lib/esm/resources/shipping_methods.d.ts +50 -49
  266. package/lib/esm/resources/shipping_weight_tiers.d.ts +12 -11
  267. package/lib/esm/resources/shipping_zones.d.ts +22 -21
  268. package/lib/esm/resources/sku_list_items.d.ts +13 -12
  269. package/lib/esm/resources/sku_list_promotion_rules.d.ts +14 -13
  270. package/lib/esm/resources/sku_lists.d.ts +22 -21
  271. package/lib/esm/resources/sku_options.d.ts +25 -24
  272. package/lib/esm/resources/skus.d.ts +36 -35
  273. package/lib/esm/resources/stock_items.d.ts +12 -11
  274. package/lib/esm/resources/stock_line_items.d.ts +7 -6
  275. package/lib/esm/resources/stock_locations.d.ts +17 -16
  276. package/lib/esm/resources/stock_transfers.d.ts +24 -23
  277. package/lib/esm/resources/stripe_gateways.d.ts +12 -11
  278. package/lib/esm/resources/stripe_payments.d.ts +15 -14
  279. package/lib/esm/resources/subscription_models.d.ts +49 -0
  280. package/lib/esm/resources/subscription_models.js +35 -0
  281. package/lib/esm/resources/tax_calculators.d.ts +4 -3
  282. package/lib/esm/resources/tax_categories.d.ts +10 -9
  283. package/lib/esm/resources/tax_rules.d.ts +39 -38
  284. package/lib/esm/resources/taxjar_accounts.d.ts +9 -8
  285. package/lib/esm/resources/transactions.d.ts +8 -7
  286. package/lib/esm/resources/voids.d.ts +10 -9
  287. package/lib/esm/resources/webhooks.d.ts +14 -13
  288. package/lib/esm/resources/wire_transfers.d.ts +5 -4
  289. package/lib/esm/static.d.ts +1 -1
  290. package/lib/esm/util.d.ts +1 -3
  291. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  292. package/lib/tsconfig.tsbuildinfo +1 -1
  293. package/package.json +10 -10
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Market, MarketType } from './markets';
4
5
  import type { Customer, CustomerType } from './customers';
@@ -25,7 +26,9 @@ import type { Capture } from './captures';
25
26
  import type { Refund } from './refunds';
26
27
  import type { Return } from './returns';
27
28
  import type { OrderSubscription } from './order_subscriptions';
29
+ import type { OrderFactory } from './order_factories';
28
30
  import type { OrderCopy } from './order_copies';
31
+ import type { RecurringOrderCopy } from './recurring_order_copies';
29
32
  import type { Attachment } from './attachments';
30
33
  import type { Event } from './events';
31
34
  type OrderType = 'orders';
@@ -76,192 +79,196 @@ type WireTransferRel = ResourceRel & {
76
79
  };
77
80
  interface Order extends Resource {
78
81
  readonly type: OrderType;
79
- number?: number;
80
- autorefresh?: boolean;
81
- status?: 'draft' | 'pending' | 'placed' | 'approved' | 'cancelled';
82
- payment_status?: 'unpaid' | 'authorized' | 'paid' | 'voided' | 'refunded' | 'free';
83
- fulfillment_status?: 'unfulfilled' | 'in_progress' | 'fulfilled' | 'not_required';
84
- guest?: boolean;
85
- editable?: boolean;
86
- customer_email?: string;
87
- language_code?: string;
88
- currency_code?: string;
89
- tax_included?: boolean;
90
- tax_rate?: number;
91
- freight_taxable?: boolean;
92
- requires_billing_info?: boolean;
93
- country_code?: string;
94
- shipping_country_code_lock?: string;
95
- coupon_code?: string;
96
- gift_card_code?: string;
97
- gift_card_or_coupon_code?: string;
98
- subtotal_amount_cents?: number;
99
- subtotal_amount_float?: number;
100
- formatted_subtotal_amount?: string;
101
- shipping_amount_cents?: number;
102
- shipping_amount_float?: number;
103
- formatted_shipping_amount?: string;
104
- payment_method_amount_cents?: number;
105
- payment_method_amount_float?: number;
106
- formatted_payment_method_amount?: string;
107
- discount_amount_cents?: number;
108
- discount_amount_float?: number;
109
- formatted_discount_amount?: string;
110
- adjustment_amount_cents?: number;
111
- adjustment_amount_float?: number;
112
- formatted_adjustment_amount?: string;
113
- gift_card_amount_cents?: number;
114
- gift_card_amount_float?: number;
115
- formatted_gift_card_amount?: string;
116
- total_tax_amount_cents?: number;
117
- total_tax_amount_float?: number;
118
- formatted_total_tax_amount?: string;
119
- subtotal_tax_amount_cents?: number;
120
- subtotal_tax_amount_float?: number;
121
- formatted_subtotal_tax_amount?: string;
122
- shipping_tax_amount_cents?: number;
123
- shipping_tax_amount_float?: number;
124
- formatted_shipping_tax_amount?: string;
125
- payment_method_tax_amount_cents?: number;
126
- payment_method_tax_amount_float?: number;
127
- formatted_payment_method_tax_amount?: string;
128
- adjustment_tax_amount_cents?: number;
129
- adjustment_tax_amount_float?: number;
130
- formatted_adjustment_tax_amount?: string;
131
- total_amount_cents?: number;
132
- total_amount_float?: number;
133
- formatted_total_amount?: string;
134
- total_taxable_amount_cents?: number;
135
- total_taxable_amount_float?: number;
136
- formatted_total_taxable_amount?: string;
137
- subtotal_taxable_amount_cents?: number;
138
- subtotal_taxable_amount_float?: number;
139
- formatted_subtotal_taxable_amount?: string;
140
- shipping_taxable_amount_cents?: number;
141
- shipping_taxable_amount_float?: number;
142
- formatted_shipping_taxable_amount?: string;
143
- payment_method_taxable_amount_cents?: number;
144
- payment_method_taxable_amount_float?: number;
145
- formatted_payment_method_taxable_amount?: string;
146
- adjustment_taxable_amount_cents?: number;
147
- adjustment_taxable_amount_float?: number;
148
- formatted_adjustment_taxable_amount?: string;
149
- total_amount_with_taxes_cents?: number;
150
- total_amount_with_taxes_float?: number;
151
- formatted_total_amount_with_taxes?: string;
152
- fees_amount_cents?: number;
153
- fees_amount_float?: number;
154
- formatted_fees_amount?: string;
155
- duty_amount_cents?: number;
156
- duty_amount_float?: number;
157
- formatted_duty_amount?: string;
158
- skus_count?: number;
159
- line_item_options_count?: number;
160
- shipments_count?: number;
161
- tax_calculations_count?: number;
162
- payment_source_details?: object;
163
- token?: string;
164
- cart_url?: string;
165
- return_url?: string;
166
- terms_url?: string;
167
- privacy_url?: string;
168
- checkout_url?: string;
169
- placed_at?: string;
170
- approved_at?: string;
171
- cancelled_at?: string;
172
- payment_updated_at?: string;
173
- fulfillment_updated_at?: string;
174
- refreshed_at?: string;
175
- archived_at?: string;
176
- expires_at?: string;
177
- market?: Market;
178
- customer?: Customer;
179
- shipping_address?: Address;
180
- billing_address?: Address;
181
- available_payment_methods?: PaymentMethod[];
182
- available_customer_payment_sources?: CustomerPaymentSource[];
183
- available_free_skus?: Sku[];
184
- available_free_bundles?: Bundle[];
185
- payment_method?: PaymentMethod;
186
- payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer;
187
- line_items?: LineItem[];
188
- shipments?: Shipment[];
189
- transactions?: Array<Authorization | Void | Capture | Refund>;
190
- authorizations?: Authorization[];
191
- captures?: Capture[];
192
- voids?: Void[];
193
- refunds?: Refund[];
194
- returns?: Return[];
195
- order_subscriptions?: OrderSubscription[];
196
- order_copies?: OrderCopy[];
197
- attachments?: Attachment[];
198
- events?: Event[];
82
+ number?: number | null;
83
+ autorefresh?: boolean | null;
84
+ status: 'draft' | 'pending' | 'placed' | 'approved' | 'cancelled';
85
+ payment_status: 'unpaid' | 'authorized' | 'partially_authorized' | 'paid' | 'partially_paid' | 'voided' | 'partially_voided' | 'refunded' | 'partially_refunded' | 'free';
86
+ fulfillment_status: 'unfulfilled' | 'in_progress' | 'fulfilled' | 'not_required';
87
+ guest?: boolean | null;
88
+ editable?: boolean | null;
89
+ customer_email?: string | null;
90
+ language_code?: string | null;
91
+ currency_code?: string | null;
92
+ tax_included?: boolean | null;
93
+ tax_rate?: number | null;
94
+ freight_taxable?: boolean | null;
95
+ requires_billing_info?: boolean | null;
96
+ country_code?: string | null;
97
+ shipping_country_code_lock?: string | null;
98
+ coupon_code?: string | null;
99
+ gift_card_code?: string | null;
100
+ gift_card_or_coupon_code?: string | null;
101
+ subtotal_amount_cents?: number | null;
102
+ subtotal_amount_float?: number | null;
103
+ formatted_subtotal_amount?: string | null;
104
+ shipping_amount_cents?: number | null;
105
+ shipping_amount_float?: number | null;
106
+ formatted_shipping_amount?: string | null;
107
+ payment_method_amount_cents?: number | null;
108
+ payment_method_amount_float?: number | null;
109
+ formatted_payment_method_amount?: string | null;
110
+ discount_amount_cents?: number | null;
111
+ discount_amount_float?: number | null;
112
+ formatted_discount_amount?: string | null;
113
+ adjustment_amount_cents?: number | null;
114
+ adjustment_amount_float?: number | null;
115
+ formatted_adjustment_amount?: string | null;
116
+ gift_card_amount_cents?: number | null;
117
+ gift_card_amount_float?: number | null;
118
+ formatted_gift_card_amount?: string | null;
119
+ total_tax_amount_cents?: number | null;
120
+ total_tax_amount_float?: number | null;
121
+ formatted_total_tax_amount?: string | null;
122
+ subtotal_tax_amount_cents?: number | null;
123
+ subtotal_tax_amount_float?: number | null;
124
+ formatted_subtotal_tax_amount?: string | null;
125
+ shipping_tax_amount_cents?: number | null;
126
+ shipping_tax_amount_float?: number | null;
127
+ formatted_shipping_tax_amount?: string | null;
128
+ payment_method_tax_amount_cents?: number | null;
129
+ payment_method_tax_amount_float?: number | null;
130
+ formatted_payment_method_tax_amount?: string | null;
131
+ adjustment_tax_amount_cents?: number | null;
132
+ adjustment_tax_amount_float?: number | null;
133
+ formatted_adjustment_tax_amount?: string | null;
134
+ total_amount_cents?: number | null;
135
+ total_amount_float?: number | null;
136
+ formatted_total_amount?: string | null;
137
+ total_taxable_amount_cents?: number | null;
138
+ total_taxable_amount_float?: number | null;
139
+ formatted_total_taxable_amount?: string | null;
140
+ subtotal_taxable_amount_cents?: number | null;
141
+ subtotal_taxable_amount_float?: number | null;
142
+ formatted_subtotal_taxable_amount?: string | null;
143
+ shipping_taxable_amount_cents?: number | null;
144
+ shipping_taxable_amount_float?: number | null;
145
+ formatted_shipping_taxable_amount?: string | null;
146
+ payment_method_taxable_amount_cents?: number | null;
147
+ payment_method_taxable_amount_float?: number | null;
148
+ formatted_payment_method_taxable_amount?: string | null;
149
+ adjustment_taxable_amount_cents?: number | null;
150
+ adjustment_taxable_amount_float?: number | null;
151
+ formatted_adjustment_taxable_amount?: string | null;
152
+ total_amount_with_taxes_cents?: number | null;
153
+ total_amount_with_taxes_float?: number | null;
154
+ formatted_total_amount_with_taxes?: string | null;
155
+ fees_amount_cents?: number | null;
156
+ fees_amount_float?: number | null;
157
+ formatted_fees_amount?: string | null;
158
+ duty_amount_cents?: number | null;
159
+ duty_amount_float?: number | null;
160
+ formatted_duty_amount?: string | null;
161
+ skus_count?: number | null;
162
+ line_item_options_count?: number | null;
163
+ shipments_count?: number | null;
164
+ tax_calculations_count?: number | null;
165
+ payment_source_details?: object | null;
166
+ token?: string | null;
167
+ cart_url?: string | null;
168
+ return_url?: string | null;
169
+ terms_url?: string | null;
170
+ privacy_url?: string | null;
171
+ checkout_url?: string | null;
172
+ placed_at?: string | null;
173
+ approved_at?: string | null;
174
+ cancelled_at?: string | null;
175
+ payment_updated_at?: string | null;
176
+ fulfillment_updated_at?: string | null;
177
+ refreshed_at?: string | null;
178
+ archived_at?: string | null;
179
+ expires_at?: string | null;
180
+ subscription_created_at?: string | null;
181
+ market?: Market | null;
182
+ customer?: Customer | null;
183
+ shipping_address?: Address | null;
184
+ billing_address?: Address | null;
185
+ available_payment_methods?: PaymentMethod[] | null;
186
+ available_customer_payment_sources?: CustomerPaymentSource[] | null;
187
+ available_free_skus?: Sku[] | null;
188
+ available_free_bundles?: Bundle[] | null;
189
+ payment_method?: PaymentMethod | null;
190
+ payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
191
+ line_items?: LineItem[] | null;
192
+ shipments?: Shipment[] | null;
193
+ transactions?: Array<Authorization | Void | Capture | Refund> | null;
194
+ authorizations?: Authorization[] | null;
195
+ captures?: Capture[] | null;
196
+ voids?: Void[] | null;
197
+ refunds?: Refund[] | null;
198
+ returns?: Return[] | null;
199
+ order_subscriptions?: OrderSubscription[] | null;
200
+ order_factories?: OrderFactory[] | null;
201
+ order_copies?: OrderCopy[] | null;
202
+ recurring_order_copies?: RecurringOrderCopy[] | null;
203
+ attachments?: Attachment[] | null;
204
+ events?: Event[] | null;
199
205
  }
200
206
  interface OrderCreate extends ResourceCreate {
201
- autorefresh?: boolean;
202
- guest?: boolean;
203
- customer_email?: string;
204
- customer_password?: string;
205
- language_code?: string;
206
- shipping_country_code_lock?: string;
207
- coupon_code?: string;
208
- gift_card_code?: string;
209
- gift_card_or_coupon_code?: string;
210
- cart_url?: string;
211
- return_url?: string;
212
- terms_url?: string;
213
- privacy_url?: string;
214
- market?: MarketRel;
215
- customer?: CustomerRel;
216
- shipping_address?: AddressRel;
217
- billing_address?: AddressRel;
218
- payment_method?: PaymentMethodRel;
219
- payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
207
+ autorefresh?: boolean | null;
208
+ guest?: boolean | null;
209
+ customer_email?: string | null;
210
+ customer_password?: string | null;
211
+ language_code?: string | null;
212
+ shipping_country_code_lock?: string | null;
213
+ coupon_code?: string | null;
214
+ gift_card_code?: string | null;
215
+ gift_card_or_coupon_code?: string | null;
216
+ cart_url?: string | null;
217
+ return_url?: string | null;
218
+ terms_url?: string | null;
219
+ privacy_url?: string | null;
220
+ market?: MarketRel | null;
221
+ customer?: CustomerRel | null;
222
+ shipping_address?: AddressRel | null;
223
+ billing_address?: AddressRel | null;
224
+ payment_method?: PaymentMethodRel | null;
225
+ payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel | null;
220
226
  }
221
227
  interface OrderUpdate extends ResourceUpdate {
222
- autorefresh?: boolean;
223
- guest?: boolean;
224
- customer_email?: string;
225
- customer_password?: string;
226
- language_code?: string;
227
- shipping_country_code_lock?: string;
228
- coupon_code?: string;
229
- gift_card_code?: string;
230
- gift_card_or_coupon_code?: string;
231
- cart_url?: string;
232
- return_url?: string;
233
- terms_url?: string;
234
- privacy_url?: string;
235
- _archive?: boolean;
236
- _unarchive?: boolean;
237
- _place?: boolean;
238
- _cancel?: boolean;
239
- _approve?: boolean;
240
- _approve_and_capture?: boolean;
241
- _authorize?: boolean;
242
- _authorization_amount_cents?: number;
243
- _capture?: boolean;
244
- _refund?: boolean;
245
- _update_taxes?: boolean;
246
- _nullify_payment_source?: boolean;
247
- _billing_address_clone_id?: string;
248
- _shipping_address_clone_id?: string;
249
- _customer_payment_source_id?: string;
250
- _shipping_address_same_as_billing?: boolean;
251
- _billing_address_same_as_shipping?: boolean;
252
- _commit_invoice?: boolean;
253
- _refund_invoice?: boolean;
254
- _save_payment_source_to_customer_wallet?: boolean;
255
- _save_shipping_address_to_customer_address_book?: boolean;
256
- _save_billing_address_to_customer_address_book?: boolean;
257
- _refresh?: boolean;
258
- _validate?: boolean;
259
- market?: MarketRel;
260
- customer?: CustomerRel;
261
- shipping_address?: AddressRel;
262
- billing_address?: AddressRel;
263
- payment_method?: PaymentMethodRel;
264
- payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
228
+ autorefresh?: boolean | null;
229
+ guest?: boolean | null;
230
+ customer_email?: string | null;
231
+ customer_password?: string | null;
232
+ language_code?: string | null;
233
+ shipping_country_code_lock?: string | null;
234
+ coupon_code?: string | null;
235
+ gift_card_code?: string | null;
236
+ gift_card_or_coupon_code?: string | null;
237
+ cart_url?: string | null;
238
+ return_url?: string | null;
239
+ terms_url?: string | null;
240
+ privacy_url?: string | null;
241
+ _archive?: boolean | null;
242
+ _unarchive?: boolean | null;
243
+ _place?: boolean | null;
244
+ _cancel?: boolean | null;
245
+ _approve?: boolean | null;
246
+ _approve_and_capture?: boolean | null;
247
+ _authorize?: boolean | null;
248
+ _authorization_amount_cents?: number | null;
249
+ _capture?: boolean | null;
250
+ _refund?: boolean | null;
251
+ _update_taxes?: boolean | null;
252
+ _nullify_payment_source?: boolean | null;
253
+ _billing_address_clone_id?: string | null;
254
+ _shipping_address_clone_id?: string | null;
255
+ _customer_payment_source_id?: string | null;
256
+ _shipping_address_same_as_billing?: boolean | null;
257
+ _billing_address_same_as_shipping?: boolean | null;
258
+ _commit_invoice?: boolean | null;
259
+ _refund_invoice?: boolean | null;
260
+ _save_payment_source_to_customer_wallet?: boolean | null;
261
+ _save_shipping_address_to_customer_address_book?: boolean | null;
262
+ _save_billing_address_to_customer_address_book?: boolean | null;
263
+ _refresh?: boolean | null;
264
+ _validate?: boolean | null;
265
+ _create_subscriptions?: boolean | null;
266
+ market?: MarketRel | null;
267
+ customer?: CustomerRel | null;
268
+ shipping_address?: AddressRel | null;
269
+ billing_address?: AddressRel | null;
270
+ payment_method?: PaymentMethodRel | null;
271
+ payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel | null;
265
272
  }
266
273
  declare class Orders extends ApiResource<Order> {
267
274
  static readonly TYPE: OrderType;
@@ -285,7 +292,9 @@ declare class Orders extends ApiResource<Order> {
285
292
  refunds(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
286
293
  returns(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
287
294
  order_subscriptions(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
295
+ order_factories(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderFactory>>;
288
296
  order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
297
+ recurring_order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<RecurringOrderCopy>>;
289
298
  attachments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
290
299
  events(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
291
300
  isOrder(resource: any): resource is Order;
@@ -79,10 +79,18 @@ class Orders extends resource_1.ApiResource {
79
79
  const _orderId = orderId.id || orderId;
80
80
  return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
81
81
  }
82
+ async order_factories(orderId, params, options) {
83
+ const _orderId = orderId.id || orderId;
84
+ return this.resources.fetch({ type: 'order_factories' }, `orders/${_orderId}/order_factories`, params, options);
85
+ }
82
86
  async order_copies(orderId, params, options) {
83
87
  const _orderId = orderId.id || orderId;
84
88
  return this.resources.fetch({ type: 'order_copies' }, `orders/${_orderId}/order_copies`, params, options);
85
89
  }
90
+ async recurring_order_copies(orderId, params, options) {
91
+ const _orderId = orderId.id || orderId;
92
+ return this.resources.fetch({ type: 'recurring_order_copies' }, `orders/${_orderId}/recurring_order_copies`, params, options);
93
+ }
86
94
  async attachments(orderId, params, options) {
87
95
  const _orderId = orderId.id || orderId;
88
96
  return this.resources.fetch({ type: 'attachments' }, `orders/${_orderId}/attachments`, params, options);
@@ -1,26 +1,27 @@
1
- import { ApiSingleton, Resource, ResourceId, ResourceRel } from '../resource';
1
+ import { ApiSingleton } from '../resource';
2
+ import type { Resource, ResourceId, ResourceRel } from '../resource';
2
3
  type OrganizationType = 'organization';
3
4
  type OrganizationRel = ResourceRel & {
4
5
  type: OrganizationType;
5
6
  };
6
7
  interface Organization extends Resource {
7
8
  readonly type: OrganizationType;
8
- name?: string;
9
- slug?: string;
10
- domain?: string;
11
- support_phone?: string;
12
- support_email?: string;
13
- logo_url?: string;
14
- favicon_url?: string;
15
- primary_color?: string;
16
- contrast_color?: string;
17
- gtm_id?: string;
18
- gtm_id_test?: string;
19
- discount_disabled?: boolean;
20
- account_disabled?: boolean;
21
- acceptance_disabled?: boolean;
22
- max_concurrent_promotions?: number;
23
- max_concurrent_imports?: number;
9
+ name?: string | null;
10
+ slug?: string | null;
11
+ domain?: string | null;
12
+ support_phone?: string | null;
13
+ support_email?: string | null;
14
+ logo_url?: string | null;
15
+ favicon_url?: string | null;
16
+ primary_color?: string | null;
17
+ contrast_color?: string | null;
18
+ gtm_id?: string | null;
19
+ gtm_id_test?: string | null;
20
+ discount_disabled?: boolean | null;
21
+ account_disabled?: boolean | null;
22
+ acceptance_disabled?: boolean | null;
23
+ max_concurrent_promotions?: number | null;
24
+ max_concurrent_imports?: number | null;
24
25
  }
25
26
  declare class Organizations extends ApiSingleton<Organization> {
26
27
  static readonly TYPE: OrganizationType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { StockLocation, StockLocationType } from './stock_locations';
4
5
  import type { Parcel } from './parcels';
@@ -13,18 +14,18 @@ type StockLocationRel = ResourceRel & {
13
14
  interface Package extends Resource {
14
15
  readonly type: PackageType;
15
16
  name: string;
16
- code?: string;
17
+ code?: string | null;
17
18
  length: number;
18
19
  width: number;
19
20
  height: number;
20
21
  unit_of_length: string;
21
- stock_location?: StockLocation;
22
- parcels?: Parcel[];
23
- attachments?: Attachment[];
22
+ stock_location?: StockLocation | null;
23
+ parcels?: Parcel[] | null;
24
+ attachments?: Attachment[] | null;
24
25
  }
25
26
  interface PackageCreate extends ResourceCreate {
26
27
  name: string;
27
- code?: string;
28
+ code?: string | null;
28
29
  length: number;
29
30
  width: number;
30
31
  height: number;
@@ -32,13 +33,13 @@ interface PackageCreate extends ResourceCreate {
32
33
  stock_location: StockLocationRel;
33
34
  }
34
35
  interface PackageUpdate extends ResourceUpdate {
35
- name: string;
36
- code?: string;
37
- length: number;
38
- width: number;
39
- height: number;
40
- unit_of_length: string;
41
- stock_location?: StockLocationRel;
36
+ name?: string | null;
37
+ code?: string | null;
38
+ length?: number | null;
39
+ width?: number | null;
40
+ height?: number | null;
41
+ unit_of_length?: string | null;
42
+ stock_location?: StockLocationRel | null;
42
43
  }
43
44
  declare class Packages extends ApiResource<Package> {
44
45
  static readonly TYPE: PackageType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
2
3
  import type { QueryParamsRetrieve } from '../query';
3
4
  import type { Parcel, ParcelType } from './parcels';
4
5
  import type { StockLineItem, StockLineItemType } from './stock_line_items';
@@ -14,19 +15,19 @@ type StockLineItemRel = ResourceRel & {
14
15
  };
15
16
  interface ParcelLineItem extends Resource {
16
17
  readonly type: ParcelLineItemType;
17
- sku_code?: string;
18
+ sku_code?: string | null;
18
19
  quantity: number;
19
20
  name: string;
20
- image_url?: string;
21
- parcel?: Parcel;
22
- stock_line_item?: StockLineItem;
21
+ image_url?: string | null;
22
+ parcel?: Parcel | null;
23
+ stock_line_item?: StockLineItem | null;
23
24
  /**
24
25
  * @deprecated This field should not be used as it may be removed in the future without notice
25
26
  */
26
27
  shipment_line_item?: object;
27
28
  }
28
29
  interface ParcelLineItemCreate extends ResourceCreate {
29
- sku_code?: string;
30
+ sku_code?: string | null;
30
31
  quantity: number;
31
32
  parcel: ParcelRel;
32
33
  stock_line_item: StockLineItemRel;