@commercelayer/sdk 4.42.0 → 4.45.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 (541) hide show
  1. package/lib/cjs/api.d.ts +3 -40
  2. package/lib/cjs/api.js +18 -8
  3. package/lib/cjs/client.d.ts +14 -20
  4. package/lib/cjs/client.js +43 -74
  5. package/lib/cjs/commercelayer.d.ts +7 -7
  6. package/lib/cjs/commercelayer.js +5 -14
  7. package/lib/cjs/common.d.ts +0 -1
  8. package/lib/cjs/common.js +2 -11
  9. package/lib/cjs/config.d.ts +0 -1
  10. package/lib/cjs/config.js +0 -3
  11. package/lib/cjs/debug.js +4 -0
  12. package/lib/cjs/error.d.ts +8 -11
  13. package/lib/cjs/error.js +8 -42
  14. package/lib/cjs/index.d.ts +1 -1
  15. package/lib/cjs/index.js +16 -0
  16. package/lib/cjs/interceptor.d.ts +2 -6
  17. package/lib/cjs/jsonapi.d.ts +0 -1
  18. package/lib/cjs/jsonapi.js +3 -10
  19. package/lib/cjs/model.d.ts +1 -0
  20. package/lib/cjs/query.d.ts +15 -9
  21. package/lib/cjs/query.js +2 -3
  22. package/lib/cjs/resource.d.ts +20 -31
  23. package/lib/cjs/resource.js +10 -56
  24. package/lib/cjs/resources/addresses.d.ts +73 -74
  25. package/lib/cjs/resources/addresses.js +11 -3
  26. package/lib/cjs/resources/adjustments.d.ts +19 -20
  27. package/lib/cjs/resources/adjustments.js +11 -3
  28. package/lib/cjs/resources/adyen_gateways.d.ts +34 -35
  29. package/lib/cjs/resources/adyen_gateways.js +11 -3
  30. package/lib/cjs/resources/adyen_payments.d.ts +27 -29
  31. package/lib/cjs/resources/adyen_payments.js +11 -6
  32. package/lib/cjs/resources/application.d.ts +13 -14
  33. package/lib/cjs/resources/application.js +6 -1
  34. package/lib/cjs/resources/attachments.d.ts +80 -81
  35. package/lib/cjs/resources/attachments.js +11 -3
  36. package/lib/cjs/resources/authorizations.d.ts +43 -47
  37. package/lib/cjs/resources/authorizations.js +9 -10
  38. package/lib/cjs/resources/avalara_accounts.d.ts +31 -32
  39. package/lib/cjs/resources/avalara_accounts.js +11 -3
  40. package/lib/cjs/resources/axerve_gateways.d.ts +23 -24
  41. package/lib/cjs/resources/axerve_gateways.js +11 -3
  42. package/lib/cjs/resources/axerve_payments.d.ts +32 -34
  43. package/lib/cjs/resources/axerve_payments.js +11 -6
  44. package/lib/cjs/resources/billing_info_validation_rules.d.ts +16 -17
  45. package/lib/cjs/resources/billing_info_validation_rules.js +11 -3
  46. package/lib/cjs/resources/bing_geocoders.d.ts +15 -16
  47. package/lib/cjs/resources/bing_geocoders.js +11 -3
  48. package/lib/cjs/resources/braintree_gateways.d.ts +33 -34
  49. package/lib/cjs/resources/braintree_gateways.js +11 -3
  50. package/lib/cjs/resources/braintree_payments.d.ts +29 -30
  51. package/lib/cjs/resources/braintree_payments.js +11 -3
  52. package/lib/cjs/resources/bundles.d.ts +56 -59
  53. package/lib/cjs/resources/bundles.js +11 -9
  54. package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +85 -98
  55. package/lib/cjs/resources/buy_x_pay_y_promotions.js +15 -13
  56. package/lib/cjs/resources/captures.d.ts +34 -37
  57. package/lib/cjs/resources/captures.js +9 -7
  58. package/lib/cjs/resources/carrier_accounts.d.ts +15 -16
  59. package/lib/cjs/resources/carrier_accounts.js +8 -0
  60. package/lib/cjs/resources/checkout_com_gateways.d.ts +24 -25
  61. package/lib/cjs/resources/checkout_com_gateways.js +11 -3
  62. package/lib/cjs/resources/checkout_com_payments.d.ts +38 -41
  63. package/lib/cjs/resources/checkout_com_payments.js +11 -9
  64. package/lib/cjs/resources/cleanups.d.ts +23 -24
  65. package/lib/cjs/resources/cleanups.js +10 -2
  66. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +32 -33
  67. package/lib/cjs/resources/coupon_codes_promotion_rules.js +11 -3
  68. package/lib/cjs/resources/coupon_recipients.d.ts +25 -26
  69. package/lib/cjs/resources/coupon_recipients.js +11 -3
  70. package/lib/cjs/resources/coupons.d.ts +41 -42
  71. package/lib/cjs/resources/coupons.js +11 -3
  72. package/lib/cjs/resources/custom_promotion_rules.d.ts +30 -31
  73. package/lib/cjs/resources/custom_promotion_rules.js +11 -3
  74. package/lib/cjs/resources/customer_addresses.d.ts +22 -23
  75. package/lib/cjs/resources/customer_addresses.js +11 -3
  76. package/lib/cjs/resources/customer_groups.d.ts +16 -17
  77. package/lib/cjs/resources/customer_groups.js +11 -3
  78. package/lib/cjs/resources/customer_password_resets.d.ts +17 -19
  79. package/lib/cjs/resources/customer_password_resets.js +11 -6
  80. package/lib/cjs/resources/customer_payment_sources.d.ts +46 -47
  81. package/lib/cjs/resources/customer_payment_sources.js +11 -3
  82. package/lib/cjs/resources/customer_subscriptions.d.ts +14 -15
  83. package/lib/cjs/resources/customer_subscriptions.js +11 -3
  84. package/lib/cjs/resources/customers.d.ts +36 -37
  85. package/lib/cjs/resources/customers.js +11 -3
  86. package/lib/cjs/resources/delivery_lead_times.d.ts +26 -27
  87. package/lib/cjs/resources/delivery_lead_times.js +11 -3
  88. package/lib/cjs/resources/event_callbacks.d.ts +14 -15
  89. package/lib/cjs/resources/event_callbacks.js +8 -0
  90. package/lib/cjs/resources/events.d.ts +12 -13
  91. package/lib/cjs/resources/events.js +8 -0
  92. package/lib/cjs/resources/exports.d.ts +26 -27
  93. package/lib/cjs/resources/exports.js +10 -2
  94. package/lib/cjs/resources/external_gateways.d.ts +31 -32
  95. package/lib/cjs/resources/external_gateways.js +11 -3
  96. package/lib/cjs/resources/external_payments.d.ts +22 -23
  97. package/lib/cjs/resources/external_payments.js +11 -3
  98. package/lib/cjs/resources/external_promotions.d.ts +82 -95
  99. package/lib/cjs/resources/external_promotions.js +15 -13
  100. package/lib/cjs/resources/external_tax_calculators.d.ts +18 -19
  101. package/lib/cjs/resources/external_tax_calculators.js +11 -3
  102. package/lib/cjs/resources/fixed_amount_promotions.d.ts +83 -96
  103. package/lib/cjs/resources/fixed_amount_promotions.js +15 -13
  104. package/lib/cjs/resources/fixed_price_promotions.d.ts +82 -95
  105. package/lib/cjs/resources/fixed_price_promotions.js +15 -13
  106. package/lib/cjs/resources/free_gift_promotions.d.ts +81 -94
  107. package/lib/cjs/resources/free_gift_promotions.js +15 -13
  108. package/lib/cjs/resources/free_shipping_promotions.d.ts +78 -86
  109. package/lib/cjs/resources/free_shipping_promotions.js +15 -13
  110. package/lib/cjs/resources/geocoders.d.ts +12 -13
  111. package/lib/cjs/resources/geocoders.js +8 -0
  112. package/lib/cjs/resources/gift_card_recipients.d.ts +25 -26
  113. package/lib/cjs/resources/gift_card_recipients.js +11 -3
  114. package/lib/cjs/resources/gift_cards.d.ts +69 -71
  115. package/lib/cjs/resources/gift_cards.js +11 -15
  116. package/lib/cjs/resources/google_geocoders.d.ts +15 -16
  117. package/lib/cjs/resources/google_geocoders.js +11 -3
  118. package/lib/cjs/resources/imports.d.ts +29 -30
  119. package/lib/cjs/resources/imports.js +10 -2
  120. package/lib/cjs/resources/in_stock_subscriptions.d.ts +35 -38
  121. package/lib/cjs/resources/in_stock_subscriptions.js +11 -9
  122. package/lib/cjs/resources/inventory_models.d.ts +31 -32
  123. package/lib/cjs/resources/inventory_models.js +11 -3
  124. package/lib/cjs/resources/inventory_return_locations.d.ts +21 -22
  125. package/lib/cjs/resources/inventory_return_locations.js +11 -3
  126. package/lib/cjs/resources/inventory_stock_locations.d.ts +24 -25
  127. package/lib/cjs/resources/inventory_stock_locations.js +11 -3
  128. package/lib/cjs/resources/klarna_gateways.d.ts +22 -23
  129. package/lib/cjs/resources/klarna_gateways.js +11 -3
  130. package/lib/cjs/resources/klarna_payments.d.ts +27 -29
  131. package/lib/cjs/resources/klarna_payments.js +11 -6
  132. package/lib/cjs/resources/line_item_options.d.ts +40 -41
  133. package/lib/cjs/resources/line_item_options.js +11 -3
  134. package/lib/cjs/resources/line_items.d.ts +101 -104
  135. package/lib/cjs/resources/line_items.js +11 -9
  136. package/lib/cjs/resources/manual_gateways.d.ts +14 -15
  137. package/lib/cjs/resources/manual_gateways.js +11 -3
  138. package/lib/cjs/resources/manual_tax_calculators.d.ts +20 -21
  139. package/lib/cjs/resources/manual_tax_calculators.js +11 -3
  140. package/lib/cjs/resources/markets.d.ts +64 -67
  141. package/lib/cjs/resources/markets.js +11 -9
  142. package/lib/cjs/resources/merchants.d.ts +18 -19
  143. package/lib/cjs/resources/merchants.js +11 -3
  144. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +35 -36
  145. package/lib/cjs/resources/order_amount_promotion_rules.js +11 -3
  146. package/lib/cjs/resources/order_copies.d.ts +28 -29
  147. package/lib/cjs/resources/order_copies.js +11 -3
  148. package/lib/cjs/resources/order_factories.d.ts +20 -21
  149. package/lib/cjs/resources/order_factories.js +8 -0
  150. package/lib/cjs/resources/order_subscription_items.d.ts +39 -40
  151. package/lib/cjs/resources/order_subscription_items.js +11 -3
  152. package/lib/cjs/resources/order_subscriptions.d.ts +52 -55
  153. package/lib/cjs/resources/order_subscriptions.js +11 -12
  154. package/lib/cjs/resources/order_validation_rules.d.ts +12 -13
  155. package/lib/cjs/resources/order_validation_rules.js +8 -0
  156. package/lib/cjs/resources/orders.d.ts +260 -280
  157. package/lib/cjs/resources/orders.js +15 -84
  158. package/lib/cjs/resources/organization.d.ts +24 -25
  159. package/lib/cjs/resources/organization.js +6 -1
  160. package/lib/cjs/resources/packages.d.ts +30 -31
  161. package/lib/cjs/resources/packages.js +11 -3
  162. package/lib/cjs/resources/parcel_line_items.d.ts +22 -23
  163. package/lib/cjs/resources/parcel_line_items.js +11 -3
  164. package/lib/cjs/resources/parcels.d.ts +93 -94
  165. package/lib/cjs/resources/parcels.js +11 -3
  166. package/lib/cjs/resources/payment_gateways.d.ts +12 -13
  167. package/lib/cjs/resources/payment_gateways.js +8 -0
  168. package/lib/cjs/resources/payment_methods.d.ts +54 -54
  169. package/lib/cjs/resources/payment_methods.js +11 -9
  170. package/lib/cjs/resources/payment_options.d.ts +23 -24
  171. package/lib/cjs/resources/payment_options.js +11 -3
  172. package/lib/cjs/resources/paypal_gateways.d.ts +17 -18
  173. package/lib/cjs/resources/paypal_gateways.js +11 -3
  174. package/lib/cjs/resources/paypal_payments.d.ts +31 -32
  175. package/lib/cjs/resources/paypal_payments.js +11 -3
  176. package/lib/cjs/resources/percentage_discount_promotions.d.ts +81 -94
  177. package/lib/cjs/resources/percentage_discount_promotions.js +15 -13
  178. package/lib/cjs/resources/price_frequency_tiers.d.ts +26 -27
  179. package/lib/cjs/resources/price_frequency_tiers.js +11 -3
  180. package/lib/cjs/resources/price_lists.d.ts +23 -24
  181. package/lib/cjs/resources/price_lists.js +11 -3
  182. package/lib/cjs/resources/price_tiers.d.ts +17 -18
  183. package/lib/cjs/resources/price_tiers.js +8 -0
  184. package/lib/cjs/resources/price_volume_tiers.d.ts +26 -27
  185. package/lib/cjs/resources/price_volume_tiers.js +11 -3
  186. package/lib/cjs/resources/prices.d.ts +40 -41
  187. package/lib/cjs/resources/prices.js +11 -3
  188. package/lib/cjs/resources/promotion_rules.d.ts +11 -12
  189. package/lib/cjs/resources/promotion_rules.js +8 -0
  190. package/lib/cjs/resources/promotions.d.ts +33 -34
  191. package/lib/cjs/resources/promotions.js +12 -4
  192. package/lib/cjs/resources/recurring_order_copies.d.ts +28 -29
  193. package/lib/cjs/resources/recurring_order_copies.js +11 -3
  194. package/lib/cjs/resources/refunds.d.ts +25 -26
  195. package/lib/cjs/resources/refunds.js +8 -0
  196. package/lib/cjs/resources/reserved_stocks.d.ts +13 -14
  197. package/lib/cjs/resources/reserved_stocks.js +8 -0
  198. package/lib/cjs/resources/resource_errors.d.ts +22 -0
  199. package/lib/cjs/resources/resource_errors.js +24 -0
  200. package/lib/cjs/resources/return_line_items.d.ts +27 -29
  201. package/lib/cjs/resources/return_line_items.js +11 -6
  202. package/lib/cjs/resources/returns.d.ts +49 -59
  203. package/lib/cjs/resources/returns.js +11 -30
  204. package/lib/cjs/resources/satispay_gateways.d.ts +22 -23
  205. package/lib/cjs/resources/satispay_gateways.js +11 -3
  206. package/lib/cjs/resources/satispay_payments.d.ts +29 -31
  207. package/lib/cjs/resources/satispay_payments.js +11 -6
  208. package/lib/cjs/resources/shipments.d.ts +82 -94
  209. package/lib/cjs/resources/shipments.js +11 -36
  210. package/lib/cjs/resources/shipping_categories.d.ts +18 -19
  211. package/lib/cjs/resources/shipping_categories.js +11 -3
  212. package/lib/cjs/resources/shipping_method_tiers.d.ts +17 -18
  213. package/lib/cjs/resources/shipping_method_tiers.js +8 -0
  214. package/lib/cjs/resources/shipping_methods.d.ts +79 -82
  215. package/lib/cjs/resources/shipping_methods.js +11 -9
  216. package/lib/cjs/resources/shipping_weight_tiers.d.ts +25 -26
  217. package/lib/cjs/resources/shipping_weight_tiers.js +11 -3
  218. package/lib/cjs/resources/shipping_zones.d.ts +32 -33
  219. package/lib/cjs/resources/shipping_zones.js +11 -3
  220. package/lib/cjs/resources/sku_list_items.d.ts +26 -27
  221. package/lib/cjs/resources/sku_list_items.js +11 -3
  222. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +39 -40
  223. package/lib/cjs/resources/sku_list_promotion_rules.js +11 -3
  224. package/lib/cjs/resources/sku_lists.d.ts +35 -36
  225. package/lib/cjs/resources/sku_lists.js +11 -3
  226. package/lib/cjs/resources/sku_options.d.ts +43 -44
  227. package/lib/cjs/resources/sku_options.js +11 -3
  228. package/lib/cjs/resources/skus.d.ts +56 -57
  229. package/lib/cjs/resources/skus.js +11 -3
  230. package/lib/cjs/resources/stock_items.d.ts +28 -29
  231. package/lib/cjs/resources/stock_items.js +11 -3
  232. package/lib/cjs/resources/stock_line_items.d.ts +40 -44
  233. package/lib/cjs/resources/stock_line_items.js +11 -12
  234. package/lib/cjs/resources/stock_locations.d.ts +32 -33
  235. package/lib/cjs/resources/stock_locations.js +11 -3
  236. package/lib/cjs/resources/stock_reservations.d.ts +22 -24
  237. package/lib/cjs/resources/stock_reservations.js +11 -6
  238. package/lib/cjs/resources/stock_transfers.d.ts +44 -51
  239. package/lib/cjs/resources/stock_transfers.js +11 -21
  240. package/lib/cjs/resources/stripe_gateways.d.ts +22 -23
  241. package/lib/cjs/resources/stripe_gateways.js +11 -3
  242. package/lib/cjs/resources/stripe_payments.d.ts +37 -37
  243. package/lib/cjs/resources/stripe_payments.js +11 -9
  244. package/lib/cjs/resources/subscription_models.d.ts +26 -27
  245. package/lib/cjs/resources/subscription_models.js +11 -3
  246. package/lib/cjs/resources/tags.d.ts +12 -13
  247. package/lib/cjs/resources/tags.js +11 -3
  248. package/lib/cjs/resources/tax_calculators.d.ts +13 -14
  249. package/lib/cjs/resources/tax_calculators.js +8 -0
  250. package/lib/cjs/resources/tax_categories.d.ts +30 -31
  251. package/lib/cjs/resources/tax_categories.js +11 -3
  252. package/lib/cjs/resources/tax_rules.d.ts +51 -52
  253. package/lib/cjs/resources/tax_rules.js +11 -3
  254. package/lib/cjs/resources/taxjar_accounts.d.ts +21 -22
  255. package/lib/cjs/resources/taxjar_accounts.js +11 -3
  256. package/lib/cjs/resources/transactions.d.ts +24 -25
  257. package/lib/cjs/resources/transactions.js +8 -0
  258. package/lib/cjs/resources/versions.d.ts +14 -14
  259. package/lib/cjs/resources/versions.js +8 -0
  260. package/lib/cjs/resources/voids.d.ts +25 -26
  261. package/lib/cjs/resources/voids.js +8 -0
  262. package/lib/cjs/resources/webhooks.d.ts +31 -35
  263. package/lib/cjs/resources/webhooks.js +11 -12
  264. package/lib/cjs/resources/wire_transfers.d.ts +16 -17
  265. package/lib/cjs/resources/wire_transfers.js +11 -3
  266. package/lib/cjs/static.d.ts +2 -5
  267. package/lib/cjs/static.js +2 -8
  268. package/lib/cjs/util.d.ts +4 -2
  269. package/lib/cjs/util.js +0 -1
  270. package/lib/esm/api.d.ts +3 -40
  271. package/lib/esm/api.js +15 -6
  272. package/lib/esm/client.d.ts +14 -20
  273. package/lib/esm/client.js +44 -75
  274. package/lib/esm/commercelayer.d.ts +7 -7
  275. package/lib/esm/commercelayer.js +5 -14
  276. package/lib/esm/common.d.ts +0 -1
  277. package/lib/esm/common.js +2 -11
  278. package/lib/esm/config.d.ts +0 -1
  279. package/lib/esm/config.js +0 -3
  280. package/lib/esm/debug.js +4 -0
  281. package/lib/esm/error.d.ts +8 -11
  282. package/lib/esm/error.js +6 -37
  283. package/lib/esm/index.d.ts +1 -1
  284. package/lib/esm/index.js +2 -0
  285. package/lib/esm/interceptor.d.ts +2 -6
  286. package/lib/esm/jsonapi.d.ts +0 -1
  287. package/lib/esm/jsonapi.js +3 -10
  288. package/lib/esm/model.d.ts +1 -0
  289. package/lib/esm/query.d.ts +15 -9
  290. package/lib/esm/query.js +2 -2
  291. package/lib/esm/resource.d.ts +20 -31
  292. package/lib/esm/resource.js +11 -56
  293. package/lib/esm/resources/addresses.d.ts +73 -74
  294. package/lib/esm/resources/addresses.js +11 -3
  295. package/lib/esm/resources/adjustments.d.ts +19 -20
  296. package/lib/esm/resources/adjustments.js +11 -3
  297. package/lib/esm/resources/adyen_gateways.d.ts +34 -35
  298. package/lib/esm/resources/adyen_gateways.js +11 -3
  299. package/lib/esm/resources/adyen_payments.d.ts +27 -29
  300. package/lib/esm/resources/adyen_payments.js +11 -6
  301. package/lib/esm/resources/application.d.ts +13 -14
  302. package/lib/esm/resources/application.js +7 -2
  303. package/lib/esm/resources/attachments.d.ts +80 -81
  304. package/lib/esm/resources/attachments.js +11 -3
  305. package/lib/esm/resources/authorizations.d.ts +43 -47
  306. package/lib/esm/resources/authorizations.js +9 -10
  307. package/lib/esm/resources/avalara_accounts.d.ts +31 -32
  308. package/lib/esm/resources/avalara_accounts.js +11 -3
  309. package/lib/esm/resources/axerve_gateways.d.ts +23 -24
  310. package/lib/esm/resources/axerve_gateways.js +11 -3
  311. package/lib/esm/resources/axerve_payments.d.ts +32 -34
  312. package/lib/esm/resources/axerve_payments.js +11 -6
  313. package/lib/esm/resources/billing_info_validation_rules.d.ts +16 -17
  314. package/lib/esm/resources/billing_info_validation_rules.js +11 -3
  315. package/lib/esm/resources/bing_geocoders.d.ts +15 -16
  316. package/lib/esm/resources/bing_geocoders.js +11 -3
  317. package/lib/esm/resources/braintree_gateways.d.ts +33 -34
  318. package/lib/esm/resources/braintree_gateways.js +11 -3
  319. package/lib/esm/resources/braintree_payments.d.ts +29 -30
  320. package/lib/esm/resources/braintree_payments.js +11 -3
  321. package/lib/esm/resources/bundles.d.ts +56 -59
  322. package/lib/esm/resources/bundles.js +11 -9
  323. package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +85 -98
  324. package/lib/esm/resources/buy_x_pay_y_promotions.js +15 -13
  325. package/lib/esm/resources/captures.d.ts +34 -37
  326. package/lib/esm/resources/captures.js +9 -7
  327. package/lib/esm/resources/carrier_accounts.d.ts +15 -16
  328. package/lib/esm/resources/carrier_accounts.js +8 -0
  329. package/lib/esm/resources/checkout_com_gateways.d.ts +24 -25
  330. package/lib/esm/resources/checkout_com_gateways.js +11 -3
  331. package/lib/esm/resources/checkout_com_payments.d.ts +38 -41
  332. package/lib/esm/resources/checkout_com_payments.js +11 -9
  333. package/lib/esm/resources/cleanups.d.ts +23 -24
  334. package/lib/esm/resources/cleanups.js +10 -2
  335. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +32 -33
  336. package/lib/esm/resources/coupon_codes_promotion_rules.js +11 -3
  337. package/lib/esm/resources/coupon_recipients.d.ts +25 -26
  338. package/lib/esm/resources/coupon_recipients.js +11 -3
  339. package/lib/esm/resources/coupons.d.ts +41 -42
  340. package/lib/esm/resources/coupons.js +11 -3
  341. package/lib/esm/resources/custom_promotion_rules.d.ts +30 -31
  342. package/lib/esm/resources/custom_promotion_rules.js +11 -3
  343. package/lib/esm/resources/customer_addresses.d.ts +22 -23
  344. package/lib/esm/resources/customer_addresses.js +11 -3
  345. package/lib/esm/resources/customer_groups.d.ts +16 -17
  346. package/lib/esm/resources/customer_groups.js +11 -3
  347. package/lib/esm/resources/customer_password_resets.d.ts +17 -19
  348. package/lib/esm/resources/customer_password_resets.js +11 -6
  349. package/lib/esm/resources/customer_payment_sources.d.ts +46 -47
  350. package/lib/esm/resources/customer_payment_sources.js +11 -3
  351. package/lib/esm/resources/customer_subscriptions.d.ts +14 -15
  352. package/lib/esm/resources/customer_subscriptions.js +11 -3
  353. package/lib/esm/resources/customers.d.ts +36 -37
  354. package/lib/esm/resources/customers.js +11 -3
  355. package/lib/esm/resources/delivery_lead_times.d.ts +26 -27
  356. package/lib/esm/resources/delivery_lead_times.js +11 -3
  357. package/lib/esm/resources/event_callbacks.d.ts +14 -15
  358. package/lib/esm/resources/event_callbacks.js +8 -0
  359. package/lib/esm/resources/events.d.ts +12 -13
  360. package/lib/esm/resources/events.js +8 -0
  361. package/lib/esm/resources/exports.d.ts +26 -27
  362. package/lib/esm/resources/exports.js +10 -2
  363. package/lib/esm/resources/external_gateways.d.ts +31 -32
  364. package/lib/esm/resources/external_gateways.js +11 -3
  365. package/lib/esm/resources/external_payments.d.ts +22 -23
  366. package/lib/esm/resources/external_payments.js +11 -3
  367. package/lib/esm/resources/external_promotions.d.ts +82 -95
  368. package/lib/esm/resources/external_promotions.js +15 -13
  369. package/lib/esm/resources/external_tax_calculators.d.ts +18 -19
  370. package/lib/esm/resources/external_tax_calculators.js +11 -3
  371. package/lib/esm/resources/fixed_amount_promotions.d.ts +83 -96
  372. package/lib/esm/resources/fixed_amount_promotions.js +15 -13
  373. package/lib/esm/resources/fixed_price_promotions.d.ts +82 -95
  374. package/lib/esm/resources/fixed_price_promotions.js +15 -13
  375. package/lib/esm/resources/free_gift_promotions.d.ts +81 -94
  376. package/lib/esm/resources/free_gift_promotions.js +15 -13
  377. package/lib/esm/resources/free_shipping_promotions.d.ts +78 -86
  378. package/lib/esm/resources/free_shipping_promotions.js +15 -13
  379. package/lib/esm/resources/geocoders.d.ts +12 -13
  380. package/lib/esm/resources/geocoders.js +8 -0
  381. package/lib/esm/resources/gift_card_recipients.d.ts +25 -26
  382. package/lib/esm/resources/gift_card_recipients.js +11 -3
  383. package/lib/esm/resources/gift_cards.d.ts +69 -71
  384. package/lib/esm/resources/gift_cards.js +11 -15
  385. package/lib/esm/resources/google_geocoders.d.ts +15 -16
  386. package/lib/esm/resources/google_geocoders.js +11 -3
  387. package/lib/esm/resources/imports.d.ts +29 -30
  388. package/lib/esm/resources/imports.js +10 -2
  389. package/lib/esm/resources/in_stock_subscriptions.d.ts +35 -38
  390. package/lib/esm/resources/in_stock_subscriptions.js +11 -9
  391. package/lib/esm/resources/inventory_models.d.ts +31 -32
  392. package/lib/esm/resources/inventory_models.js +11 -3
  393. package/lib/esm/resources/inventory_return_locations.d.ts +21 -22
  394. package/lib/esm/resources/inventory_return_locations.js +11 -3
  395. package/lib/esm/resources/inventory_stock_locations.d.ts +24 -25
  396. package/lib/esm/resources/inventory_stock_locations.js +11 -3
  397. package/lib/esm/resources/klarna_gateways.d.ts +22 -23
  398. package/lib/esm/resources/klarna_gateways.js +11 -3
  399. package/lib/esm/resources/klarna_payments.d.ts +27 -29
  400. package/lib/esm/resources/klarna_payments.js +11 -6
  401. package/lib/esm/resources/line_item_options.d.ts +40 -41
  402. package/lib/esm/resources/line_item_options.js +11 -3
  403. package/lib/esm/resources/line_items.d.ts +101 -104
  404. package/lib/esm/resources/line_items.js +11 -9
  405. package/lib/esm/resources/manual_gateways.d.ts +14 -15
  406. package/lib/esm/resources/manual_gateways.js +11 -3
  407. package/lib/esm/resources/manual_tax_calculators.d.ts +20 -21
  408. package/lib/esm/resources/manual_tax_calculators.js +11 -3
  409. package/lib/esm/resources/markets.d.ts +64 -67
  410. package/lib/esm/resources/markets.js +11 -9
  411. package/lib/esm/resources/merchants.d.ts +18 -19
  412. package/lib/esm/resources/merchants.js +11 -3
  413. package/lib/esm/resources/order_amount_promotion_rules.d.ts +35 -36
  414. package/lib/esm/resources/order_amount_promotion_rules.js +11 -3
  415. package/lib/esm/resources/order_copies.d.ts +28 -29
  416. package/lib/esm/resources/order_copies.js +11 -3
  417. package/lib/esm/resources/order_factories.d.ts +20 -21
  418. package/lib/esm/resources/order_factories.js +8 -0
  419. package/lib/esm/resources/order_subscription_items.d.ts +39 -40
  420. package/lib/esm/resources/order_subscription_items.js +11 -3
  421. package/lib/esm/resources/order_subscriptions.d.ts +52 -55
  422. package/lib/esm/resources/order_subscriptions.js +11 -12
  423. package/lib/esm/resources/order_validation_rules.d.ts +12 -13
  424. package/lib/esm/resources/order_validation_rules.js +8 -0
  425. package/lib/esm/resources/orders.d.ts +260 -280
  426. package/lib/esm/resources/orders.js +15 -84
  427. package/lib/esm/resources/organization.d.ts +24 -25
  428. package/lib/esm/resources/organization.js +7 -2
  429. package/lib/esm/resources/packages.d.ts +30 -31
  430. package/lib/esm/resources/packages.js +11 -3
  431. package/lib/esm/resources/parcel_line_items.d.ts +22 -23
  432. package/lib/esm/resources/parcel_line_items.js +11 -3
  433. package/lib/esm/resources/parcels.d.ts +93 -94
  434. package/lib/esm/resources/parcels.js +11 -3
  435. package/lib/esm/resources/payment_gateways.d.ts +12 -13
  436. package/lib/esm/resources/payment_gateways.js +8 -0
  437. package/lib/esm/resources/payment_methods.d.ts +54 -54
  438. package/lib/esm/resources/payment_methods.js +11 -9
  439. package/lib/esm/resources/payment_options.d.ts +23 -24
  440. package/lib/esm/resources/payment_options.js +11 -3
  441. package/lib/esm/resources/paypal_gateways.d.ts +17 -18
  442. package/lib/esm/resources/paypal_gateways.js +11 -3
  443. package/lib/esm/resources/paypal_payments.d.ts +31 -32
  444. package/lib/esm/resources/paypal_payments.js +11 -3
  445. package/lib/esm/resources/percentage_discount_promotions.d.ts +81 -94
  446. package/lib/esm/resources/percentage_discount_promotions.js +15 -13
  447. package/lib/esm/resources/price_frequency_tiers.d.ts +26 -27
  448. package/lib/esm/resources/price_frequency_tiers.js +11 -3
  449. package/lib/esm/resources/price_lists.d.ts +23 -24
  450. package/lib/esm/resources/price_lists.js +11 -3
  451. package/lib/esm/resources/price_tiers.d.ts +17 -18
  452. package/lib/esm/resources/price_tiers.js +8 -0
  453. package/lib/esm/resources/price_volume_tiers.d.ts +26 -27
  454. package/lib/esm/resources/price_volume_tiers.js +11 -3
  455. package/lib/esm/resources/prices.d.ts +40 -41
  456. package/lib/esm/resources/prices.js +11 -3
  457. package/lib/esm/resources/promotion_rules.d.ts +11 -12
  458. package/lib/esm/resources/promotion_rules.js +8 -0
  459. package/lib/esm/resources/promotions.d.ts +33 -34
  460. package/lib/esm/resources/promotions.js +12 -4
  461. package/lib/esm/resources/recurring_order_copies.d.ts +28 -29
  462. package/lib/esm/resources/recurring_order_copies.js +11 -3
  463. package/lib/esm/resources/refunds.d.ts +25 -26
  464. package/lib/esm/resources/refunds.js +8 -0
  465. package/lib/esm/resources/reserved_stocks.d.ts +13 -14
  466. package/lib/esm/resources/reserved_stocks.js +8 -0
  467. package/lib/esm/resources/resource_errors.d.ts +22 -0
  468. package/lib/esm/resources/resource_errors.js +22 -0
  469. package/lib/esm/resources/return_line_items.d.ts +27 -29
  470. package/lib/esm/resources/return_line_items.js +11 -6
  471. package/lib/esm/resources/returns.d.ts +49 -59
  472. package/lib/esm/resources/returns.js +11 -30
  473. package/lib/esm/resources/satispay_gateways.d.ts +22 -23
  474. package/lib/esm/resources/satispay_gateways.js +11 -3
  475. package/lib/esm/resources/satispay_payments.d.ts +29 -31
  476. package/lib/esm/resources/satispay_payments.js +11 -6
  477. package/lib/esm/resources/shipments.d.ts +82 -94
  478. package/lib/esm/resources/shipments.js +11 -36
  479. package/lib/esm/resources/shipping_categories.d.ts +18 -19
  480. package/lib/esm/resources/shipping_categories.js +11 -3
  481. package/lib/esm/resources/shipping_method_tiers.d.ts +17 -18
  482. package/lib/esm/resources/shipping_method_tiers.js +8 -0
  483. package/lib/esm/resources/shipping_methods.d.ts +79 -82
  484. package/lib/esm/resources/shipping_methods.js +11 -9
  485. package/lib/esm/resources/shipping_weight_tiers.d.ts +25 -26
  486. package/lib/esm/resources/shipping_weight_tiers.js +11 -3
  487. package/lib/esm/resources/shipping_zones.d.ts +32 -33
  488. package/lib/esm/resources/shipping_zones.js +11 -3
  489. package/lib/esm/resources/sku_list_items.d.ts +26 -27
  490. package/lib/esm/resources/sku_list_items.js +11 -3
  491. package/lib/esm/resources/sku_list_promotion_rules.d.ts +39 -40
  492. package/lib/esm/resources/sku_list_promotion_rules.js +11 -3
  493. package/lib/esm/resources/sku_lists.d.ts +35 -36
  494. package/lib/esm/resources/sku_lists.js +11 -3
  495. package/lib/esm/resources/sku_options.d.ts +43 -44
  496. package/lib/esm/resources/sku_options.js +11 -3
  497. package/lib/esm/resources/skus.d.ts +56 -57
  498. package/lib/esm/resources/skus.js +11 -3
  499. package/lib/esm/resources/stock_items.d.ts +28 -29
  500. package/lib/esm/resources/stock_items.js +11 -3
  501. package/lib/esm/resources/stock_line_items.d.ts +40 -44
  502. package/lib/esm/resources/stock_line_items.js +11 -12
  503. package/lib/esm/resources/stock_locations.d.ts +32 -33
  504. package/lib/esm/resources/stock_locations.js +11 -3
  505. package/lib/esm/resources/stock_reservations.d.ts +22 -24
  506. package/lib/esm/resources/stock_reservations.js +11 -6
  507. package/lib/esm/resources/stock_transfers.d.ts +44 -51
  508. package/lib/esm/resources/stock_transfers.js +11 -21
  509. package/lib/esm/resources/stripe_gateways.d.ts +22 -23
  510. package/lib/esm/resources/stripe_gateways.js +11 -3
  511. package/lib/esm/resources/stripe_payments.d.ts +37 -37
  512. package/lib/esm/resources/stripe_payments.js +11 -9
  513. package/lib/esm/resources/subscription_models.d.ts +26 -27
  514. package/lib/esm/resources/subscription_models.js +11 -3
  515. package/lib/esm/resources/tags.d.ts +12 -13
  516. package/lib/esm/resources/tags.js +11 -3
  517. package/lib/esm/resources/tax_calculators.d.ts +13 -14
  518. package/lib/esm/resources/tax_calculators.js +8 -0
  519. package/lib/esm/resources/tax_categories.d.ts +30 -31
  520. package/lib/esm/resources/tax_categories.js +11 -3
  521. package/lib/esm/resources/tax_rules.d.ts +51 -52
  522. package/lib/esm/resources/tax_rules.js +11 -3
  523. package/lib/esm/resources/taxjar_accounts.d.ts +21 -22
  524. package/lib/esm/resources/taxjar_accounts.js +11 -3
  525. package/lib/esm/resources/transactions.d.ts +24 -25
  526. package/lib/esm/resources/transactions.js +8 -0
  527. package/lib/esm/resources/versions.d.ts +14 -14
  528. package/lib/esm/resources/versions.js +8 -0
  529. package/lib/esm/resources/voids.d.ts +25 -26
  530. package/lib/esm/resources/voids.js +8 -0
  531. package/lib/esm/resources/webhooks.d.ts +31 -35
  532. package/lib/esm/resources/webhooks.js +11 -12
  533. package/lib/esm/resources/wire_transfers.d.ts +16 -17
  534. package/lib/esm/resources/wire_transfers.js +11 -3
  535. package/lib/esm/static.d.ts +2 -5
  536. package/lib/esm/static.js +2 -8
  537. package/lib/esm/util.d.ts +4 -2
  538. package/lib/esm/util.js +1 -27
  539. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  540. package/lib/tsconfig.tsbuildinfo +1 -1
  541. package/package.json +19 -19
package/lib/cjs/error.js CHANGED
@@ -1,20 +1,18 @@
1
1
  "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
2
+ /* eslint-disable @typescript-eslint/no-explicit-any */
5
3
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.handleError = exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
7
- const axios_1 = __importDefault(require("axios"));
4
+ exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
8
5
  var ErrorType;
9
6
  (function (ErrorType) {
10
7
  ErrorType["CLIENT"] = "client";
11
8
  ErrorType["REQUEST"] = "request";
12
9
  ErrorType["RESPONSE"] = "response";
13
- ErrorType["CANCEL"] = "cancel";
14
- ErrorType["PARSE"] = "parse";
15
10
  ErrorType["GENERIC"] = "generic";
16
- })(ErrorType || (exports.ErrorType = ErrorType = {}));
11
+ ErrorType["CANCEL"] = "cancel";
12
+ })(ErrorType || (ErrorType = {}));
13
+ exports.ErrorType = ErrorType;
17
14
  class SdkError extends Error {
15
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
18
16
  static isSdkError(error) {
19
17
  return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
20
18
  }
@@ -27,11 +25,12 @@ class SdkError extends Error {
27
25
  exports.SdkError = SdkError;
28
26
  SdkError.NAME = 'SdkError';
29
27
  class ApiError extends SdkError {
28
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
30
29
  static isApiError(error) {
31
30
  return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
32
31
  }
33
32
  constructor(error) {
34
- super({ ...error, type: ErrorType.RESPONSE });
33
+ super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
35
34
  this.errors = [];
36
35
  this.name = ApiError.NAME; // this.constructor.name
37
36
  }
@@ -42,36 +41,3 @@ class ApiError extends SdkError {
42
41
  }
43
42
  exports.ApiError = ApiError;
44
43
  ApiError.NAME = 'ApiError';
45
- const handleError = (error) => {
46
- let sdkError = new SdkError({ message: error.message });
47
- if (axios_1.default.isAxiosError(error)) {
48
- if (error.response) {
49
- // The request was made and the server responded with a status code that falls out of the range of 2xx
50
- const apiError = new ApiError(sdkError);
51
- apiError.type = ErrorType.RESPONSE;
52
- apiError.status = error.response.status;
53
- apiError.statusText = error.response.statusText;
54
- apiError.code = String(apiError.status);
55
- apiError.errors = error.response.data.errors;
56
- if (!apiError.message && apiError.statusText)
57
- apiError.message = apiError.statusText;
58
- sdkError = apiError;
59
- }
60
- else if (error.request) {
61
- // The request was made but no response was received
62
- // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js
63
- sdkError.type = ErrorType.REQUEST;
64
- sdkError.request = error.request;
65
- }
66
- else {
67
- // Something happened in setting up the request that triggered an Error
68
- sdkError.type = ErrorType.CLIENT;
69
- }
70
- }
71
- else if (axios_1.default.isCancel(error))
72
- sdkError.type = ErrorType.CANCEL;
73
- else
74
- sdkError.source = error;
75
- throw sdkError;
76
- };
77
- exports.handleError = handleError;
@@ -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 type * from './model';
5
+ export * 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,4 +1,18 @@
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
+ };
2
16
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
17
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
18
  };
@@ -11,3 +25,5 @@ Object.defineProperty(exports, "CommerceLayer", { enumerable: true, get: functio
11
25
  // Commerce Layer static functions
12
26
  var static_1 = require("./static");
13
27
  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 type { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
1
+ import { AxiosError, AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders } from 'axios';
2
2
  type InterceptorManager = {
3
3
  request: AxiosInterceptorManager<AxiosRequestConfig>;
4
4
  response: AxiosInterceptorManager<any>;
@@ -7,11 +7,7 @@ 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 ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period' | 'x-ratelimit-interval' | 'x-ratelimit-remaining';
11
- type ApiHeaders = {
12
- [key in ApiHeadersList]: string | number | boolean;
13
- };
14
- type HeadersObj = (AxiosResponseHeaders | RawAxiosResponseHeaders) & ApiHeaders;
10
+ type HeadersObj = AxiosResponseHeaders | RawAxiosResponseHeaders;
15
11
  type ErrorObj = AxiosError;
16
12
  type ErrorInterceptor = (error: ErrorObj) => ErrorObj;
17
13
  type InterceptorType = 'request' | 'response';
@@ -1,6 +1,5 @@
1
1
  import type { DocWithData, ResourceObject as JSONAPIObject } from 'jsonapi-typescript';
2
2
  import type { ResourceCreate, ResourceUpdate, ResourceId, ResourceType, Resource } from './resource';
3
- export type { DocWithData };
4
3
  declare const denormalize: <R extends Resource>(response: DocWithData) => R | R[];
5
4
  declare const normalize: (resource: (ResourceCreate & ResourceType) | (ResourceUpdate & ResourceId)) => JSONAPIObject;
6
5
  export { denormalize, normalize };
@@ -35,17 +35,13 @@ const denormalizeResource = (res, included) => {
35
35
  debug('denormalize resource: %O, %o', res, included || {});
36
36
  if (!res)
37
37
  return res;
38
- const resource = {
39
- id: res.id,
40
- type: res.type,
41
- ...res.attributes,
42
- };
38
+ const resource = Object.assign({ id: res.id, type: res.type }, res.attributes);
43
39
  if (res.relationships)
44
40
  Object.keys(res.relationships).forEach(key => {
45
41
  const rel = res.relationships[key].data;
46
42
  if (rel) {
47
43
  if (Array.isArray(rel))
48
- resource[key] = rel.map((r) => denormalizeResource(findIncluded(r, included), included));
44
+ resource[key] = rel.map(r => denormalizeResource(findIncluded(r, included), included));
49
45
  else
50
46
  resource[key] = denormalizeResource(findIncluded(rel, included), included);
51
47
  }
@@ -64,10 +60,7 @@ const normalize = (resource) => {
64
60
  if (['type', 'id'].includes(field))
65
61
  continue;
66
62
  const value = resource[field];
67
- if (Array.isArray(value) && (value.length === 1) && (0, common_1.isResourceType)(value[0]) && (value[0].id === null)) {
68
- relationships[field] = { data: [] };
69
- }
70
- else if (value && (0, common_1.isResourceType)(value) && (value.id === null)) {
63
+ if (value && (0, common_1.isResourceType)(value) && value.id === null) {
71
64
  relationships[field] = { data: null };
72
65
  }
73
66
  else if (value && ((0, common_1.isResourceId)(value) || (Array.isArray(value) && (0, common_1.isResourceId)(value[0])))) {
@@ -88,6 +88,7 @@ export type { Promotion } from './resources/promotions';
88
88
  export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate } from './resources/recurring_order_copies';
89
89
  export type { Refund } from './resources/refunds';
90
90
  export type { ReservedStock } from './resources/reserved_stocks';
91
+ export type { ResourceError } from './resources/resource_errors';
91
92
  export type { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate } from './resources/return_line_items';
92
93
  export type { Return, ReturnCreate, ReturnUpdate } from './resources/returns';
93
94
  export type { SatispayGateway, SatispayGatewayCreate, SatispayGatewayUpdate } from './resources/satispay_gateways';
@@ -1,17 +1,23 @@
1
- import type { ResourceType } from "./resource";
2
- type QueryFilter = Record<string, string | number | boolean>;
1
+ import { ResourceType } from "./resource";
3
2
  interface QueryParamsRetrieve {
4
3
  include?: string[];
5
- fields?: string[] | Record<string, string[]>;
4
+ fields?: string[] | {
5
+ [key: string]: string[];
6
+ };
6
7
  }
7
8
  interface QueryParamsList extends QueryParamsRetrieve {
8
- sort?: string[] | Record<string, 'asc' | 'desc'>;
9
- filters?: QueryFilter;
9
+ sort?: string[] | {
10
+ [key: string]: 'asc' | 'desc';
11
+ };
12
+ filters?: {
13
+ [key: string]: string | number | boolean;
14
+ };
10
15
  pageNumber?: number;
11
16
  pageSize?: number;
12
17
  }
13
18
  type QueryParams = QueryParamsRetrieve | QueryParamsList;
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 };
19
+ export { QueryParamsRetrieve, QueryParamsList, QueryParams };
20
+ declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => {
21
+ [key: string]: string;
22
+ };
23
+ export { generateQueryStringParams };
package/lib/cjs/query.js CHANGED
@@ -3,13 +3,12 @@ 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.isParamsList = exports.generateQueryStringParams = void 0;
6
+ 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 && (params.filters || params.pageNumber || params.pageSize || params.sort);
10
+ return (params.filters || params.pageNumber || params.pageSize || params.sort);
11
11
  };
12
- exports.isParamsList = isParamsList;
13
12
  const generateQueryStringParams = (params, res) => {
14
13
  debug('generate query string params: %O, %O', params, res);
15
14
  const qp = {};
@@ -1,7 +1,8 @@
1
1
  import { type ApiClientInitConfig } from './client';
2
- import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
2
+ import { type QueryParamsRetrieve, type QueryParamsList } from './query';
3
3
  import type { ResourceTypeLock } from './api';
4
4
  import type { InterceptorManager } from './interceptor';
5
+ import type { QueryParams } from '.';
5
6
  type ResourceNull = {
6
7
  id: null;
7
8
  } & ResourceType;
@@ -13,19 +14,23 @@ interface ResourceType {
13
14
  interface ResourceId extends ResourceType {
14
15
  readonly id: string;
15
16
  }
16
- interface ResourceBase {
17
- reference?: string | null;
18
- reference_origin?: string | null;
17
+ interface Resource extends ResourceId {
18
+ reference?: string;
19
+ reference_origin?: string;
19
20
  metadata?: Metadata;
20
- }
21
- interface Resource extends ResourceBase, ResourceId {
22
21
  readonly created_at: string;
23
22
  readonly updated_at: string;
24
23
  }
25
- interface ResourceCreate extends ResourceBase {
24
+ interface ResourceCreate {
25
+ reference?: string;
26
+ reference_origin?: string;
27
+ metadata?: Metadata;
26
28
  }
27
- interface ResourceUpdate extends ResourceBase {
29
+ interface ResourceUpdate {
28
30
  readonly id: string;
31
+ reference?: string;
32
+ reference_origin?: string;
33
+ metadata?: Metadata;
29
34
  }
30
35
  type ListMeta = {
31
36
  readonly pageCount: number;
@@ -39,14 +44,8 @@ declare class ListResponse<R> extends Array<R> {
39
44
  first(): R | undefined;
40
45
  last(): R | undefined;
41
46
  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;
48
47
  }
49
- export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ListMeta, ResourceRel };
48
+ export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ResourceRel };
50
49
  type ResourceAdapterConfig = {};
51
50
  type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
52
51
  type ResourcesConfig = Partial<ResourcesInitConfig>;
@@ -55,7 +54,7 @@ declare class ResourceAdapter {
55
54
  constructor(config: ResourcesInitConfig);
56
55
  get interceptors(): InterceptorManager;
57
56
  private localConfig;
58
- config(config: ResourcesConfig): ResourceAdapter;
57
+ config(config: ResourcesConfig): void;
59
58
  singleton<R extends Resource>(resource: ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
60
59
  retrieve<R extends Resource>(resource: ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
61
60
  list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
@@ -64,23 +63,13 @@ declare class ResourceAdapter {
64
63
  delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
65
64
  fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
66
65
  }
67
- declare abstract class ApiResourceBase<R extends Resource> {
66
+ declare abstract class ApiResource {
68
67
  static readonly TYPE: ResourceTypeLock;
69
- protected readonly resources: ResourceAdapter;
68
+ protected resources: ResourceAdapter;
70
69
  constructor(adapter: ResourceAdapter);
71
70
  abstract relationship(id: string | ResourceId | null): ResourceRel;
72
- abstract type(): ResourceTypeLock;
73
- parse(resource: string): R | R[];
74
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
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
- count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
80
- }
81
- declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
82
- retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
71
+ abstract type(): string;
72
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Resource>;
83
73
  }
84
74
  export default ResourceAdapter;
85
- export { ApiResource, ApiSingleton };
86
- export type { ResourcesConfig, ResourcesInitConfig };
75
+ export { ApiResource, type ResourcesConfig, type ResourcesInitConfig };
@@ -15,12 +15,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
15
15
  };
16
16
  var _ResourceAdapter_client, _ResourceAdapter_config;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.ApiSingleton = exports.ApiResource = void 0;
18
+ exports.ApiResource = void 0;
19
19
  const client_1 = __importDefault(require("./client"));
20
20
  const jsonapi_1 = require("./jsonapi");
21
21
  const query_1 = require("./query");
22
22
  const config_1 = __importDefault(require("./config"));
23
- const error_1 = require("./error");
24
23
  const debug_1 = __importDefault(require("./debug"));
25
24
  const debug = (0, debug_1.default)('resource');
26
25
  class ListResponse extends Array {
@@ -31,12 +30,6 @@ class ListResponse extends Array {
31
30
  first() { return this.length ? this[0] : undefined; }
32
31
  last() { return this.length ? this[this.length - 1] : undefined; }
33
32
  get(index) { return (this.length && (index >= 0)) ? this[index] : undefined; }
34
- hasNextPage() { return (this.meta.currentPage < this.meta.pageCount); }
35
- hasPrevPage() { return (this.meta.currentPage > 1); }
36
- getRecordCount() { return this.meta.recordCount; }
37
- getPageCount() { return this.meta.pageCount; }
38
- get recordCount() { return this.meta.recordCount; }
39
- get pageCount() { return this.meta.pageCount; }
40
33
  }
41
34
  class ResourceAdapter {
42
35
  constructor(config) {
@@ -46,6 +39,7 @@ class ResourceAdapter {
46
39
  this.localConfig(config);
47
40
  }
48
41
  get interceptors() { return __classPrivateFieldGet(this, _ResourceAdapter_client, "f").interceptors; }
42
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
49
43
  localConfig(config) {
50
44
  // if (typeof config.xyz !== 'undefined') this.#config.xyz = config.xyz
51
45
  }
@@ -55,19 +49,13 @@ class ResourceAdapter {
55
49
  this.localConfig(config);
56
50
  // Client config
57
51
  __classPrivateFieldGet(this, _ResourceAdapter_client, "f").config(config);
58
- return this;
59
52
  }
60
- /*
61
- get clientInstance(): ApiClient {
62
- return this.#client
63
- }
64
- */
65
53
  async singleton(resource, params, options) {
66
54
  debug('singleton: %o, %O, %O', resource, params || {}, options || {});
67
55
  const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
68
56
  if (options === null || options === void 0 ? void 0 : options.params)
69
57
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
70
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
58
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
71
59
  const r = (0, jsonapi_1.denormalize)(res);
72
60
  return r;
73
61
  }
@@ -76,7 +64,7 @@ class ResourceAdapter {
76
64
  const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
77
65
  if (options === null || options === void 0 ? void 0 : options.params)
78
66
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
79
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, { ...options, params: queryParams });
67
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
80
68
  const r = (0, jsonapi_1.denormalize)(res);
81
69
  return r;
82
70
  }
@@ -86,7 +74,7 @@ class ResourceAdapter {
86
74
  const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
87
75
  if (options === null || options === void 0 ? void 0 : options.params)
88
76
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
89
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
77
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
90
78
  const r = (0, jsonapi_1.denormalize)(res);
91
79
  const meta = {
92
80
  pageCount: Number((_a = res.meta) === null || _a === void 0 ? void 0 : _a.page_count),
@@ -102,7 +90,7 @@ class ResourceAdapter {
102
90
  if (options === null || options === void 0 ? void 0 : options.params)
103
91
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
104
92
  const data = (0, jsonapi_1.normalize)(resource);
105
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, { ...options, params: queryParams });
93
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, Object.assign(Object.assign({}, options), { params: queryParams }));
106
94
  const r = (0, jsonapi_1.denormalize)(res);
107
95
  return r;
108
96
  }
@@ -112,7 +100,7 @@ class ResourceAdapter {
112
100
  if (options === null || options === void 0 ? void 0 : options.params)
113
101
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
114
102
  const data = (0, jsonapi_1.normalize)(resource);
115
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, { ...options, params: queryParams });
103
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, Object.assign(Object.assign({}, options), { params: queryParams }));
116
104
  const r = (0, jsonapi_1.denormalize)(res);
117
105
  return r;
118
106
  }
@@ -126,7 +114,7 @@ class ResourceAdapter {
126
114
  const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
127
115
  if (options === null || options === void 0 ? void 0 : options.params)
128
116
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
129
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, { ...options, params: queryParams });
117
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
130
118
  const r = (0, jsonapi_1.denormalize)(res);
131
119
  if (Array.isArray(r)) {
132
120
  const p = params;
@@ -143,49 +131,15 @@ class ResourceAdapter {
143
131
  }
144
132
  }
145
133
  _ResourceAdapter_client = new WeakMap(), _ResourceAdapter_config = new WeakMap();
146
- class ApiResourceBase {
134
+ class ApiResource {
147
135
  constructor(adapter) {
148
136
  debug('new resource instance: %s', this.type());
149
137
  this.resources = adapter;
150
138
  }
151
- parse(resource) {
152
- var _a, _b;
153
- try {
154
- const res = JSON.parse(resource);
155
- if (((_a = res.data) === null || _a === void 0 ? void 0 : _a.type) !== this.type())
156
- throw new error_1.SdkError({ message: `Invalid resource type [${(_b = res.data) === null || _b === void 0 ? void 0 : _b.type}]`, type: error_1.ErrorType.PARSE });
157
- return (0, jsonapi_1.denormalize)(res);
158
- }
159
- catch (error) {
160
- if (error_1.SdkError.isSdkError(error))
161
- throw error;
162
- else
163
- throw new error_1.SdkError({ message: `Payload parse error [${error.message}]`, type: error_1.ErrorType.PARSE });
164
- }
165
- }
166
139
  // reference, reference_origin and metadata attributes are always updatable
167
140
  async update(resource, params, options) {
168
- return this.resources.update({ ...resource, type: this.type() }, params, options);
169
- }
170
- }
171
- class ApiResource extends ApiResourceBase {
172
- async retrieve(id, params, options) {
173
- return this.resources.retrieve((typeof id === 'string') ? { type: this.type(), id } : id, params, options);
174
- }
175
- async list(params, options) {
176
- return this.resources.list({ type: this.type() }, params, options);
177
- }
178
- async count(filter, options) {
179
- const params = { filters: (0, query_1.isParamsList)(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
180
- const response = await this.list(params, options);
181
- return Promise.resolve(response.meta.recordCount);
141
+ return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
182
142
  }
183
143
  }
184
144
  exports.ApiResource = ApiResource;
185
- class ApiSingleton extends ApiResourceBase {
186
- async retrieve(params, options) {
187
- return this.resources.singleton({ type: this.type() }, params, options);
188
- }
189
- }
190
- exports.ApiSingleton = ApiSingleton;
191
145
  exports.default = ResourceAdapter;
@@ -1,103 +1,102 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
- import type { Geocoder, GeocoderType } from './geocoders';
1
+ import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
+ import type { QueryParamsList, QueryParamsRetrieve } from '../query';
3
+ import type { Geocoder } from './geocoders';
5
4
  import type { Event } from './events';
6
- import type { Tag, TagType } from './tags';
5
+ import type { Tag } from './tags';
7
6
  import type { Version } from './versions';
8
- type AddressType = 'addresses';
9
7
  type AddressRel = ResourceRel & {
10
- type: AddressType;
8
+ type: typeof Addresses.TYPE;
11
9
  };
12
10
  type GeocoderRel = ResourceRel & {
13
- type: GeocoderType;
11
+ type: 'geocoders';
14
12
  };
15
13
  type TagRel = ResourceRel & {
16
- type: TagType;
14
+ type: 'tags';
17
15
  };
18
16
  interface Address extends Resource {
19
- readonly type: AddressType;
20
- business?: boolean | null;
21
- first_name?: string | null;
22
- last_name?: string | null;
23
- company?: string | null;
24
- full_name?: string | null;
25
- line_1: string;
26
- line_2?: string | null;
27
- city: string;
28
- zip_code?: string | null;
29
- state_code: string;
30
- country_code: string;
31
- phone: string;
32
- full_address?: string | null;
33
- name?: string | null;
34
- email?: string | null;
35
- notes?: string | null;
36
- lat?: number | null;
37
- lng?: number | null;
38
- is_localized?: boolean | null;
39
- is_geocoded?: boolean | null;
40
- provider_name?: string | null;
41
- map_url?: string | null;
42
- static_map_url?: string | null;
43
- billing_info?: string | null;
44
- geocoder?: Geocoder | null;
45
- events?: Event[] | null;
46
- tags?: Tag[] | null;
47
- versions?: Version[] | null;
17
+ business?: boolean;
18
+ first_name?: string;
19
+ last_name?: string;
20
+ company?: string;
21
+ full_name?: string;
22
+ line_1?: string;
23
+ line_2?: string;
24
+ city?: string;
25
+ zip_code?: string;
26
+ state_code?: string;
27
+ country_code?: string;
28
+ phone?: string;
29
+ full_address?: string;
30
+ name?: string;
31
+ email?: string;
32
+ notes?: string;
33
+ lat?: number;
34
+ lng?: number;
35
+ is_localized?: boolean;
36
+ is_geocoded?: boolean;
37
+ provider_name?: string;
38
+ map_url?: string;
39
+ static_map_url?: string;
40
+ billing_info?: string;
41
+ geocoder?: Geocoder;
42
+ events?: Event[];
43
+ tags?: Tag[];
44
+ versions?: Version[];
48
45
  }
49
46
  interface AddressCreate extends ResourceCreate {
50
- business?: boolean | null;
51
- first_name?: string | null;
52
- last_name?: string | null;
53
- company?: string | null;
47
+ business?: boolean;
48
+ first_name?: string;
49
+ last_name?: string;
50
+ company?: string;
54
51
  line_1: string;
55
- line_2?: string | null;
52
+ line_2?: string;
56
53
  city: string;
57
- zip_code?: string | null;
54
+ zip_code?: string;
58
55
  state_code: string;
59
56
  country_code: string;
60
57
  phone: string;
61
- email?: string | null;
62
- notes?: string | null;
63
- lat?: number | null;
64
- lng?: number | null;
65
- billing_info?: string | null;
66
- geocoder?: GeocoderRel | null;
67
- tags?: TagRel[] | null;
58
+ email?: string;
59
+ notes?: string;
60
+ lat?: number;
61
+ lng?: number;
62
+ billing_info?: string;
63
+ geocoder?: GeocoderRel;
64
+ tags?: TagRel[];
68
65
  }
69
66
  interface AddressUpdate extends ResourceUpdate {
70
- business?: boolean | null;
71
- first_name?: string | null;
72
- last_name?: string | null;
73
- company?: string | null;
74
- line_1?: string | null;
75
- line_2?: string | null;
76
- city?: string | null;
77
- zip_code?: string | null;
78
- state_code?: string | null;
79
- country_code?: string | null;
80
- phone?: string | null;
81
- email?: string | null;
82
- notes?: string | null;
83
- lat?: number | null;
84
- lng?: number | null;
85
- billing_info?: string | null;
86
- geocoder?: GeocoderRel | null;
87
- tags?: TagRel[] | null;
67
+ business?: boolean;
68
+ first_name?: string;
69
+ last_name?: string;
70
+ company?: string;
71
+ line_1?: string;
72
+ line_2?: string;
73
+ city?: string;
74
+ zip_code?: string;
75
+ state_code?: string;
76
+ country_code?: string;
77
+ phone?: string;
78
+ email?: string;
79
+ notes?: string;
80
+ lat?: number;
81
+ lng?: number;
82
+ billing_info?: string;
83
+ geocoder?: GeocoderRel;
84
+ tags?: TagRel[];
88
85
  }
89
- declare class Addresses extends ApiResource<Address> {
90
- static readonly TYPE: AddressType;
86
+ declare class Addresses extends ApiResource {
87
+ static readonly TYPE: 'addresses';
88
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
91
89
  create(resource: AddressCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
90
+ retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
92
91
  update(resource: AddressUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
93
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
92
+ delete(id: string, options?: ResourcesConfig): Promise<void>;
94
93
  geocoder(addressId: string | Address, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
95
94
  events(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
96
95
  tags(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
97
96
  versions(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
98
97
  isAddress(resource: any): resource is Address;
99
98
  relationship(id: string | ResourceId | null): AddressRel;
100
- type(): AddressType;
99
+ type(): string;
101
100
  }
102
101
  export default Addresses;
103
- export type { Address, AddressCreate, AddressUpdate, AddressType };
102
+ export { Address, AddressCreate, AddressUpdate };