@commercelayer/sdk 4.27.1 → 4.29.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 (505) hide show
  1. package/lib/cjs/api.d.ts +23 -2
  2. package/lib/cjs/api.js +4 -14
  3. package/lib/cjs/client.d.ts +3 -5
  4. package/lib/cjs/client.js +11 -8
  5. package/lib/cjs/commercelayer.d.ts +6 -5
  6. package/lib/cjs/commercelayer.js +4 -3
  7. package/lib/cjs/common.d.ts +1 -0
  8. package/lib/cjs/common.js +11 -2
  9. package/lib/cjs/config.d.ts +1 -0
  10. package/lib/cjs/config.js +1 -0
  11. package/lib/cjs/debug.js +0 -4
  12. package/lib/cjs/error.js +1 -4
  13. package/lib/cjs/index.d.ts +1 -1
  14. package/lib/cjs/index.js +0 -16
  15. package/lib/cjs/interceptor.d.ts +6 -2
  16. package/lib/cjs/jsonapi.js +5 -1
  17. package/lib/cjs/model.d.ts +1 -0
  18. package/lib/cjs/query.d.ts +9 -15
  19. package/lib/cjs/query.js +3 -2
  20. package/lib/cjs/resource.d.ts +33 -25
  21. package/lib/cjs/resource.js +34 -9
  22. package/lib/cjs/resources/addresses.d.ts +78 -66
  23. package/lib/cjs/resources/addresses.js +11 -11
  24. package/lib/cjs/resources/adjustments.d.ts +19 -18
  25. package/lib/cjs/resources/adjustments.js +3 -11
  26. package/lib/cjs/resources/adyen_gateways.d.ts +34 -33
  27. package/lib/cjs/resources/adyen_gateways.js +3 -11
  28. package/lib/cjs/resources/adyen_payments.d.ts +27 -26
  29. package/lib/cjs/resources/adyen_payments.js +3 -11
  30. package/lib/cjs/resources/application.d.ts +14 -13
  31. package/lib/cjs/resources/application.js +1 -6
  32. package/lib/cjs/resources/attachments.d.ts +81 -80
  33. package/lib/cjs/resources/attachments.js +3 -11
  34. package/lib/cjs/resources/authorizations.d.ts +42 -41
  35. package/lib/cjs/resources/authorizations.js +1 -9
  36. package/lib/cjs/resources/avalara_accounts.d.ts +31 -30
  37. package/lib/cjs/resources/avalara_accounts.js +3 -11
  38. package/lib/cjs/resources/axerve_gateways.d.ts +22 -21
  39. package/lib/cjs/resources/axerve_gateways.js +3 -11
  40. package/lib/cjs/resources/axerve_payments.d.ts +26 -25
  41. package/lib/cjs/resources/axerve_payments.js +3 -11
  42. package/lib/cjs/resources/billing_info_validation_rules.d.ts +16 -15
  43. package/lib/cjs/resources/billing_info_validation_rules.js +3 -11
  44. package/lib/cjs/resources/bing_geocoders.d.ts +16 -15
  45. package/lib/cjs/resources/bing_geocoders.js +3 -11
  46. package/lib/cjs/resources/braintree_gateways.d.ts +33 -32
  47. package/lib/cjs/resources/braintree_gateways.js +3 -11
  48. package/lib/cjs/resources/braintree_payments.d.ts +29 -28
  49. package/lib/cjs/resources/braintree_payments.js +3 -11
  50. package/lib/cjs/resources/bundles.d.ts +59 -47
  51. package/lib/cjs/resources/bundles.js +11 -11
  52. package/lib/cjs/resources/captures.d.ts +33 -32
  53. package/lib/cjs/resources/captures.js +1 -9
  54. package/lib/cjs/resources/carrier_accounts.d.ts +15 -14
  55. package/lib/cjs/resources/carrier_accounts.js +0 -8
  56. package/lib/cjs/resources/checkout_com_gateways.d.ts +24 -23
  57. package/lib/cjs/resources/checkout_com_gateways.js +3 -11
  58. package/lib/cjs/resources/checkout_com_payments.d.ts +38 -37
  59. package/lib/cjs/resources/checkout_com_payments.js +3 -11
  60. package/lib/cjs/resources/cleanups.d.ts +23 -22
  61. package/lib/cjs/resources/cleanups.js +2 -10
  62. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +30 -29
  63. package/lib/cjs/resources/coupon_codes_promotion_rules.js +3 -11
  64. package/lib/cjs/resources/coupon_recipients.d.ts +25 -24
  65. package/lib/cjs/resources/coupon_recipients.js +3 -11
  66. package/lib/cjs/resources/coupons.d.ts +38 -26
  67. package/lib/cjs/resources/coupons.js +11 -11
  68. package/lib/cjs/resources/customer_addresses.d.ts +21 -20
  69. package/lib/cjs/resources/customer_addresses.js +3 -11
  70. package/lib/cjs/resources/customer_groups.d.ts +16 -15
  71. package/lib/cjs/resources/customer_groups.js +3 -11
  72. package/lib/cjs/resources/customer_password_resets.d.ts +18 -17
  73. package/lib/cjs/resources/customer_password_resets.js +3 -11
  74. package/lib/cjs/resources/customer_payment_sources.d.ts +40 -39
  75. package/lib/cjs/resources/customer_payment_sources.js +3 -11
  76. package/lib/cjs/resources/customer_subscriptions.d.ts +14 -13
  77. package/lib/cjs/resources/customer_subscriptions.js +3 -11
  78. package/lib/cjs/resources/customers.d.ts +39 -30
  79. package/lib/cjs/resources/customers.js +7 -11
  80. package/lib/cjs/resources/delivery_lead_times.d.ts +26 -25
  81. package/lib/cjs/resources/delivery_lead_times.js +3 -11
  82. package/lib/cjs/resources/event_callbacks.d.ts +15 -14
  83. package/lib/cjs/resources/event_callbacks.js +0 -8
  84. package/lib/cjs/resources/events.d.ts +13 -12
  85. package/lib/cjs/resources/events.js +0 -8
  86. package/lib/cjs/resources/exports.d.ts +27 -26
  87. package/lib/cjs/resources/exports.js +2 -10
  88. package/lib/cjs/resources/external_gateways.d.ts +31 -30
  89. package/lib/cjs/resources/external_gateways.js +3 -11
  90. package/lib/cjs/resources/external_payments.d.ts +22 -21
  91. package/lib/cjs/resources/external_payments.js +3 -11
  92. package/lib/cjs/resources/external_promotions.d.ts +62 -53
  93. package/lib/cjs/resources/external_promotions.js +7 -11
  94. package/lib/cjs/resources/external_tax_calculators.d.ts +18 -17
  95. package/lib/cjs/resources/external_tax_calculators.js +3 -11
  96. package/lib/cjs/resources/fixed_amount_promotions.d.ts +63 -54
  97. package/lib/cjs/resources/fixed_amount_promotions.js +7 -11
  98. package/lib/cjs/resources/fixed_price_promotions.d.ts +68 -59
  99. package/lib/cjs/resources/fixed_price_promotions.js +7 -11
  100. package/lib/cjs/resources/free_gift_promotions.d.ts +67 -58
  101. package/lib/cjs/resources/free_gift_promotions.js +7 -11
  102. package/lib/cjs/resources/free_shipping_promotions.d.ts +59 -50
  103. package/lib/cjs/resources/free_shipping_promotions.js +7 -11
  104. package/lib/cjs/resources/geocoders.d.ts +13 -12
  105. package/lib/cjs/resources/geocoders.js +0 -8
  106. package/lib/cjs/resources/gift_card_recipients.d.ts +25 -24
  107. package/lib/cjs/resources/gift_card_recipients.js +3 -11
  108. package/lib/cjs/resources/gift_cards.d.ts +69 -60
  109. package/lib/cjs/resources/gift_cards.js +7 -11
  110. package/lib/cjs/resources/google_geocoders.d.ts +16 -15
  111. package/lib/cjs/resources/google_geocoders.js +3 -11
  112. package/lib/cjs/resources/imports.d.ts +32 -31
  113. package/lib/cjs/resources/imports.js +2 -10
  114. package/lib/cjs/resources/in_stock_subscriptions.d.ts +35 -34
  115. package/lib/cjs/resources/in_stock_subscriptions.js +3 -11
  116. package/lib/cjs/resources/inventory_models.d.ts +22 -21
  117. package/lib/cjs/resources/inventory_models.js +3 -11
  118. package/lib/cjs/resources/inventory_return_locations.d.ts +21 -20
  119. package/lib/cjs/resources/inventory_return_locations.js +3 -11
  120. package/lib/cjs/resources/inventory_stock_locations.d.ts +24 -23
  121. package/lib/cjs/resources/inventory_stock_locations.js +3 -11
  122. package/lib/cjs/resources/klarna_gateways.d.ts +22 -21
  123. package/lib/cjs/resources/klarna_gateways.js +3 -11
  124. package/lib/cjs/resources/klarna_payments.d.ts +27 -26
  125. package/lib/cjs/resources/klarna_payments.js +3 -11
  126. package/lib/cjs/resources/line_item_options.d.ts +46 -34
  127. package/lib/cjs/resources/line_item_options.js +11 -11
  128. package/lib/cjs/resources/line_items.d.ts +92 -80
  129. package/lib/cjs/resources/line_items.js +11 -11
  130. package/lib/cjs/resources/manual_gateways.d.ts +14 -13
  131. package/lib/cjs/resources/manual_gateways.js +3 -11
  132. package/lib/cjs/resources/manual_tax_calculators.d.ts +20 -19
  133. package/lib/cjs/resources/manual_tax_calculators.js +3 -11
  134. package/lib/cjs/resources/markets.d.ts +59 -58
  135. package/lib/cjs/resources/markets.js +3 -11
  136. package/lib/cjs/resources/merchants.d.ts +18 -17
  137. package/lib/cjs/resources/merchants.js +3 -11
  138. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +30 -29
  139. package/lib/cjs/resources/order_amount_promotion_rules.js +3 -11
  140. package/lib/cjs/resources/order_copies.d.ts +29 -28
  141. package/lib/cjs/resources/order_copies.js +3 -11
  142. package/lib/cjs/resources/order_factories.d.ts +21 -20
  143. package/lib/cjs/resources/order_factories.js +0 -8
  144. package/lib/cjs/resources/order_subscription_items.d.ts +35 -34
  145. package/lib/cjs/resources/order_subscription_items.js +3 -11
  146. package/lib/cjs/resources/order_subscriptions.d.ts +51 -50
  147. package/lib/cjs/resources/order_subscriptions.js +3 -11
  148. package/lib/cjs/resources/order_validation_rules.d.ts +12 -11
  149. package/lib/cjs/resources/order_validation_rules.js +0 -8
  150. package/lib/cjs/resources/orders.d.ts +233 -224
  151. package/lib/cjs/resources/orders.js +7 -11
  152. package/lib/cjs/resources/organization.d.ts +25 -24
  153. package/lib/cjs/resources/organization.js +1 -6
  154. package/lib/cjs/resources/packages.d.ts +30 -29
  155. package/lib/cjs/resources/packages.js +3 -11
  156. package/lib/cjs/resources/parcel_line_items.d.ts +22 -21
  157. package/lib/cjs/resources/parcel_line_items.js +3 -11
  158. package/lib/cjs/resources/parcels.d.ts +93 -89
  159. package/lib/cjs/resources/parcels.js +3 -11
  160. package/lib/cjs/resources/payment_gateways.d.ts +12 -11
  161. package/lib/cjs/resources/payment_gateways.js +0 -8
  162. package/lib/cjs/resources/payment_methods.d.ts +48 -47
  163. package/lib/cjs/resources/payment_methods.js +3 -11
  164. package/lib/cjs/resources/paypal_gateways.d.ts +17 -16
  165. package/lib/cjs/resources/paypal_gateways.js +3 -11
  166. package/lib/cjs/resources/paypal_payments.d.ts +31 -30
  167. package/lib/cjs/resources/paypal_payments.js +3 -11
  168. package/lib/cjs/resources/percentage_discount_promotions.d.ts +67 -58
  169. package/lib/cjs/resources/percentage_discount_promotions.js +7 -11
  170. package/lib/cjs/resources/price_frequency_tiers.d.ts +26 -25
  171. package/lib/cjs/resources/price_frequency_tiers.js +3 -11
  172. package/lib/cjs/resources/price_lists.d.ts +20 -19
  173. package/lib/cjs/resources/price_lists.js +3 -11
  174. package/lib/cjs/resources/price_tiers.d.ts +17 -16
  175. package/lib/cjs/resources/price_tiers.js +0 -8
  176. package/lib/cjs/resources/price_volume_tiers.d.ts +26 -25
  177. package/lib/cjs/resources/price_volume_tiers.js +3 -11
  178. package/lib/cjs/resources/prices.d.ts +39 -38
  179. package/lib/cjs/resources/prices.js +3 -11
  180. package/lib/cjs/resources/promotion_rules.d.ts +10 -10
  181. package/lib/cjs/resources/promotion_rules.js +0 -8
  182. package/lib/cjs/resources/promotions.d.ts +27 -23
  183. package/lib/cjs/resources/promotions.js +4 -8
  184. package/lib/cjs/resources/recurring_order_copies.d.ts +29 -28
  185. package/lib/cjs/resources/recurring_order_copies.js +3 -11
  186. package/lib/cjs/resources/refunds.d.ts +24 -23
  187. package/lib/cjs/resources/refunds.js +0 -8
  188. package/lib/cjs/resources/return_line_items.d.ts +27 -26
  189. package/lib/cjs/resources/return_line_items.js +3 -11
  190. package/lib/cjs/resources/returns.d.ts +52 -43
  191. package/lib/cjs/resources/returns.js +7 -11
  192. package/lib/cjs/resources/satispay_gateways.d.ts +23 -19
  193. package/lib/cjs/resources/satispay_gateways.js +3 -11
  194. package/lib/cjs/resources/satispay_payments.d.ts +21 -23
  195. package/lib/cjs/resources/satispay_payments.js +3 -11
  196. package/lib/cjs/resources/shipments.d.ts +52 -51
  197. package/lib/cjs/resources/shipments.js +1 -9
  198. package/lib/cjs/resources/shipping_categories.d.ts +15 -14
  199. package/lib/cjs/resources/shipping_categories.js +3 -11
  200. package/lib/cjs/resources/shipping_method_tiers.d.ts +17 -16
  201. package/lib/cjs/resources/shipping_method_tiers.js +0 -8
  202. package/lib/cjs/resources/shipping_methods.d.ts +71 -70
  203. package/lib/cjs/resources/shipping_methods.js +3 -11
  204. package/lib/cjs/resources/shipping_weight_tiers.d.ts +25 -24
  205. package/lib/cjs/resources/shipping_weight_tiers.js +3 -11
  206. package/lib/cjs/resources/shipping_zones.d.ts +32 -31
  207. package/lib/cjs/resources/shipping_zones.js +3 -11
  208. package/lib/cjs/resources/sku_list_items.d.ts +26 -25
  209. package/lib/cjs/resources/sku_list_items.js +3 -11
  210. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +37 -36
  211. package/lib/cjs/resources/sku_list_promotion_rules.js +3 -11
  212. package/lib/cjs/resources/sku_lists.d.ts +35 -34
  213. package/lib/cjs/resources/sku_lists.js +3 -11
  214. package/lib/cjs/resources/sku_options.d.ts +48 -36
  215. package/lib/cjs/resources/sku_options.js +11 -11
  216. package/lib/cjs/resources/skus.d.ts +60 -48
  217. package/lib/cjs/resources/skus.js +11 -11
  218. package/lib/cjs/resources/stock_items.d.ts +26 -25
  219. package/lib/cjs/resources/stock_items.js +3 -11
  220. package/lib/cjs/resources/stock_line_items.d.ts +16 -15
  221. package/lib/cjs/resources/stock_line_items.js +0 -8
  222. package/lib/cjs/resources/stock_locations.d.ts +29 -28
  223. package/lib/cjs/resources/stock_locations.js +3 -11
  224. package/lib/cjs/resources/stock_transfers.d.ts +42 -41
  225. package/lib/cjs/resources/stock_transfers.js +3 -11
  226. package/lib/cjs/resources/stripe_gateways.d.ts +22 -21
  227. package/lib/cjs/resources/stripe_gateways.js +3 -11
  228. package/lib/cjs/resources/stripe_payments.d.ts +28 -27
  229. package/lib/cjs/resources/stripe_payments.js +3 -11
  230. package/lib/cjs/resources/subscription_models.d.ts +27 -26
  231. package/lib/cjs/resources/subscription_models.js +3 -11
  232. package/lib/cjs/resources/tags.d.ts +28 -0
  233. package/lib/cjs/resources/tags.js +25 -0
  234. package/lib/cjs/resources/tax_calculators.d.ts +13 -12
  235. package/lib/cjs/resources/tax_calculators.js +0 -8
  236. package/lib/cjs/resources/tax_categories.d.ts +30 -29
  237. package/lib/cjs/resources/tax_categories.js +3 -11
  238. package/lib/cjs/resources/tax_rules.d.ts +51 -50
  239. package/lib/cjs/resources/tax_rules.js +3 -11
  240. package/lib/cjs/resources/taxjar_accounts.d.ts +21 -20
  241. package/lib/cjs/resources/taxjar_accounts.js +3 -11
  242. package/lib/cjs/resources/transactions.d.ts +22 -21
  243. package/lib/cjs/resources/transactions.js +0 -8
  244. package/lib/cjs/resources/voids.d.ts +24 -23
  245. package/lib/cjs/resources/voids.js +0 -8
  246. package/lib/cjs/resources/webhooks.d.ts +26 -25
  247. package/lib/cjs/resources/webhooks.js +3 -11
  248. package/lib/cjs/resources/wire_transfers.d.ts +16 -15
  249. package/lib/cjs/resources/wire_transfers.js +3 -11
  250. package/lib/cjs/static.d.ts +1 -1
  251. package/lib/cjs/util.d.ts +1 -3
  252. package/lib/esm/api.d.ts +23 -2
  253. package/lib/esm/api.js +2 -13
  254. package/lib/esm/client.d.ts +3 -5
  255. package/lib/esm/client.js +11 -8
  256. package/lib/esm/commercelayer.d.ts +6 -5
  257. package/lib/esm/commercelayer.js +4 -3
  258. package/lib/esm/common.d.ts +1 -0
  259. package/lib/esm/common.js +11 -2
  260. package/lib/esm/config.d.ts +1 -0
  261. package/lib/esm/config.js +1 -0
  262. package/lib/esm/debug.js +0 -4
  263. package/lib/esm/error.js +1 -4
  264. package/lib/esm/index.d.ts +1 -1
  265. package/lib/esm/index.js +0 -2
  266. package/lib/esm/interceptor.d.ts +6 -2
  267. package/lib/esm/jsonapi.js +5 -1
  268. package/lib/esm/model.d.ts +1 -0
  269. package/lib/esm/query.d.ts +9 -15
  270. package/lib/esm/query.js +2 -2
  271. package/lib/esm/resource.d.ts +33 -25
  272. package/lib/esm/resource.js +34 -10
  273. package/lib/esm/resources/addresses.d.ts +78 -66
  274. package/lib/esm/resources/addresses.js +11 -11
  275. package/lib/esm/resources/adjustments.d.ts +19 -18
  276. package/lib/esm/resources/adjustments.js +3 -11
  277. package/lib/esm/resources/adyen_gateways.d.ts +34 -33
  278. package/lib/esm/resources/adyen_gateways.js +3 -11
  279. package/lib/esm/resources/adyen_payments.d.ts +27 -26
  280. package/lib/esm/resources/adyen_payments.js +3 -11
  281. package/lib/esm/resources/application.d.ts +14 -13
  282. package/lib/esm/resources/application.js +2 -7
  283. package/lib/esm/resources/attachments.d.ts +81 -80
  284. package/lib/esm/resources/attachments.js +3 -11
  285. package/lib/esm/resources/authorizations.d.ts +42 -41
  286. package/lib/esm/resources/authorizations.js +1 -9
  287. package/lib/esm/resources/avalara_accounts.d.ts +31 -30
  288. package/lib/esm/resources/avalara_accounts.js +3 -11
  289. package/lib/esm/resources/axerve_gateways.d.ts +22 -21
  290. package/lib/esm/resources/axerve_gateways.js +3 -11
  291. package/lib/esm/resources/axerve_payments.d.ts +26 -25
  292. package/lib/esm/resources/axerve_payments.js +3 -11
  293. package/lib/esm/resources/billing_info_validation_rules.d.ts +16 -15
  294. package/lib/esm/resources/billing_info_validation_rules.js +3 -11
  295. package/lib/esm/resources/bing_geocoders.d.ts +16 -15
  296. package/lib/esm/resources/bing_geocoders.js +3 -11
  297. package/lib/esm/resources/braintree_gateways.d.ts +33 -32
  298. package/lib/esm/resources/braintree_gateways.js +3 -11
  299. package/lib/esm/resources/braintree_payments.d.ts +29 -28
  300. package/lib/esm/resources/braintree_payments.js +3 -11
  301. package/lib/esm/resources/bundles.d.ts +59 -47
  302. package/lib/esm/resources/bundles.js +11 -11
  303. package/lib/esm/resources/captures.d.ts +33 -32
  304. package/lib/esm/resources/captures.js +1 -9
  305. package/lib/esm/resources/carrier_accounts.d.ts +15 -14
  306. package/lib/esm/resources/carrier_accounts.js +0 -8
  307. package/lib/esm/resources/checkout_com_gateways.d.ts +24 -23
  308. package/lib/esm/resources/checkout_com_gateways.js +3 -11
  309. package/lib/esm/resources/checkout_com_payments.d.ts +38 -37
  310. package/lib/esm/resources/checkout_com_payments.js +3 -11
  311. package/lib/esm/resources/cleanups.d.ts +23 -22
  312. package/lib/esm/resources/cleanups.js +2 -10
  313. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +30 -29
  314. package/lib/esm/resources/coupon_codes_promotion_rules.js +3 -11
  315. package/lib/esm/resources/coupon_recipients.d.ts +25 -24
  316. package/lib/esm/resources/coupon_recipients.js +3 -11
  317. package/lib/esm/resources/coupons.d.ts +38 -26
  318. package/lib/esm/resources/coupons.js +11 -11
  319. package/lib/esm/resources/customer_addresses.d.ts +21 -20
  320. package/lib/esm/resources/customer_addresses.js +3 -11
  321. package/lib/esm/resources/customer_groups.d.ts +16 -15
  322. package/lib/esm/resources/customer_groups.js +3 -11
  323. package/lib/esm/resources/customer_password_resets.d.ts +18 -17
  324. package/lib/esm/resources/customer_password_resets.js +3 -11
  325. package/lib/esm/resources/customer_payment_sources.d.ts +40 -39
  326. package/lib/esm/resources/customer_payment_sources.js +3 -11
  327. package/lib/esm/resources/customer_subscriptions.d.ts +14 -13
  328. package/lib/esm/resources/customer_subscriptions.js +3 -11
  329. package/lib/esm/resources/customers.d.ts +39 -30
  330. package/lib/esm/resources/customers.js +7 -11
  331. package/lib/esm/resources/delivery_lead_times.d.ts +26 -25
  332. package/lib/esm/resources/delivery_lead_times.js +3 -11
  333. package/lib/esm/resources/event_callbacks.d.ts +15 -14
  334. package/lib/esm/resources/event_callbacks.js +0 -8
  335. package/lib/esm/resources/events.d.ts +13 -12
  336. package/lib/esm/resources/events.js +0 -8
  337. package/lib/esm/resources/exports.d.ts +27 -26
  338. package/lib/esm/resources/exports.js +2 -10
  339. package/lib/esm/resources/external_gateways.d.ts +31 -30
  340. package/lib/esm/resources/external_gateways.js +3 -11
  341. package/lib/esm/resources/external_payments.d.ts +22 -21
  342. package/lib/esm/resources/external_payments.js +3 -11
  343. package/lib/esm/resources/external_promotions.d.ts +62 -53
  344. package/lib/esm/resources/external_promotions.js +7 -11
  345. package/lib/esm/resources/external_tax_calculators.d.ts +18 -17
  346. package/lib/esm/resources/external_tax_calculators.js +3 -11
  347. package/lib/esm/resources/fixed_amount_promotions.d.ts +63 -54
  348. package/lib/esm/resources/fixed_amount_promotions.js +7 -11
  349. package/lib/esm/resources/fixed_price_promotions.d.ts +68 -59
  350. package/lib/esm/resources/fixed_price_promotions.js +7 -11
  351. package/lib/esm/resources/free_gift_promotions.d.ts +67 -58
  352. package/lib/esm/resources/free_gift_promotions.js +7 -11
  353. package/lib/esm/resources/free_shipping_promotions.d.ts +59 -50
  354. package/lib/esm/resources/free_shipping_promotions.js +7 -11
  355. package/lib/esm/resources/geocoders.d.ts +13 -12
  356. package/lib/esm/resources/geocoders.js +0 -8
  357. package/lib/esm/resources/gift_card_recipients.d.ts +25 -24
  358. package/lib/esm/resources/gift_card_recipients.js +3 -11
  359. package/lib/esm/resources/gift_cards.d.ts +69 -60
  360. package/lib/esm/resources/gift_cards.js +7 -11
  361. package/lib/esm/resources/google_geocoders.d.ts +16 -15
  362. package/lib/esm/resources/google_geocoders.js +3 -11
  363. package/lib/esm/resources/imports.d.ts +32 -31
  364. package/lib/esm/resources/imports.js +2 -10
  365. package/lib/esm/resources/in_stock_subscriptions.d.ts +35 -34
  366. package/lib/esm/resources/in_stock_subscriptions.js +3 -11
  367. package/lib/esm/resources/inventory_models.d.ts +22 -21
  368. package/lib/esm/resources/inventory_models.js +3 -11
  369. package/lib/esm/resources/inventory_return_locations.d.ts +21 -20
  370. package/lib/esm/resources/inventory_return_locations.js +3 -11
  371. package/lib/esm/resources/inventory_stock_locations.d.ts +24 -23
  372. package/lib/esm/resources/inventory_stock_locations.js +3 -11
  373. package/lib/esm/resources/klarna_gateways.d.ts +22 -21
  374. package/lib/esm/resources/klarna_gateways.js +3 -11
  375. package/lib/esm/resources/klarna_payments.d.ts +27 -26
  376. package/lib/esm/resources/klarna_payments.js +3 -11
  377. package/lib/esm/resources/line_item_options.d.ts +46 -34
  378. package/lib/esm/resources/line_item_options.js +11 -11
  379. package/lib/esm/resources/line_items.d.ts +92 -80
  380. package/lib/esm/resources/line_items.js +11 -11
  381. package/lib/esm/resources/manual_gateways.d.ts +14 -13
  382. package/lib/esm/resources/manual_gateways.js +3 -11
  383. package/lib/esm/resources/manual_tax_calculators.d.ts +20 -19
  384. package/lib/esm/resources/manual_tax_calculators.js +3 -11
  385. package/lib/esm/resources/markets.d.ts +59 -58
  386. package/lib/esm/resources/markets.js +3 -11
  387. package/lib/esm/resources/merchants.d.ts +18 -17
  388. package/lib/esm/resources/merchants.js +3 -11
  389. package/lib/esm/resources/order_amount_promotion_rules.d.ts +30 -29
  390. package/lib/esm/resources/order_amount_promotion_rules.js +3 -11
  391. package/lib/esm/resources/order_copies.d.ts +29 -28
  392. package/lib/esm/resources/order_copies.js +3 -11
  393. package/lib/esm/resources/order_factories.d.ts +21 -20
  394. package/lib/esm/resources/order_factories.js +0 -8
  395. package/lib/esm/resources/order_subscription_items.d.ts +35 -34
  396. package/lib/esm/resources/order_subscription_items.js +3 -11
  397. package/lib/esm/resources/order_subscriptions.d.ts +51 -50
  398. package/lib/esm/resources/order_subscriptions.js +3 -11
  399. package/lib/esm/resources/order_validation_rules.d.ts +12 -11
  400. package/lib/esm/resources/order_validation_rules.js +0 -8
  401. package/lib/esm/resources/orders.d.ts +233 -224
  402. package/lib/esm/resources/orders.js +7 -11
  403. package/lib/esm/resources/organization.d.ts +25 -24
  404. package/lib/esm/resources/organization.js +2 -7
  405. package/lib/esm/resources/packages.d.ts +30 -29
  406. package/lib/esm/resources/packages.js +3 -11
  407. package/lib/esm/resources/parcel_line_items.d.ts +22 -21
  408. package/lib/esm/resources/parcel_line_items.js +3 -11
  409. package/lib/esm/resources/parcels.d.ts +93 -89
  410. package/lib/esm/resources/parcels.js +3 -11
  411. package/lib/esm/resources/payment_gateways.d.ts +12 -11
  412. package/lib/esm/resources/payment_gateways.js +0 -8
  413. package/lib/esm/resources/payment_methods.d.ts +48 -47
  414. package/lib/esm/resources/payment_methods.js +3 -11
  415. package/lib/esm/resources/paypal_gateways.d.ts +17 -16
  416. package/lib/esm/resources/paypal_gateways.js +3 -11
  417. package/lib/esm/resources/paypal_payments.d.ts +31 -30
  418. package/lib/esm/resources/paypal_payments.js +3 -11
  419. package/lib/esm/resources/percentage_discount_promotions.d.ts +67 -58
  420. package/lib/esm/resources/percentage_discount_promotions.js +7 -11
  421. package/lib/esm/resources/price_frequency_tiers.d.ts +26 -25
  422. package/lib/esm/resources/price_frequency_tiers.js +3 -11
  423. package/lib/esm/resources/price_lists.d.ts +20 -19
  424. package/lib/esm/resources/price_lists.js +3 -11
  425. package/lib/esm/resources/price_tiers.d.ts +17 -16
  426. package/lib/esm/resources/price_tiers.js +0 -8
  427. package/lib/esm/resources/price_volume_tiers.d.ts +26 -25
  428. package/lib/esm/resources/price_volume_tiers.js +3 -11
  429. package/lib/esm/resources/prices.d.ts +39 -38
  430. package/lib/esm/resources/prices.js +3 -11
  431. package/lib/esm/resources/promotion_rules.d.ts +10 -10
  432. package/lib/esm/resources/promotion_rules.js +0 -8
  433. package/lib/esm/resources/promotions.d.ts +27 -23
  434. package/lib/esm/resources/promotions.js +4 -8
  435. package/lib/esm/resources/recurring_order_copies.d.ts +29 -28
  436. package/lib/esm/resources/recurring_order_copies.js +3 -11
  437. package/lib/esm/resources/refunds.d.ts +24 -23
  438. package/lib/esm/resources/refunds.js +0 -8
  439. package/lib/esm/resources/return_line_items.d.ts +27 -26
  440. package/lib/esm/resources/return_line_items.js +3 -11
  441. package/lib/esm/resources/returns.d.ts +52 -43
  442. package/lib/esm/resources/returns.js +7 -11
  443. package/lib/esm/resources/satispay_gateways.d.ts +23 -19
  444. package/lib/esm/resources/satispay_gateways.js +3 -11
  445. package/lib/esm/resources/satispay_payments.d.ts +21 -23
  446. package/lib/esm/resources/satispay_payments.js +3 -11
  447. package/lib/esm/resources/shipments.d.ts +52 -51
  448. package/lib/esm/resources/shipments.js +1 -9
  449. package/lib/esm/resources/shipping_categories.d.ts +15 -14
  450. package/lib/esm/resources/shipping_categories.js +3 -11
  451. package/lib/esm/resources/shipping_method_tiers.d.ts +17 -16
  452. package/lib/esm/resources/shipping_method_tiers.js +0 -8
  453. package/lib/esm/resources/shipping_methods.d.ts +71 -70
  454. package/lib/esm/resources/shipping_methods.js +3 -11
  455. package/lib/esm/resources/shipping_weight_tiers.d.ts +25 -24
  456. package/lib/esm/resources/shipping_weight_tiers.js +3 -11
  457. package/lib/esm/resources/shipping_zones.d.ts +32 -31
  458. package/lib/esm/resources/shipping_zones.js +3 -11
  459. package/lib/esm/resources/sku_list_items.d.ts +26 -25
  460. package/lib/esm/resources/sku_list_items.js +3 -11
  461. package/lib/esm/resources/sku_list_promotion_rules.d.ts +37 -36
  462. package/lib/esm/resources/sku_list_promotion_rules.js +3 -11
  463. package/lib/esm/resources/sku_lists.d.ts +35 -34
  464. package/lib/esm/resources/sku_lists.js +3 -11
  465. package/lib/esm/resources/sku_options.d.ts +48 -36
  466. package/lib/esm/resources/sku_options.js +11 -11
  467. package/lib/esm/resources/skus.d.ts +60 -48
  468. package/lib/esm/resources/skus.js +11 -11
  469. package/lib/esm/resources/stock_items.d.ts +26 -25
  470. package/lib/esm/resources/stock_items.js +3 -11
  471. package/lib/esm/resources/stock_line_items.d.ts +16 -15
  472. package/lib/esm/resources/stock_line_items.js +0 -8
  473. package/lib/esm/resources/stock_locations.d.ts +29 -28
  474. package/lib/esm/resources/stock_locations.js +3 -11
  475. package/lib/esm/resources/stock_transfers.d.ts +42 -41
  476. package/lib/esm/resources/stock_transfers.js +3 -11
  477. package/lib/esm/resources/stripe_gateways.d.ts +22 -21
  478. package/lib/esm/resources/stripe_gateways.js +3 -11
  479. package/lib/esm/resources/stripe_payments.d.ts +28 -27
  480. package/lib/esm/resources/stripe_payments.js +3 -11
  481. package/lib/esm/resources/subscription_models.d.ts +27 -26
  482. package/lib/esm/resources/subscription_models.js +3 -11
  483. package/lib/esm/resources/tags.d.ts +28 -0
  484. package/lib/esm/resources/tags.js +23 -0
  485. package/lib/esm/resources/tax_calculators.d.ts +13 -12
  486. package/lib/esm/resources/tax_calculators.js +0 -8
  487. package/lib/esm/resources/tax_categories.d.ts +30 -29
  488. package/lib/esm/resources/tax_categories.js +3 -11
  489. package/lib/esm/resources/tax_rules.d.ts +51 -50
  490. package/lib/esm/resources/tax_rules.js +3 -11
  491. package/lib/esm/resources/taxjar_accounts.d.ts +21 -20
  492. package/lib/esm/resources/taxjar_accounts.js +3 -11
  493. package/lib/esm/resources/transactions.d.ts +22 -21
  494. package/lib/esm/resources/transactions.js +0 -8
  495. package/lib/esm/resources/voids.d.ts +24 -23
  496. package/lib/esm/resources/voids.js +0 -8
  497. package/lib/esm/resources/webhooks.d.ts +26 -25
  498. package/lib/esm/resources/webhooks.js +3 -11
  499. package/lib/esm/resources/wire_transfers.d.ts +16 -15
  500. package/lib/esm/resources/wire_transfers.js +3 -11
  501. package/lib/esm/static.d.ts +1 -1
  502. package/lib/esm/util.d.ts +1 -3
  503. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  504. package/lib/tsconfig.tsbuildinfo +1 -1
  505. package/package.json +9 -9
package/lib/cjs/api.d.ts CHANGED
@@ -106,6 +106,7 @@ export { default as StockTransfers } from './resources/stock_transfers';
106
106
  export { default as StripeGateways } from './resources/stripe_gateways';
107
107
  export { default as StripePayments } from './resources/stripe_payments';
108
108
  export { default as SubscriptionModels } from './resources/subscription_models';
109
+ export { default as Tags } from './resources/tags';
109
110
  export { default as TaxCalculators } from './resources/tax_calculators';
110
111
  export { default as TaxCategories } from './resources/tax_categories';
111
112
  export { default as TaxRules } from './resources/tax_rules';
@@ -114,5 +115,25 @@ export { default as Transactions } from './resources/transactions';
114
115
  export { default as Voids } from './resources/voids';
115
116
  export { default as Webhooks } from './resources/webhooks';
116
117
  export { default as WireTransfers } from './resources/wire_transfers';
117
- export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
118
- export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_frequency_tiers", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "recurring_order_copies", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "subscription_models", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
118
+ export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
119
+ export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_frequency_tiers", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "recurring_order_copies", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "subscription_models", "tags", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
120
+ export type RetrievableResourceType = ResourceTypeLock;
121
+ export type RetrievableResource = {
122
+ type: RetrievableResourceType;
123
+ };
124
+ export type ListableResourceType = Exclude<ResourceTypeLock, 'application' | 'organization'>;
125
+ export type ListableResource = {
126
+ type: ListableResourceType;
127
+ };
128
+ export type CreatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
129
+ export type CreatableResource = {
130
+ type: CreatableResourceType;
131
+ };
132
+ export type UpdatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
133
+ export type UpdatableResource = {
134
+ type: UpdatableResourceType;
135
+ };
136
+ export type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
137
+ export type DeletableResource = {
138
+ type: DeletableResourceType;
139
+ };
package/lib/cjs/api.js CHANGED
@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.InventoryStockLocations = exports.InventoryReturnLocations = exports.InventoryModels = exports.InStockSubscriptions = exports.Imports = exports.GoogleGeocoders = exports.GiftCards = exports.GiftCardRecipients = exports.Geocoders = exports.FreeShippingPromotions = exports.FreeGiftPromotions = exports.FixedPricePromotions = exports.FixedAmountPromotions = exports.ExternalTaxCalculators = exports.ExternalPromotions = exports.ExternalPayments = exports.ExternalGateways = exports.Exports = exports.Events = exports.EventCallbacks = exports.DeliveryLeadTimes = exports.Customers = exports.CustomerSubscriptions = exports.CustomerPaymentSources = exports.CustomerPasswordResets = exports.CustomerGroups = exports.CustomerAddresses = exports.Coupons = exports.CouponRecipients = exports.CouponCodesPromotionRules = exports.Cleanups = exports.CheckoutComPayments = exports.CheckoutComGateways = exports.CarrierAccounts = exports.Captures = exports.Bundles = exports.BraintreePayments = exports.BraintreeGateways = exports.BingGeocoders = exports.BillingInfoValidationRules = exports.AxervePayments = exports.AxerveGateways = exports.AvalaraAccounts = exports.Authorizations = exports.Attachments = exports.Applications = exports.AdyenPayments = exports.AdyenGateways = exports.Adjustments = exports.Addresses = void 0;
7
7
  exports.StockLineItems = exports.StockItems = exports.Skus = exports.SkuOptions = exports.SkuLists = exports.SkuListPromotionRules = exports.SkuListItems = exports.ShippingZones = exports.ShippingWeightTiers = exports.ShippingMethods = exports.ShippingMethodTiers = exports.ShippingCategories = exports.Shipments = exports.SatispayPayments = exports.SatispayGateways = exports.Returns = exports.ReturnLineItems = exports.Refunds = exports.RecurringOrderCopies = exports.Promotions = exports.PromotionRules = exports.Prices = exports.PriceVolumeTiers = exports.PriceTiers = exports.PriceLists = exports.PriceFrequencyTiers = exports.PercentageDiscountPromotions = exports.PaypalPayments = exports.PaypalGateways = exports.PaymentMethods = exports.PaymentGateways = exports.Parcels = exports.ParcelLineItems = exports.Packages = exports.Organizations = exports.Orders = exports.OrderValidationRules = exports.OrderSubscriptions = exports.OrderSubscriptionItems = exports.OrderFactories = exports.OrderCopies = exports.OrderAmountPromotionRules = exports.Merchants = exports.Markets = exports.ManualTaxCalculators = exports.ManualGateways = exports.LineItems = exports.LineItemOptions = exports.KlarnaPayments = exports.KlarnaGateways = void 0;
8
- exports.resourceList = exports.WireTransfers = exports.Webhooks = exports.Voids = exports.Transactions = exports.TaxjarAccounts = exports.TaxRules = exports.TaxCategories = exports.TaxCalculators = exports.SubscriptionModels = exports.StripePayments = exports.StripeGateways = exports.StockTransfers = exports.StockLocations = void 0;
8
+ exports.resourceList = exports.WireTransfers = exports.Webhooks = exports.Voids = exports.Transactions = exports.TaxjarAccounts = exports.TaxRules = exports.TaxCategories = exports.TaxCalculators = exports.Tags = exports.SubscriptionModels = exports.StripePayments = exports.StripeGateways = exports.StockTransfers = exports.StockLocations = void 0;
9
9
  // ##__API_RESOURCES_START__##
10
10
  // ##__API_RESOURCES_TEMPLATE:: export { default as ##__RESOURCE_CLASS__## } from './resources/##__RESOURCE_TYPE__##'
11
11
  /**
@@ -221,6 +221,8 @@ var stripe_payments_1 = require("./resources/stripe_payments");
221
221
  Object.defineProperty(exports, "StripePayments", { enumerable: true, get: function () { return __importDefault(stripe_payments_1).default; } });
222
222
  var subscription_models_1 = require("./resources/subscription_models");
223
223
  Object.defineProperty(exports, "SubscriptionModels", { enumerable: true, get: function () { return __importDefault(subscription_models_1).default; } });
224
+ var tags_1 = require("./resources/tags");
225
+ Object.defineProperty(exports, "Tags", { enumerable: true, get: function () { return __importDefault(tags_1).default; } });
224
226
  var tax_calculators_1 = require("./resources/tax_calculators");
225
227
  Object.defineProperty(exports, "TaxCalculators", { enumerable: true, get: function () { return __importDefault(tax_calculators_1).default; } });
226
228
  var tax_categories_1 = require("./resources/tax_categories");
@@ -345,6 +347,7 @@ exports.resourceList = [
345
347
  'stripe_gateways',
346
348
  'stripe_payments',
347
349
  'subscription_models',
350
+ 'tags',
348
351
  'tax_calculators',
349
352
  'tax_categories',
350
353
  'tax_rules',
@@ -355,16 +358,3 @@ exports.resourceList = [
355
358
  'wire_transfers'
356
359
  // ##__API_RESOURCE_LIST_STOP__##
357
360
  ];
358
- /*
359
- type ResourceInfo = {
360
- name: string;
361
- type: string;
362
- api: string;
363
- }
364
-
365
-
366
- export const resourceMap: { [res: string]: ResourceInfo } = {
367
- // ##__API_RESOURCE_MAP_START__##
368
- // ##__API_RESOURCE_MAP_STOP__##
369
- } as const
370
- */
@@ -1,15 +1,13 @@
1
1
  /// <reference types="node" />
2
2
  /// <reference types="node" />
3
- import { AxiosProxyConfig, Method } from 'axios';
3
+ import { type AxiosProxyConfig, type Method } from 'axios';
4
4
  import type { InterceptorManager } from './interceptor';
5
5
  import type { Agent as HttpAgent } from 'http';
6
6
  import type { Agent as HttpsAgent } from 'https';
7
7
  type ProxyConfig = AxiosProxyConfig | false;
8
8
  type RequestConfig = {
9
9
  timeout?: number;
10
- params?: {
11
- [key: string]: string | number | boolean;
12
- };
10
+ params?: Record<string, string | number | boolean>;
13
11
  httpAgent?: HttpAgent;
14
12
  httpsAgent?: HttpsAgent;
15
13
  proxy?: ProxyConfig;
@@ -30,4 +28,4 @@ declare class ApiClient {
30
28
  request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
31
29
  }
32
30
  export default ApiClient;
33
- export { ApiClientInitConfig, ApiClientConfig, RequestConfig };
31
+ export type { ApiClientInitConfig, ApiClientConfig, RequestConfig };
package/lib/cjs/client.js CHANGED
@@ -15,7 +15,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
15
15
  };
16
16
  var _ApiClient_accessToken, _ApiClient_client;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
- /* eslint-disable @typescript-eslint/no-explicit-any */
19
18
  const axios_1 = __importDefault(require("axios"));
20
19
  const error_1 = require("./error");
21
20
  const config_1 = __importDefault(require("./config"));
@@ -55,10 +54,9 @@ const handleError = (error) => {
55
54
  };
56
55
  class ApiClient {
57
56
  static create(options) {
58
- if (!(options === null || options === void 0 ? void 0 : options.organization))
59
- throw new Error("Undefined 'organization' parameter");
60
- if (!(options === null || options === void 0 ? void 0 : options.accessToken))
61
- throw new Error("Undefined 'accessToken' parameter");
57
+ for (const attr of config_1.default.client.requiredAttributes)
58
+ if (!options || !options[attr])
59
+ throw new error_1.SdkError({ message: `Undefined '${attr}' parameter` });
62
60
  return new ApiClient(options);
63
61
  }
64
62
  constructor(options) {
@@ -73,11 +71,16 @@ class ApiClient {
73
71
  httpAgent: options.httpAgent,
74
72
  httpsAgent: options.httpsAgent,
75
73
  };
76
- const axiosOptions = Object.assign({ baseURL: this.baseUrl, timeout: config_1.default.client.timeout, headers: {
74
+ const axiosOptions = {
75
+ baseURL: this.baseUrl,
76
+ timeout: config_1.default.client.timeout,
77
+ headers: {
77
78
  'Accept': 'application/vnd.api+json',
78
79
  'Content-Type': 'application/vnd.api+json',
79
80
  'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
80
- } }, axiosConfig);
81
+ },
82
+ ...axiosConfig
83
+ };
81
84
  debug('axios options: %O', axiosOptions);
82
85
  __classPrivateFieldSet(this, _ApiClient_client, axios_1.default.create(axiosOptions), "f");
83
86
  this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
@@ -110,7 +113,7 @@ class ApiClient {
110
113
  const baseUrl = (options === null || options === void 0 ? void 0 : options.organization) ? baseURL(options.organization, options.domain) : undefined;
111
114
  const accessToken = (options === null || options === void 0 ? void 0 : options.accessToken) || __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
112
115
  const headers = accessToken ? { 'Authorization': 'Bearer ' + accessToken } : undefined;
113
- const requestParams = Object.assign({ method, baseURL: baseUrl, url, data, headers }, options);
116
+ const requestParams = { method, baseURL: baseUrl, url, data, headers, ...options };
114
117
  debug('request params: %O', requestParams);
115
118
  // const start = Date.now()
116
119
  return __classPrivateFieldGet(this, _ApiClient_client, "f").request(requestParams)
@@ -1,16 +1,16 @@
1
1
  import * as api from './api';
2
- import { ApiError } from './error';
2
+ import type { ApiError } from './error';
3
3
  import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
4
- import { ResourcesInitConfig } from './resource';
5
- declare const OPEN_API_SCHEMA_VERSION = "4.1.3";
4
+ import { type ResourcesInitConfig } from './resource';
5
+ declare const OPEN_API_SCHEMA_VERSION = "4.2.4";
6
6
  export { OPEN_API_SCHEMA_VERSION };
7
- type SdkConfig = {};
7
+ type SdkConfig = Record<string, unknown>;
8
8
  type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
9
9
  type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
10
10
  declare class CommerceLayerClient {
11
11
  #private;
12
12
  static get openApiSchemaVersion(): string;
13
- readonly openApiSchemaVersion = "4.1.3";
13
+ readonly openApiSchemaVersion = "4.2.4";
14
14
  addresses: api.Addresses;
15
15
  adjustments: api.Adjustments;
16
16
  adyen_gateways: api.AdyenGateways;
@@ -116,6 +116,7 @@ declare class CommerceLayerClient {
116
116
  stripe_gateways: api.StripeGateways;
117
117
  stripe_payments: api.StripePayments;
118
118
  subscription_models: api.SubscriptionModels;
119
+ tags: api.Tags;
119
120
  tax_calculators: api.TaxCalculators;
120
121
  tax_categories: api.TaxCategories;
121
122
  tax_rules: api.TaxRules;
@@ -45,7 +45,7 @@ const resource_1 = __importDefault(require("./resource"));
45
45
  const debug_1 = __importDefault(require("./debug"));
46
46
  const debug = (0, debug_1.default)('commercelayer');
47
47
  // Autogenerated schema version number, do not remove this line
48
- const OPEN_API_SCHEMA_VERSION = '4.1.3';
48
+ const OPEN_API_SCHEMA_VERSION = '4.2.4';
49
49
  exports.OPEN_API_SCHEMA_VERSION = OPEN_API_SCHEMA_VERSION;
50
50
  class CommerceLayerClient {
51
51
  static get openApiSchemaVersion() { return OPEN_API_SCHEMA_VERSION; }
@@ -164,6 +164,7 @@ class CommerceLayerClient {
164
164
  this.stripe_gateways = new api.StripeGateways(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
165
165
  this.stripe_payments = new api.StripePayments(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
166
166
  this.subscription_models = new api.SubscriptionModels(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
167
+ this.tags = new api.Tags(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
167
168
  this.tax_calculators = new api.TaxCalculators(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
168
169
  this.tax_categories = new api.TaxCategories(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
169
170
  this.tax_rules = new api.TaxRules(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -203,7 +204,7 @@ class CommerceLayerClient {
203
204
  return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors.response.use(onFulfilled, onRejected);
204
205
  }
205
206
  removeInterceptor(type, id) {
206
- return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
207
+ __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
207
208
  }
208
209
  addRawResponseReader(options) {
209
210
  const reader = {
@@ -224,7 +225,7 @@ class CommerceLayerClient {
224
225
  removeRawResponseReader(reader) {
225
226
  const id = (typeof reader === 'number') ? reader : reader === null || reader === void 0 ? void 0 : reader.id;
226
227
  if (id && (id >= 0))
227
- return this.removeInterceptor('response', id);
228
+ this.removeInterceptor('response', id);
228
229
  }
229
230
  }
230
231
  _CommerceLayerClient_adapter = new WeakMap(), _CommerceLayerClient_organization = new WeakMap();
@@ -2,3 +2,4 @@ import type { ResourceId, ResourceType } from './resource';
2
2
  declare const isResourceId: (resource: any) => resource is ResourceId;
3
3
  declare const isResourceType: (resource: any) => resource is ResourceType;
4
4
  export { isResourceId, isResourceType };
5
+ export type ObjectType = Record<string, any>;
package/lib/cjs/common.js CHANGED
@@ -1,6 +1,4 @@
1
1
  "use strict";
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
4
2
  Object.defineProperty(exports, "__esModule", { value: true });
5
3
  exports.isResourceType = exports.isResourceId = void 0;
6
4
  const api_1 = require("./api");
@@ -12,3 +10,14 @@ const isResourceType = (resource) => {
12
10
  return resource && (typeof resource.type !== 'undefined') && resource.type && api_1.resourceList.includes(resource.type);
13
11
  };
14
12
  exports.isResourceType = isResourceType;
13
+ /*
14
+ // Nullable types
15
+ type StringNullable = string | null
16
+ type NumberNullable = number | null
17
+ type BooleanNullable = boolean | null
18
+ type ResourceNullable<R extends Resource> = R | null
19
+ type ResourceArrayNullable<R extends Resource> = R[] | null
20
+
21
+
22
+ export type { StringNullable, NumberNullable, BooleanNullable, ResourceNullable, ResourceArrayNullable }
23
+ */
@@ -6,6 +6,7 @@ declare const config: {
6
6
  };
7
7
  readonly client: {
8
8
  readonly timeout: 15000;
9
+ readonly requiredAttributes: readonly ["organization", "accessToken"];
9
10
  };
10
11
  };
11
12
  export default config;
package/lib/cjs/config.js CHANGED
@@ -8,6 +8,7 @@ const config = {
8
8
  },
9
9
  client: {
10
10
  timeout: 15000,
11
+ requiredAttributes: ['organization', 'accessToken']
11
12
  }
12
13
  };
13
14
  exports.default = config;
package/lib/cjs/debug.js CHANGED
@@ -1,7 +1,4 @@
1
1
  "use strict";
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
- /* eslint-disable @typescript-eslint/no-unused-vars */
4
- // import Debug from 'debug'
5
2
  Object.defineProperty(exports, "__esModule", { value: true });
6
3
  /* Nope debugger */
7
4
  const debuggerFunction = (_pattern, ..._args) => {
@@ -10,7 +7,6 @@ const debuggerFunction = (_pattern, ..._args) => {
10
7
  let debuggerFactory = (_namespace) => debuggerFunction;
11
8
  /* Try loading 'debug' module */
12
9
  try {
13
- // eslint-disable-next-line @typescript-eslint/no-var-requires
14
10
  const debugModule = require('debug');
15
11
  if (debugModule && (typeof debugModule === 'function'))
16
12
  debuggerFactory = debugModule;
package/lib/cjs/error.js CHANGED
@@ -1,5 +1,4 @@
1
1
  "use strict";
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
2
  Object.defineProperty(exports, "__esModule", { value: true });
4
3
  exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
5
4
  var ErrorType;
@@ -12,7 +11,6 @@ var ErrorType;
12
11
  })(ErrorType || (ErrorType = {}));
13
12
  exports.ErrorType = ErrorType;
14
13
  class SdkError extends Error {
15
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
16
14
  static isSdkError(error) {
17
15
  return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
18
16
  }
@@ -25,12 +23,11 @@ class SdkError extends Error {
25
23
  exports.SdkError = SdkError;
26
24
  SdkError.NAME = 'SdkError';
27
25
  class ApiError extends SdkError {
28
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
29
26
  static isApiError(error) {
30
27
  return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
31
28
  }
32
29
  constructor(error) {
33
- super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
30
+ super({ ...error, type: ErrorType.RESPONSE });
34
31
  this.errors = [];
35
32
  this.name = ApiError.NAME; // this.constructor.name
36
33
  }
@@ -2,6 +2,6 @@ export { default, CommerceLayer } from './commercelayer';
2
2
  export type { CommerceLayerClient } from './commercelayer';
3
3
  export { CommerceLayerStatic } from './static';
4
4
  export type { QueryParamsRetrieve, QueryParamsList, QueryParams } from './query';
5
- export * from './model';
5
+ export type * from './model';
6
6
  export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
7
7
  export type { SdkError, ApiError, ErrorType } from './error';
package/lib/cjs/index.js CHANGED
@@ -1,18 +1,4 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
17
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
18
4
  };
@@ -25,5 +11,3 @@ Object.defineProperty(exports, "CommerceLayer", { enumerable: true, get: functio
25
11
  // Commerce Layer static functions
26
12
  var static_1 = require("./static");
27
13
  Object.defineProperty(exports, "CommerceLayerStatic", { enumerable: true, get: function () { return static_1.CommerceLayerStatic; } });
28
- // Resource model types
29
- __exportStar(require("./model"), exports);
@@ -1,4 +1,4 @@
1
- import { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
1
+ import type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
2
2
  type InterceptorManager = {
3
3
  request: AxiosInterceptorManager<AxiosRequestConfig>;
4
4
  response: AxiosInterceptorManager<any>;
@@ -7,7 +7,11 @@ type RequestObj = AxiosRequestConfig;
7
7
  type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
8
8
  type ResponseObj = AxiosResponse;
9
9
  type ResponseInterceptor = (response: ResponseObj) => ResponseObj;
10
- type HeadersObj = AxiosResponseHeaders | RawAxiosResponseHeaders;
10
+ type ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period';
11
+ type ApiHeaders = {
12
+ [key in ApiHeadersList]: string | number | boolean;
13
+ };
14
+ type HeadersObj = (AxiosResponseHeaders | RawAxiosResponseHeaders) & ApiHeaders;
11
15
  type ErrorObj = AxiosError;
12
16
  type ErrorInterceptor = (error: ErrorObj) => ErrorObj;
13
17
  type InterceptorType = 'request' | 'response';
@@ -35,7 +35,11 @@ const denormalizeResource = (res, included) => {
35
35
  debug('denormalize resource: %O, %o', res, included || {});
36
36
  if (!res)
37
37
  return res;
38
- const resource = Object.assign({ id: res.id, type: res.type }, res.attributes);
38
+ const resource = {
39
+ id: res.id,
40
+ type: res.type,
41
+ ...res.attributes,
42
+ };
39
43
  if (res.relationships)
40
44
  Object.keys(res.relationships).forEach(key => {
41
45
  const rel = res.relationships[key].data;
@@ -106,6 +106,7 @@ export type { StockTransfer, StockTransferCreate, StockTransferUpdate } from './
106
106
  export type { StripeGateway, StripeGatewayCreate, StripeGatewayUpdate } from './resources/stripe_gateways';
107
107
  export type { StripePayment, StripePaymentCreate, StripePaymentUpdate } from './resources/stripe_payments';
108
108
  export type { SubscriptionModel, SubscriptionModelCreate, SubscriptionModelUpdate } from './resources/subscription_models';
109
+ export type { Tag, TagCreate, TagUpdate } from './resources/tags';
109
110
  export type { TaxCalculator } from './resources/tax_calculators';
110
111
  export type { TaxCategory, TaxCategoryCreate, TaxCategoryUpdate } from './resources/tax_categories';
111
112
  export type { TaxRule, TaxRuleCreate, TaxRuleUpdate } from './resources/tax_rules';
@@ -1,23 +1,17 @@
1
- import { ResourceType } from "./resource";
1
+ import type { ResourceType } from "./resource";
2
+ type QueryFilter = Record<string, string | number | boolean>;
2
3
  interface QueryParamsRetrieve {
3
4
  include?: string[];
4
- fields?: string[] | {
5
- [key: string]: string[];
6
- };
5
+ fields?: string[] | Record<string, string[]>;
7
6
  }
8
7
  interface QueryParamsList extends QueryParamsRetrieve {
9
- sort?: string[] | {
10
- [key: string]: 'asc' | 'desc';
11
- };
12
- filters?: {
13
- [key: string]: string | number | boolean;
14
- };
8
+ sort?: string[] | Record<string, 'asc' | 'desc'>;
9
+ filters?: QueryFilter;
15
10
  pageNumber?: number;
16
11
  pageSize?: number;
17
12
  }
18
13
  type QueryParams = QueryParamsRetrieve | QueryParamsList;
19
- export { QueryParamsRetrieve, QueryParamsList, QueryParams };
20
- declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => {
21
- [key: string]: string;
22
- };
23
- export { generateQueryStringParams };
14
+ export type { QueryParamsRetrieve, QueryParamsList, QueryParams, QueryFilter };
15
+ declare const isParamsList: (params: any) => params is QueryParamsList;
16
+ declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => Record<string, string>;
17
+ export { generateQueryStringParams, isParamsList };
package/lib/cjs/query.js CHANGED
@@ -3,12 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.generateQueryStringParams = void 0;
6
+ exports.isParamsList = exports.generateQueryStringParams = void 0;
7
7
  const debug_1 = __importDefault(require("./debug"));
8
8
  const debug = (0, debug_1.default)('query');
9
9
  const isParamsList = (params) => {
10
- return (params.filters || params.pageNumber || params.pageSize || params.sort);
10
+ return params && (params.filters || params.pageNumber || params.pageSize || params.sort);
11
11
  };
12
+ exports.isParamsList = isParamsList;
12
13
  const generateQueryStringParams = (params, res) => {
13
14
  debug('generate query string params: %O, %O', params, res);
14
15
  const qp = {};
@@ -1,38 +1,31 @@
1
- import { ApiClientInitConfig } from './client';
2
- import { QueryParamsRetrieve, QueryParamsList } from './query';
3
- import { ResourceTypeLock } from './api';
4
- import { InterceptorManager } from './interceptor';
5
- import { QueryParams } from '.';
1
+ import { type ApiClientInitConfig } from './client';
2
+ import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
3
+ import type { ResourceTypeLock } from './api';
4
+ import type { InterceptorManager } from './interceptor';
6
5
  type ResourceNull = {
7
6
  id: null;
8
7
  } & ResourceType;
9
8
  type ResourceRel = ResourceId | ResourceNull;
10
- type Metadata = {
11
- [key: string]: any;
12
- };
9
+ type Metadata = Record<string, any>;
13
10
  interface ResourceType {
14
11
  readonly type: ResourceTypeLock;
15
12
  }
16
13
  interface ResourceId extends ResourceType {
17
14
  readonly id: string;
18
15
  }
19
- interface Resource extends ResourceId {
20
- reference?: string;
21
- reference_origin?: string;
16
+ interface ResourceBase {
17
+ reference?: string | null;
18
+ reference_origin?: string | null;
22
19
  metadata?: Metadata;
20
+ }
21
+ interface Resource extends ResourceBase, ResourceId {
23
22
  readonly created_at: string;
24
23
  readonly updated_at: string;
25
24
  }
26
- interface ResourceCreate {
27
- reference?: string;
28
- reference_origin?: string;
29
- metadata?: Metadata;
25
+ interface ResourceCreate extends ResourceBase {
30
26
  }
31
- interface ResourceUpdate {
27
+ interface ResourceUpdate extends ResourceBase {
32
28
  readonly id: string;
33
- reference?: string;
34
- reference_origin?: string;
35
- metadata?: Metadata;
36
29
  }
37
30
  type ListMeta = {
38
31
  readonly pageCount: number;
@@ -46,8 +39,14 @@ declare class ListResponse<R> extends Array<R> {
46
39
  first(): R | undefined;
47
40
  last(): R | undefined;
48
41
  get(index: number): R | undefined;
42
+ hasNextPage(): boolean;
43
+ hasPrevPage(): boolean;
44
+ getRecordCount(): number;
45
+ getPageCount(): number;
46
+ get recordCount(): number;
47
+ get pageCount(): number;
49
48
  }
50
- export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ResourceRel };
49
+ export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ListMeta, ResourceRel };
51
50
  type ResourceAdapterConfig = {};
52
51
  type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
53
52
  type ResourcesConfig = Partial<ResourcesInitConfig>;
@@ -65,13 +64,22 @@ declare class ResourceAdapter {
65
64
  delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
66
65
  fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
67
66
  }
68
- declare abstract class ApiResource {
67
+ declare abstract class ApiResourceBase<R extends Resource> {
69
68
  static readonly TYPE: ResourceTypeLock;
70
- protected resources: ResourceAdapter;
69
+ protected readonly resources: ResourceAdapter;
71
70
  constructor(adapter: ResourceAdapter);
72
71
  abstract relationship(id: string | ResourceId | null): ResourceRel;
73
- abstract type(): string;
74
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Resource>;
72
+ abstract type(): ResourceTypeLock;
73
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
74
+ count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
75
+ }
76
+ declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
77
+ retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
78
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
79
+ }
80
+ declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
81
+ retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
75
82
  }
76
83
  export default ResourceAdapter;
77
- export { ApiResource, ResourcesConfig, ResourcesInitConfig };
84
+ export { ApiResource, ApiSingleton };
85
+ export type { ResourcesConfig, ResourcesInitConfig };