@commercelayer/sdk 5.0.0-beta.9 → 5.1.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 (319) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +18 -0
  3. package/lib/cjs/api.d.ts +23 -12
  4. package/lib/cjs/api.js +20 -2
  5. package/lib/cjs/client.d.ts +3 -5
  6. package/lib/cjs/commercelayer.d.ts +10 -4
  7. package/lib/cjs/commercelayer.js +9 -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 -2
  11. package/lib/cjs/index.js +0 -16
  12. package/lib/cjs/interceptor.d.ts +1 -1
  13. package/lib/cjs/model.d.ts +7 -1
  14. package/lib/cjs/query.d.ts +5 -13
  15. package/lib/cjs/resource.d.ts +8 -10
  16. package/lib/cjs/resources/addresses.d.ts +63 -51
  17. package/lib/cjs/resources/addresses.js +8 -0
  18. package/lib/cjs/resources/adjustments.d.ts +5 -4
  19. package/lib/cjs/resources/adyen_gateways.d.ts +21 -20
  20. package/lib/cjs/resources/adyen_payments.d.ts +16 -15
  21. package/lib/cjs/resources/application.d.ts +7 -6
  22. package/lib/cjs/resources/attachments.d.ts +11 -10
  23. package/lib/cjs/resources/authorizations.d.ts +28 -27
  24. package/lib/cjs/resources/avalara_accounts.d.ts +17 -16
  25. package/lib/cjs/resources/axerve_gateways.d.ts +9 -8
  26. package/lib/cjs/resources/axerve_payments.d.ts +12 -11
  27. package/lib/cjs/resources/billing_info_validation_rules.d.ts +5 -4
  28. package/lib/cjs/resources/bing_geocoders.d.ts +6 -5
  29. package/lib/cjs/resources/braintree_gateways.d.ts +21 -20
  30. package/lib/cjs/resources/braintree_payments.d.ts +17 -16
  31. package/lib/cjs/resources/bundles.d.ts +38 -26
  32. package/lib/cjs/resources/bundles.js +8 -0
  33. package/lib/cjs/resources/captures.d.ts +19 -18
  34. package/lib/cjs/resources/carrier_accounts.d.ts +7 -6
  35. package/lib/cjs/resources/checkout_com_gateways.d.ts +12 -11
  36. package/lib/cjs/resources/checkout_com_payments.d.ts +25 -24
  37. package/lib/cjs/resources/cleanups.d.ts +13 -12
  38. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -6
  39. package/lib/cjs/resources/coupon_recipients.d.ts +13 -12
  40. package/lib/cjs/resources/coupons.d.ts +27 -15
  41. package/lib/cjs/resources/coupons.js +8 -0
  42. package/lib/cjs/resources/customer_addresses.d.ts +8 -7
  43. package/lib/cjs/resources/customer_groups.d.ts +6 -5
  44. package/lib/cjs/resources/customer_password_resets.d.ts +8 -7
  45. package/lib/cjs/resources/customer_payment_sources.d.ts +9 -8
  46. package/lib/cjs/resources/customer_subscriptions.d.ts +4 -3
  47. package/lib/cjs/resources/customers.d.ts +27 -18
  48. package/lib/cjs/resources/customers.js +4 -0
  49. package/lib/cjs/resources/delivery_lead_times.d.ts +11 -10
  50. package/lib/cjs/resources/event_callbacks.d.ts +6 -5
  51. package/lib/cjs/resources/events.d.ts +4 -3
  52. package/lib/cjs/resources/exports.d.ts +17 -16
  53. package/lib/cjs/resources/external_gateways.d.ts +20 -19
  54. package/lib/cjs/resources/external_payments.d.ts +10 -9
  55. package/lib/cjs/resources/external_promotions.d.ts +37 -28
  56. package/lib/cjs/resources/external_promotions.js +4 -0
  57. package/lib/cjs/resources/external_tax_calculators.d.ts +6 -5
  58. package/lib/cjs/resources/fixed_amount_promotions.d.ts +39 -30
  59. package/lib/cjs/resources/fixed_amount_promotions.js +4 -0
  60. package/lib/cjs/resources/fixed_price_promotions.d.ts +44 -35
  61. package/lib/cjs/resources/fixed_price_promotions.js +8 -4
  62. package/lib/cjs/resources/free_gift_promotions.d.ts +44 -35
  63. package/lib/cjs/resources/free_gift_promotions.js +8 -4
  64. package/lib/cjs/resources/free_shipping_promotions.d.ts +38 -26
  65. package/lib/cjs/resources/free_shipping_promotions.js +8 -0
  66. package/lib/cjs/resources/geocoders.d.ts +4 -3
  67. package/lib/cjs/resources/gift_card_recipients.d.ts +13 -12
  68. package/lib/cjs/resources/gift_cards.d.ts +50 -41
  69. package/lib/cjs/resources/gift_cards.js +4 -0
  70. package/lib/cjs/resources/google_geocoders.d.ts +6 -5
  71. package/lib/cjs/resources/imports.d.ts +22 -21
  72. package/lib/cjs/resources/in_stock_subscriptions.d.ts +20 -19
  73. package/lib/cjs/resources/inventory_models.d.ts +12 -11
  74. package/lib/cjs/resources/inventory_return_locations.d.ts +7 -6
  75. package/lib/cjs/resources/inventory_stock_locations.d.ts +10 -9
  76. package/lib/cjs/resources/klarna_gateways.d.ts +10 -9
  77. package/lib/cjs/resources/klarna_payments.d.ts +15 -14
  78. package/lib/cjs/resources/line_item_options.d.ts +32 -20
  79. package/lib/cjs/resources/line_item_options.js +8 -0
  80. package/lib/cjs/resources/line_items.d.ts +58 -43
  81. package/lib/cjs/resources/line_items.js +8 -0
  82. package/lib/cjs/resources/manual_gateways.d.ts +4 -3
  83. package/lib/cjs/resources/manual_tax_calculators.d.ts +8 -7
  84. package/lib/cjs/resources/markets.d.ts +41 -32
  85. package/lib/cjs/resources/markets.js +4 -0
  86. package/lib/cjs/resources/merchants.d.ts +6 -5
  87. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +9 -8
  88. package/lib/cjs/resources/order_copies.d.ts +23 -20
  89. package/lib/cjs/resources/order_copies.js +7 -4
  90. package/lib/cjs/resources/order_factories.d.ts +34 -0
  91. package/lib/cjs/resources/order_factories.js +28 -0
  92. package/lib/cjs/resources/order_subscription_items.d.ts +61 -0
  93. package/lib/cjs/resources/order_subscription_items.js +29 -0
  94. package/lib/cjs/resources/order_subscriptions.d.ts +52 -29
  95. package/lib/cjs/resources/order_subscriptions.js +18 -2
  96. package/lib/cjs/resources/order_validation_rules.d.ts +4 -3
  97. package/lib/cjs/resources/orders.d.ts +200 -183
  98. package/lib/cjs/resources/orders.js +12 -0
  99. package/lib/cjs/resources/organization.d.ts +18 -17
  100. package/lib/cjs/resources/packages.d.ts +14 -13
  101. package/lib/cjs/resources/parcel_line_items.d.ts +7 -6
  102. package/lib/cjs/resources/parcels.d.ts +78 -74
  103. package/lib/cjs/resources/payment_gateways.d.ts +3 -2
  104. package/lib/cjs/resources/payment_methods.d.ts +33 -32
  105. package/lib/cjs/resources/paypal_gateways.d.ts +7 -6
  106. package/lib/cjs/resources/paypal_payments.d.ts +17 -16
  107. package/lib/cjs/resources/percentage_discount_promotions.d.ts +43 -34
  108. package/lib/cjs/resources/percentage_discount_promotions.js +8 -4
  109. package/lib/cjs/resources/price_frequency_tiers.d.ts +50 -0
  110. package/lib/cjs/resources/price_frequency_tiers.js +37 -0
  111. package/lib/cjs/resources/price_lists.d.ts +9 -8
  112. package/lib/cjs/resources/price_tiers.d.ts +7 -6
  113. package/lib/cjs/resources/price_volume_tiers.d.ts +15 -11
  114. package/lib/cjs/resources/price_volume_tiers.js +4 -0
  115. package/lib/cjs/resources/prices.d.ts +20 -16
  116. package/lib/cjs/resources/prices.js +4 -0
  117. package/lib/cjs/resources/promotion_rules.d.ts +3 -2
  118. package/lib/cjs/resources/promotions.d.ts +17 -10
  119. package/lib/cjs/resources/promotions.js +8 -0
  120. package/lib/cjs/resources/recurring_order_copies.d.ts +53 -0
  121. package/lib/cjs/resources/recurring_order_copies.js +41 -0
  122. package/lib/cjs/resources/refunds.d.ts +10 -9
  123. package/lib/cjs/resources/return_line_items.d.ts +13 -12
  124. package/lib/cjs/resources/returns.d.ts +39 -30
  125. package/lib/cjs/resources/returns.js +4 -0
  126. package/lib/cjs/resources/satispay_gateways.d.ts +11 -7
  127. package/lib/cjs/resources/satispay_payments.d.ts +10 -12
  128. package/lib/cjs/resources/shipments.d.ts +42 -41
  129. package/lib/cjs/resources/shipping_categories.d.ts +5 -4
  130. package/lib/cjs/resources/shipping_method_tiers.d.ts +7 -6
  131. package/lib/cjs/resources/shipping_methods.d.ts +50 -49
  132. package/lib/cjs/resources/shipping_weight_tiers.d.ts +12 -11
  133. package/lib/cjs/resources/shipping_zones.d.ts +22 -21
  134. package/lib/cjs/resources/sku_list_items.d.ts +13 -12
  135. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +14 -13
  136. package/lib/cjs/resources/sku_lists.d.ts +22 -21
  137. package/lib/cjs/resources/sku_options.d.ts +36 -24
  138. package/lib/cjs/resources/sku_options.js +8 -0
  139. package/lib/cjs/resources/skus.d.ts +47 -35
  140. package/lib/cjs/resources/skus.js +8 -0
  141. package/lib/cjs/resources/stock_items.d.ts +12 -11
  142. package/lib/cjs/resources/stock_line_items.d.ts +7 -6
  143. package/lib/cjs/resources/stock_locations.d.ts +17 -16
  144. package/lib/cjs/resources/stock_transfers.d.ts +24 -23
  145. package/lib/cjs/resources/stripe_gateways.d.ts +12 -11
  146. package/lib/cjs/resources/stripe_payments.d.ts +15 -14
  147. package/lib/cjs/resources/subscription_models.d.ts +49 -0
  148. package/lib/cjs/resources/subscription_models.js +37 -0
  149. package/lib/cjs/resources/tags.d.ts +28 -0
  150. package/lib/cjs/resources/tags.js +25 -0
  151. package/lib/cjs/resources/tax_calculators.d.ts +4 -3
  152. package/lib/cjs/resources/tax_categories.d.ts +10 -9
  153. package/lib/cjs/resources/tax_rules.d.ts +39 -38
  154. package/lib/cjs/resources/taxjar_accounts.d.ts +9 -8
  155. package/lib/cjs/resources/transactions.d.ts +8 -7
  156. package/lib/cjs/resources/voids.d.ts +10 -9
  157. package/lib/cjs/resources/webhooks.d.ts +14 -13
  158. package/lib/cjs/resources/wire_transfers.d.ts +5 -4
  159. package/lib/cjs/util.d.ts +1 -3
  160. package/lib/esm/api.d.ts +23 -12
  161. package/lib/esm/api.js +12 -0
  162. package/lib/esm/client.d.ts +3 -5
  163. package/lib/esm/commercelayer.d.ts +10 -4
  164. package/lib/esm/commercelayer.js +9 -3
  165. package/lib/esm/common.d.ts +1 -0
  166. package/lib/esm/common.js +11 -0
  167. package/lib/esm/index.d.ts +1 -2
  168. package/lib/esm/index.js +0 -2
  169. package/lib/esm/interceptor.d.ts +1 -1
  170. package/lib/esm/model.d.ts +7 -1
  171. package/lib/esm/query.d.ts +5 -13
  172. package/lib/esm/resource.d.ts +8 -10
  173. package/lib/esm/resources/addresses.d.ts +63 -51
  174. package/lib/esm/resources/addresses.js +8 -0
  175. package/lib/esm/resources/adjustments.d.ts +5 -4
  176. package/lib/esm/resources/adyen_gateways.d.ts +21 -20
  177. package/lib/esm/resources/adyen_payments.d.ts +16 -15
  178. package/lib/esm/resources/application.d.ts +7 -6
  179. package/lib/esm/resources/attachments.d.ts +11 -10
  180. package/lib/esm/resources/authorizations.d.ts +28 -27
  181. package/lib/esm/resources/avalara_accounts.d.ts +17 -16
  182. package/lib/esm/resources/axerve_gateways.d.ts +9 -8
  183. package/lib/esm/resources/axerve_payments.d.ts +12 -11
  184. package/lib/esm/resources/billing_info_validation_rules.d.ts +5 -4
  185. package/lib/esm/resources/bing_geocoders.d.ts +6 -5
  186. package/lib/esm/resources/braintree_gateways.d.ts +21 -20
  187. package/lib/esm/resources/braintree_payments.d.ts +17 -16
  188. package/lib/esm/resources/bundles.d.ts +38 -26
  189. package/lib/esm/resources/bundles.js +8 -0
  190. package/lib/esm/resources/captures.d.ts +19 -18
  191. package/lib/esm/resources/carrier_accounts.d.ts +7 -6
  192. package/lib/esm/resources/checkout_com_gateways.d.ts +12 -11
  193. package/lib/esm/resources/checkout_com_payments.d.ts +25 -24
  194. package/lib/esm/resources/cleanups.d.ts +13 -12
  195. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -6
  196. package/lib/esm/resources/coupon_recipients.d.ts +13 -12
  197. package/lib/esm/resources/coupons.d.ts +27 -15
  198. package/lib/esm/resources/coupons.js +8 -0
  199. package/lib/esm/resources/customer_addresses.d.ts +8 -7
  200. package/lib/esm/resources/customer_groups.d.ts +6 -5
  201. package/lib/esm/resources/customer_password_resets.d.ts +8 -7
  202. package/lib/esm/resources/customer_payment_sources.d.ts +9 -8
  203. package/lib/esm/resources/customer_subscriptions.d.ts +4 -3
  204. package/lib/esm/resources/customers.d.ts +27 -18
  205. package/lib/esm/resources/customers.js +4 -0
  206. package/lib/esm/resources/delivery_lead_times.d.ts +11 -10
  207. package/lib/esm/resources/event_callbacks.d.ts +6 -5
  208. package/lib/esm/resources/events.d.ts +4 -3
  209. package/lib/esm/resources/exports.d.ts +17 -16
  210. package/lib/esm/resources/external_gateways.d.ts +20 -19
  211. package/lib/esm/resources/external_payments.d.ts +10 -9
  212. package/lib/esm/resources/external_promotions.d.ts +37 -28
  213. package/lib/esm/resources/external_promotions.js +4 -0
  214. package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
  215. package/lib/esm/resources/fixed_amount_promotions.d.ts +39 -30
  216. package/lib/esm/resources/fixed_amount_promotions.js +4 -0
  217. package/lib/esm/resources/fixed_price_promotions.d.ts +44 -35
  218. package/lib/esm/resources/fixed_price_promotions.js +8 -4
  219. package/lib/esm/resources/free_gift_promotions.d.ts +44 -35
  220. package/lib/esm/resources/free_gift_promotions.js +8 -4
  221. package/lib/esm/resources/free_shipping_promotions.d.ts +38 -26
  222. package/lib/esm/resources/free_shipping_promotions.js +8 -0
  223. package/lib/esm/resources/geocoders.d.ts +4 -3
  224. package/lib/esm/resources/gift_card_recipients.d.ts +13 -12
  225. package/lib/esm/resources/gift_cards.d.ts +50 -41
  226. package/lib/esm/resources/gift_cards.js +4 -0
  227. package/lib/esm/resources/google_geocoders.d.ts +6 -5
  228. package/lib/esm/resources/imports.d.ts +22 -21
  229. package/lib/esm/resources/in_stock_subscriptions.d.ts +20 -19
  230. package/lib/esm/resources/inventory_models.d.ts +12 -11
  231. package/lib/esm/resources/inventory_return_locations.d.ts +7 -6
  232. package/lib/esm/resources/inventory_stock_locations.d.ts +10 -9
  233. package/lib/esm/resources/klarna_gateways.d.ts +10 -9
  234. package/lib/esm/resources/klarna_payments.d.ts +15 -14
  235. package/lib/esm/resources/line_item_options.d.ts +32 -20
  236. package/lib/esm/resources/line_item_options.js +8 -0
  237. package/lib/esm/resources/line_items.d.ts +58 -43
  238. package/lib/esm/resources/line_items.js +8 -0
  239. package/lib/esm/resources/manual_gateways.d.ts +4 -3
  240. package/lib/esm/resources/manual_tax_calculators.d.ts +8 -7
  241. package/lib/esm/resources/markets.d.ts +41 -32
  242. package/lib/esm/resources/markets.js +4 -0
  243. package/lib/esm/resources/merchants.d.ts +6 -5
  244. package/lib/esm/resources/order_amount_promotion_rules.d.ts +9 -8
  245. package/lib/esm/resources/order_copies.d.ts +23 -20
  246. package/lib/esm/resources/order_copies.js +7 -4
  247. package/lib/esm/resources/order_factories.d.ts +34 -0
  248. package/lib/esm/resources/order_factories.js +26 -0
  249. package/lib/esm/resources/order_subscription_items.d.ts +61 -0
  250. package/lib/esm/resources/order_subscription_items.js +27 -0
  251. package/lib/esm/resources/order_subscriptions.d.ts +52 -29
  252. package/lib/esm/resources/order_subscriptions.js +18 -2
  253. package/lib/esm/resources/order_validation_rules.d.ts +4 -3
  254. package/lib/esm/resources/orders.d.ts +200 -183
  255. package/lib/esm/resources/orders.js +12 -0
  256. package/lib/esm/resources/organization.d.ts +18 -17
  257. package/lib/esm/resources/packages.d.ts +14 -13
  258. package/lib/esm/resources/parcel_line_items.d.ts +7 -6
  259. package/lib/esm/resources/parcels.d.ts +78 -74
  260. package/lib/esm/resources/payment_gateways.d.ts +3 -2
  261. package/lib/esm/resources/payment_methods.d.ts +33 -32
  262. package/lib/esm/resources/paypal_gateways.d.ts +7 -6
  263. package/lib/esm/resources/paypal_payments.d.ts +17 -16
  264. package/lib/esm/resources/percentage_discount_promotions.d.ts +43 -34
  265. package/lib/esm/resources/percentage_discount_promotions.js +8 -4
  266. package/lib/esm/resources/price_frequency_tiers.d.ts +50 -0
  267. package/lib/esm/resources/price_frequency_tiers.js +35 -0
  268. package/lib/esm/resources/price_lists.d.ts +9 -8
  269. package/lib/esm/resources/price_tiers.d.ts +7 -6
  270. package/lib/esm/resources/price_volume_tiers.d.ts +15 -11
  271. package/lib/esm/resources/price_volume_tiers.js +4 -0
  272. package/lib/esm/resources/prices.d.ts +20 -16
  273. package/lib/esm/resources/prices.js +4 -0
  274. package/lib/esm/resources/promotion_rules.d.ts +3 -2
  275. package/lib/esm/resources/promotions.d.ts +17 -10
  276. package/lib/esm/resources/promotions.js +8 -0
  277. package/lib/esm/resources/recurring_order_copies.d.ts +53 -0
  278. package/lib/esm/resources/recurring_order_copies.js +39 -0
  279. package/lib/esm/resources/refunds.d.ts +10 -9
  280. package/lib/esm/resources/return_line_items.d.ts +13 -12
  281. package/lib/esm/resources/returns.d.ts +39 -30
  282. package/lib/esm/resources/returns.js +4 -0
  283. package/lib/esm/resources/satispay_gateways.d.ts +11 -7
  284. package/lib/esm/resources/satispay_payments.d.ts +10 -12
  285. package/lib/esm/resources/shipments.d.ts +42 -41
  286. package/lib/esm/resources/shipping_categories.d.ts +5 -4
  287. package/lib/esm/resources/shipping_method_tiers.d.ts +7 -6
  288. package/lib/esm/resources/shipping_methods.d.ts +50 -49
  289. package/lib/esm/resources/shipping_weight_tiers.d.ts +12 -11
  290. package/lib/esm/resources/shipping_zones.d.ts +22 -21
  291. package/lib/esm/resources/sku_list_items.d.ts +13 -12
  292. package/lib/esm/resources/sku_list_promotion_rules.d.ts +14 -13
  293. package/lib/esm/resources/sku_lists.d.ts +22 -21
  294. package/lib/esm/resources/sku_options.d.ts +36 -24
  295. package/lib/esm/resources/sku_options.js +8 -0
  296. package/lib/esm/resources/skus.d.ts +47 -35
  297. package/lib/esm/resources/skus.js +8 -0
  298. package/lib/esm/resources/stock_items.d.ts +12 -11
  299. package/lib/esm/resources/stock_line_items.d.ts +7 -6
  300. package/lib/esm/resources/stock_locations.d.ts +17 -16
  301. package/lib/esm/resources/stock_transfers.d.ts +24 -23
  302. package/lib/esm/resources/stripe_gateways.d.ts +12 -11
  303. package/lib/esm/resources/stripe_payments.d.ts +15 -14
  304. package/lib/esm/resources/subscription_models.d.ts +49 -0
  305. package/lib/esm/resources/subscription_models.js +35 -0
  306. package/lib/esm/resources/tags.d.ts +28 -0
  307. package/lib/esm/resources/tags.js +23 -0
  308. package/lib/esm/resources/tax_calculators.d.ts +4 -3
  309. package/lib/esm/resources/tax_categories.d.ts +10 -9
  310. package/lib/esm/resources/tax_rules.d.ts +39 -38
  311. package/lib/esm/resources/taxjar_accounts.d.ts +9 -8
  312. package/lib/esm/resources/transactions.d.ts +8 -7
  313. package/lib/esm/resources/voids.d.ts +10 -9
  314. package/lib/esm/resources/webhooks.d.ts +14 -13
  315. package/lib/esm/resources/wire_transfers.d.ts +5 -4
  316. package/lib/esm/util.d.ts +1 -3
  317. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  318. package/lib/tsconfig.tsbuildinfo +1 -1
  319. package/package.json +12 -12
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Order } from './orders';
4
5
  import type { ShippingCategory } from './shipping_categories';
@@ -21,52 +22,52 @@ type ShippingMethodRel = ResourceRel & {
21
22
  };
22
23
  interface Shipment extends Resource {
23
24
  readonly type: ShipmentType;
24
- number?: string;
25
- status?: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
26
- currency_code?: string;
27
- cost_amount_cents?: number;
28
- cost_amount_float?: number;
29
- formatted_cost_amount?: string;
30
- skus_count?: number;
31
- selected_rate_id?: string;
32
- rates?: object[];
33
- purchase_error_code?: string;
34
- purchase_error_message?: string;
35
- get_rates_errors?: object[];
36
- get_rates_started_at?: string;
37
- get_rates_completed_at?: string;
38
- purchase_started_at?: string;
39
- purchase_completed_at?: string;
40
- purchase_failed_at?: string;
41
- order?: Order;
42
- shipping_category?: ShippingCategory;
43
- stock_location?: StockLocation;
44
- origin_address?: Address;
45
- shipping_address?: Address;
46
- shipping_method?: ShippingMethod;
47
- delivery_lead_time?: DeliveryLeadTime;
25
+ number?: string | null;
26
+ status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
27
+ currency_code?: string | null;
28
+ cost_amount_cents?: number | null;
29
+ cost_amount_float?: number | null;
30
+ formatted_cost_amount?: string | null;
31
+ skus_count?: number | null;
32
+ selected_rate_id?: string | null;
33
+ rates?: Array<Record<string, any>> | null;
34
+ purchase_error_code?: string | null;
35
+ purchase_error_message?: string | null;
36
+ get_rates_errors?: Array<Record<string, any>> | null;
37
+ get_rates_started_at?: string | null;
38
+ get_rates_completed_at?: string | null;
39
+ purchase_started_at?: string | null;
40
+ purchase_completed_at?: string | null;
41
+ purchase_failed_at?: string | null;
42
+ order?: Order | null;
43
+ shipping_category?: ShippingCategory | null;
44
+ stock_location?: StockLocation | null;
45
+ origin_address?: Address | null;
46
+ shipping_address?: Address | null;
47
+ shipping_method?: ShippingMethod | null;
48
+ delivery_lead_time?: DeliveryLeadTime | null;
48
49
  /**
49
50
  * @deprecated This field should not be used as it may be removed in the future without notice
50
51
  */
51
52
  shipment_line_items?: object[];
52
- stock_line_items?: StockLineItem[];
53
- stock_transfers?: StockTransfer[];
54
- available_shipping_methods?: ShippingMethod[];
55
- carrier_accounts?: CarrierAccount[];
56
- parcels?: Parcel[];
57
- attachments?: Attachment[];
58
- events?: Event[];
53
+ stock_line_items?: StockLineItem[] | null;
54
+ stock_transfers?: StockTransfer[] | null;
55
+ available_shipping_methods?: ShippingMethod[] | null;
56
+ carrier_accounts?: CarrierAccount[] | null;
57
+ parcels?: Parcel[] | null;
58
+ attachments?: Attachment[] | null;
59
+ events?: Event[] | null;
59
60
  }
60
61
  interface ShipmentUpdate extends ResourceUpdate {
61
- _on_hold?: boolean;
62
- _picking?: boolean;
63
- _packing?: boolean;
64
- _ready_to_ship?: boolean;
65
- _ship?: boolean;
66
- _get_rates?: boolean;
67
- selected_rate_id?: string;
68
- _purchase?: boolean;
69
- shipping_method?: ShippingMethodRel;
62
+ _on_hold?: boolean | null;
63
+ _picking?: boolean | null;
64
+ _packing?: boolean | null;
65
+ _ready_to_ship?: boolean | null;
66
+ _ship?: boolean | null;
67
+ _get_rates?: boolean | null;
68
+ selected_rate_id?: string | null;
69
+ _purchase?: boolean | null;
70
+ shipping_method?: ShippingMethodRel | null;
70
71
  }
71
72
  declare class Shipments extends ApiResource<Shipment> {
72
73
  static readonly TYPE: ShipmentType;
@@ -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 { Sku } from './skus';
4
5
  import type { Attachment } from './attachments';
@@ -9,14 +10,14 @@ type ShippingCategoryRel = ResourceRel & {
9
10
  interface ShippingCategory extends Resource {
10
11
  readonly type: ShippingCategoryType;
11
12
  name: string;
12
- skus?: Sku[];
13
- attachments?: Attachment[];
13
+ skus?: Sku[] | null;
14
+ attachments?: Attachment[] | null;
14
15
  }
15
16
  interface ShippingCategoryCreate extends ResourceCreate {
16
17
  name: string;
17
18
  }
18
19
  interface ShippingCategoryUpdate extends ResourceUpdate {
19
- name: string;
20
+ name?: string | null;
20
21
  }
21
22
  declare class ShippingCategories extends ApiResource<ShippingCategory> {
22
23
  static readonly TYPE: ShippingCategoryType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { ShippingMethod } from './shipping_methods';
4
5
  import type { Attachment } from './attachments';
@@ -9,12 +10,12 @@ type ShippingMethodTierRel = ResourceRel & {
9
10
  interface ShippingMethodTier extends Resource {
10
11
  readonly type: ShippingMethodTierType;
11
12
  name: string;
12
- up_to?: number;
13
+ up_to?: number | null;
13
14
  price_amount_cents: number;
14
- price_amount_float?: number;
15
- formatted_price_amount?: string;
16
- shipping_method?: ShippingMethod;
17
- attachments?: Attachment[];
15
+ price_amount_float?: number | null;
16
+ formatted_price_amount?: string | null;
17
+ shipping_method?: ShippingMethod | null;
18
+ attachments?: Attachment[] | null;
18
19
  }
19
20
  declare class ShippingMethodTiers extends ApiResource<ShippingMethodTier> {
20
21
  static readonly TYPE: ShippingMethodTierType;
@@ -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 { ShippingZone, ShippingZoneType } from './shipping_zones';
@@ -30,61 +31,61 @@ type ShippingMethodTierRel = ResourceRel & {
30
31
  interface ShippingMethod extends Resource {
31
32
  readonly type: ShippingMethodType;
32
33
  name: string;
33
- scheme?: string;
34
- currency_code?: string;
35
- disabled_at?: string;
34
+ scheme?: string | null;
35
+ currency_code?: string | null;
36
+ disabled_at?: string | null;
36
37
  price_amount_cents: number;
37
- price_amount_float?: number;
38
- formatted_price_amount?: string;
39
- free_over_amount_cents?: number;
40
- free_over_amount_float?: number;
41
- formatted_free_over_amount?: string;
42
- price_amount_for_shipment_cents?: number;
43
- price_amount_for_shipment_float?: number;
44
- formatted_price_amount_for_shipment?: string;
45
- min_weight?: number;
46
- max_weight?: number;
47
- unit_of_weight?: string;
48
- market?: Market;
49
- shipping_zone?: ShippingZone;
50
- shipping_category?: ShippingCategory;
51
- stock_location?: StockLocation;
52
- delivery_lead_time_for_shipment?: DeliveryLeadTime;
53
- shipping_method_tiers?: ShippingMethodTier[];
54
- shipping_weight_tiers?: ShippingWeightTier[];
55
- attachments?: Attachment[];
38
+ price_amount_float?: number | null;
39
+ formatted_price_amount?: string | null;
40
+ free_over_amount_cents?: number | null;
41
+ free_over_amount_float?: number | null;
42
+ formatted_free_over_amount?: string | null;
43
+ price_amount_for_shipment_cents?: number | null;
44
+ price_amount_for_shipment_float?: number | null;
45
+ formatted_price_amount_for_shipment?: string | null;
46
+ min_weight?: number | null;
47
+ max_weight?: number | null;
48
+ unit_of_weight?: string | null;
49
+ market?: Market | null;
50
+ shipping_zone?: ShippingZone | null;
51
+ shipping_category?: ShippingCategory | null;
52
+ stock_location?: StockLocation | null;
53
+ delivery_lead_time_for_shipment?: DeliveryLeadTime | null;
54
+ shipping_method_tiers?: ShippingMethodTier[] | null;
55
+ shipping_weight_tiers?: ShippingWeightTier[] | null;
56
+ attachments?: Attachment[] | null;
56
57
  }
57
58
  interface ShippingMethodCreate extends ResourceCreate {
58
59
  name: string;
59
- scheme?: string;
60
- currency_code?: string;
60
+ scheme?: string | null;
61
+ currency_code?: string | null;
61
62
  price_amount_cents: number;
62
- free_over_amount_cents?: number;
63
- min_weight?: number;
64
- max_weight?: number;
65
- unit_of_weight?: string;
66
- market?: MarketRel;
67
- shipping_zone?: ShippingZoneRel;
68
- shipping_category?: ShippingCategoryRel;
69
- stock_location?: StockLocationRel;
70
- shipping_method_tiers?: ShippingMethodTierRel[];
63
+ free_over_amount_cents?: number | null;
64
+ min_weight?: number | null;
65
+ max_weight?: number | null;
66
+ unit_of_weight?: string | null;
67
+ market?: MarketRel | null;
68
+ shipping_zone?: ShippingZoneRel | null;
69
+ shipping_category?: ShippingCategoryRel | null;
70
+ stock_location?: StockLocationRel | null;
71
+ shipping_method_tiers?: ShippingMethodTierRel[] | null;
71
72
  }
72
73
  interface ShippingMethodUpdate extends ResourceUpdate {
73
- name: string;
74
- scheme?: string;
75
- currency_code?: string;
76
- _disable?: boolean;
77
- _enable?: boolean;
78
- price_amount_cents: number;
79
- free_over_amount_cents?: number;
80
- min_weight?: number;
81
- max_weight?: number;
82
- unit_of_weight?: string;
83
- market?: MarketRel;
84
- shipping_zone?: ShippingZoneRel;
85
- shipping_category?: ShippingCategoryRel;
86
- stock_location?: StockLocationRel;
87
- shipping_method_tiers?: ShippingMethodTierRel[];
74
+ name?: string | null;
75
+ scheme?: string | null;
76
+ currency_code?: string | null;
77
+ _disable?: boolean | null;
78
+ _enable?: boolean | null;
79
+ price_amount_cents?: number | null;
80
+ free_over_amount_cents?: number | null;
81
+ min_weight?: number | null;
82
+ max_weight?: number | null;
83
+ unit_of_weight?: string | null;
84
+ market?: MarketRel | null;
85
+ shipping_zone?: ShippingZoneRel | null;
86
+ shipping_category?: ShippingCategoryRel | null;
87
+ stock_location?: StockLocationRel | null;
88
+ shipping_method_tiers?: ShippingMethodTierRel[] | null;
88
89
  }
89
90
  declare class ShippingMethods extends ApiResource<ShippingMethod> {
90
91
  static readonly TYPE: ShippingMethodType;
@@ -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 { ShippingMethod, ShippingMethodType } from './shipping_methods';
4
5
  import type { Attachment } from './attachments';
@@ -12,24 +13,24 @@ type ShippingMethodRel = ResourceRel & {
12
13
  interface ShippingWeightTier extends Resource {
13
14
  readonly type: ShippingWeightTierType;
14
15
  name: string;
15
- up_to?: number;
16
+ up_to?: number | null;
16
17
  price_amount_cents: number;
17
- price_amount_float?: number;
18
- formatted_price_amount?: string;
19
- shipping_method?: ShippingMethod;
20
- attachments?: Attachment[];
18
+ price_amount_float?: number | null;
19
+ formatted_price_amount?: string | null;
20
+ shipping_method?: ShippingMethod | null;
21
+ attachments?: Attachment[] | null;
21
22
  }
22
23
  interface ShippingWeightTierCreate extends ResourceCreate {
23
24
  name: string;
24
- up_to?: number;
25
+ up_to?: number | null;
25
26
  price_amount_cents: number;
26
27
  shipping_method: ShippingMethodRel;
27
28
  }
28
29
  interface ShippingWeightTierUpdate extends ResourceUpdate {
29
- name: string;
30
- up_to?: number;
31
- price_amount_cents: number;
32
- shipping_method?: ShippingMethodRel;
30
+ name?: string | null;
31
+ up_to?: number | null;
32
+ price_amount_cents?: number | null;
33
+ shipping_method?: ShippingMethodRel | null;
33
34
  }
34
35
  declare class ShippingWeightTiers extends ApiResource<ShippingWeightTier> {
35
36
  static readonly TYPE: ShippingWeightTierType;
@@ -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 { Attachment } from './attachments';
4
5
  type ShippingZoneType = 'shipping_zones';
@@ -8,31 +9,31 @@ type ShippingZoneRel = ResourceRel & {
8
9
  interface ShippingZone extends Resource {
9
10
  readonly type: ShippingZoneType;
10
11
  name: string;
11
- country_code_regex?: string;
12
- not_country_code_regex?: string;
13
- state_code_regex?: string;
14
- not_state_code_regex?: string;
15
- zip_code_regex?: string;
16
- not_zip_code_regex?: string;
17
- attachments?: Attachment[];
12
+ country_code_regex?: string | null;
13
+ not_country_code_regex?: string | null;
14
+ state_code_regex?: string | null;
15
+ not_state_code_regex?: string | null;
16
+ zip_code_regex?: string | null;
17
+ not_zip_code_regex?: string | null;
18
+ attachments?: Attachment[] | null;
18
19
  }
19
20
  interface ShippingZoneCreate extends ResourceCreate {
20
21
  name: string;
21
- country_code_regex?: string;
22
- not_country_code_regex?: string;
23
- state_code_regex?: string;
24
- not_state_code_regex?: string;
25
- zip_code_regex?: string;
26
- not_zip_code_regex?: string;
22
+ country_code_regex?: string | null;
23
+ not_country_code_regex?: string | null;
24
+ state_code_regex?: string | null;
25
+ not_state_code_regex?: string | null;
26
+ zip_code_regex?: string | null;
27
+ not_zip_code_regex?: string | null;
27
28
  }
28
29
  interface ShippingZoneUpdate extends ResourceUpdate {
29
- name: string;
30
- country_code_regex?: string;
31
- not_country_code_regex?: string;
32
- state_code_regex?: string;
33
- not_state_code_regex?: string;
34
- zip_code_regex?: string;
35
- not_zip_code_regex?: string;
30
+ name?: string | null;
31
+ country_code_regex?: string | null;
32
+ not_country_code_regex?: string | null;
33
+ state_code_regex?: string | null;
34
+ not_state_code_regex?: string | null;
35
+ zip_code_regex?: string | null;
36
+ not_zip_code_regex?: string | null;
36
37
  }
37
38
  declare class ShippingZones extends ApiResource<ShippingZone> {
38
39
  static readonly TYPE: ShippingZoneType;
@@ -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 { SkuList, SkuListType } from './sku_lists';
4
5
  import type { Sku, SkuType } from './skus';
@@ -14,23 +15,23 @@ type SkuRel = ResourceRel & {
14
15
  };
15
16
  interface SkuListItem extends Resource {
16
17
  readonly type: SkuListItemType;
17
- position?: number;
18
- sku_code?: string;
19
- quantity?: number;
20
- sku_list?: SkuList;
21
- sku?: Sku;
18
+ position?: number | null;
19
+ sku_code?: string | null;
20
+ quantity?: number | null;
21
+ sku_list?: SkuList | null;
22
+ sku?: Sku | null;
22
23
  }
23
24
  interface SkuListItemCreate extends ResourceCreate {
24
- position?: number;
25
- sku_code?: string;
26
- quantity?: number;
25
+ position?: number | null;
26
+ sku_code?: string | null;
27
+ quantity?: number | null;
27
28
  sku_list: SkuListRel;
28
29
  sku: SkuRel;
29
30
  }
30
31
  interface SkuListItemUpdate extends ResourceUpdate {
31
- position?: number;
32
- sku_code?: string;
33
- quantity?: number;
32
+ position?: number | null;
33
+ sku_code?: string | null;
34
+ quantity?: number | null;
34
35
  }
35
36
  declare class SkuListItems extends ApiResource<SkuListItem> {
36
37
  static readonly TYPE: SkuListItemType;
@@ -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 { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
4
5
  import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
@@ -35,23 +36,23 @@ type SkuListRel = ResourceRel & {
35
36
  };
36
37
  interface SkuListPromotionRule extends Resource {
37
38
  readonly type: SkuListPromotionRuleType;
38
- all_skus?: boolean;
39
- min_quantity?: number;
40
- promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
41
- sku_list?: SkuList;
42
- skus?: Sku[];
39
+ all_skus?: boolean | null;
40
+ min_quantity?: number | null;
41
+ promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
42
+ sku_list?: SkuList | null;
43
+ skus?: Sku[] | null;
43
44
  }
44
45
  interface SkuListPromotionRuleCreate extends ResourceCreate {
45
- all_skus?: boolean;
46
- min_quantity?: number;
46
+ all_skus?: boolean | null;
47
+ min_quantity?: number | null;
47
48
  promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
48
- sku_list?: SkuListRel;
49
+ sku_list?: SkuListRel | null;
49
50
  }
50
51
  interface SkuListPromotionRuleUpdate extends ResourceUpdate {
51
- all_skus?: boolean;
52
- min_quantity?: number;
53
- promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
54
- sku_list?: SkuListRel;
52
+ all_skus?: boolean | null;
53
+ min_quantity?: number | null;
54
+ promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
55
+ sku_list?: SkuListRel | null;
55
56
  }
56
57
  declare class SkuListPromotionRules extends ApiResource<SkuListPromotionRule> {
57
58
  static readonly TYPE: SkuListPromotionRuleType;
@@ -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 { Customer, CustomerType } from './customers';
4
5
  import type { Sku } from './skus';
@@ -16,31 +17,31 @@ interface SkuList extends Resource {
16
17
  readonly type: SkuListType;
17
18
  name: string;
18
19
  slug: string;
19
- description?: string;
20
- image_url?: string;
21
- manual?: boolean;
22
- sku_code_regex?: string;
23
- customer?: Customer;
24
- skus?: Sku[];
25
- sku_list_items?: SkuListItem[];
26
- bundles?: Bundle[];
27
- attachments?: Attachment[];
20
+ description?: string | null;
21
+ image_url?: string | null;
22
+ manual?: boolean | null;
23
+ sku_code_regex?: string | null;
24
+ customer?: Customer | null;
25
+ skus?: Sku[] | null;
26
+ sku_list_items?: SkuListItem[] | null;
27
+ bundles?: Bundle[] | null;
28
+ attachments?: Attachment[] | null;
28
29
  }
29
30
  interface SkuListCreate extends ResourceCreate {
30
31
  name: string;
31
- description?: string;
32
- image_url?: string;
33
- manual?: boolean;
34
- sku_code_regex?: string;
35
- customer?: CustomerRel;
32
+ description?: string | null;
33
+ image_url?: string | null;
34
+ manual?: boolean | null;
35
+ sku_code_regex?: string | null;
36
+ customer?: CustomerRel | null;
36
37
  }
37
38
  interface SkuListUpdate extends ResourceUpdate {
38
- name: string;
39
- description?: string;
40
- image_url?: string;
41
- manual?: boolean;
42
- sku_code_regex?: string;
43
- customer?: CustomerRel;
39
+ name?: string | null;
40
+ description?: string | null;
41
+ image_url?: string | null;
42
+ manual?: boolean | null;
43
+ sku_code_regex?: string | null;
44
+ customer?: CustomerRel | null;
44
45
  }
45
46
  declare class SkuLists extends ApiResource<SkuList> {
46
47
  static readonly TYPE: SkuListType;
@@ -1,7 +1,10 @@
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 { Attachment } from './attachments';
6
+ import type { Event } from './events';
7
+ import type { Tag, TagType } from './tags';
5
8
  type SkuOptionType = 'sku_options';
6
9
  type SkuOptionRel = ResourceRel & {
7
10
  type: SkuOptionType;
@@ -9,37 +12,44 @@ type SkuOptionRel = ResourceRel & {
9
12
  type MarketRel = ResourceRel & {
10
13
  type: MarketType;
11
14
  };
15
+ type TagRel = ResourceRel & {
16
+ type: TagType;
17
+ };
12
18
  interface SkuOption extends Resource {
13
19
  readonly type: SkuOptionType;
14
20
  name: string;
15
- currency_code?: string;
16
- description?: string;
17
- price_amount_cents?: number;
18
- price_amount_float?: number;
19
- formatted_price_amount?: string;
20
- delay_hours?: number;
21
- delay_days?: number;
22
- sku_code_regex?: string;
23
- market?: Market;
24
- attachments?: Attachment[];
21
+ currency_code?: string | null;
22
+ description?: string | null;
23
+ price_amount_cents?: number | null;
24
+ price_amount_float?: number | null;
25
+ formatted_price_amount?: string | null;
26
+ delay_hours?: number | null;
27
+ delay_days?: number | null;
28
+ sku_code_regex?: string | null;
29
+ market?: Market | null;
30
+ attachments?: Attachment[] | null;
31
+ events?: Event[] | null;
32
+ tags?: Tag[] | null;
25
33
  }
26
34
  interface SkuOptionCreate extends ResourceCreate {
27
35
  name: string;
28
- currency_code?: string;
29
- description?: string;
30
- price_amount_cents?: number;
31
- delay_hours?: number;
32
- sku_code_regex?: string;
33
- market?: MarketRel;
36
+ currency_code?: string | null;
37
+ description?: string | null;
38
+ price_amount_cents?: number | null;
39
+ delay_hours?: number | null;
40
+ sku_code_regex?: string | null;
41
+ market?: MarketRel | null;
42
+ tags?: TagRel[] | null;
34
43
  }
35
44
  interface SkuOptionUpdate extends ResourceUpdate {
36
- name: string;
37
- currency_code?: string;
38
- description?: string;
39
- price_amount_cents?: number;
40
- delay_hours?: number;
41
- sku_code_regex?: string;
42
- market?: MarketRel;
45
+ name?: string | null;
46
+ currency_code?: string | null;
47
+ description?: string | null;
48
+ price_amount_cents?: number | null;
49
+ delay_hours?: number | null;
50
+ sku_code_regex?: string | null;
51
+ market?: MarketRel | null;
52
+ tags?: TagRel[] | null;
43
53
  }
44
54
  declare class SkuOptions extends ApiResource<SkuOption> {
45
55
  static readonly TYPE: SkuOptionType;
@@ -48,6 +58,8 @@ declare class SkuOptions extends ApiResource<SkuOption> {
48
58
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
49
59
  market(skuOptionId: string | SkuOption, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
50
60
  attachments(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
61
+ events(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
62
+ tags(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
51
63
  isSkuOption(resource: any): resource is SkuOption;
52
64
  relationship(id: string | ResourceId | null): SkuOptionRel;
53
65
  type(): SkuOptionType;
@@ -17,6 +17,14 @@ class SkuOptions extends ApiResource {
17
17
  const _skuOptionId = skuOptionId.id || skuOptionId;
18
18
  return this.resources.fetch({ type: 'attachments' }, `sku_options/${_skuOptionId}/attachments`, params, options);
19
19
  }
20
+ async events(skuOptionId, params, options) {
21
+ const _skuOptionId = skuOptionId.id || skuOptionId;
22
+ return this.resources.fetch({ type: 'events' }, `sku_options/${_skuOptionId}/events`, params, options);
23
+ }
24
+ async tags(skuOptionId, params, options) {
25
+ const _skuOptionId = skuOptionId.id || skuOptionId;
26
+ return this.resources.fetch({ type: 'tags' }, `sku_options/${_skuOptionId}/tags`, params, options);
27
+ }
20
28
  isSkuOption(resource) {
21
29
  return resource.type && (resource.type === SkuOptions.TYPE);
22
30
  }