@commercelayer/sdk 4.27.1 → 4.28.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 +1 -1
@@ -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 };
@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
12
12
  var _ResourceAdapter_client, _ResourceAdapter_config;
13
13
  import ApiClient from './client';
14
14
  import { denormalize, normalize } from './jsonapi';
15
- import { generateQueryStringParams } from './query';
15
+ import { generateQueryStringParams, isParamsList } from './query';
16
16
  import config from './config';
17
17
  import Debug from './debug';
18
18
  const debug = Debug('resource');
@@ -24,6 +24,12 @@ class ListResponse extends Array {
24
24
  first() { return this.length ? this[0] : undefined; }
25
25
  last() { return this.length ? this[this.length - 1] : undefined; }
26
26
  get(index) { return (this.length && (index >= 0)) ? this[index] : undefined; }
27
+ hasNextPage() { return (this.meta.currentPage < this.meta.pageCount); }
28
+ hasPrevPage() { return (this.meta.currentPage > 1); }
29
+ getRecordCount() { return this.meta.recordCount; }
30
+ getPageCount() { return this.meta.pageCount; }
31
+ get recordCount() { return this.meta.recordCount; }
32
+ get pageCount() { return this.meta.pageCount; }
27
33
  }
28
34
  class ResourceAdapter {
29
35
  constructor(config) {
@@ -49,7 +55,7 @@ class ResourceAdapter {
49
55
  const queryParams = generateQueryStringParams(params, resource);
50
56
  if (options === null || options === void 0 ? void 0 : options.params)
51
57
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
52
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
58
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
53
59
  const r = denormalize(res);
54
60
  return r;
55
61
  }
@@ -58,7 +64,7 @@ class ResourceAdapter {
58
64
  const queryParams = generateQueryStringParams(params, resource);
59
65
  if (options === null || options === void 0 ? void 0 : options.params)
60
66
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
61
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
67
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, { ...options, params: queryParams });
62
68
  const r = denormalize(res);
63
69
  return r;
64
70
  }
@@ -68,7 +74,7 @@ class ResourceAdapter {
68
74
  const queryParams = generateQueryStringParams(params, resource);
69
75
  if (options === null || options === void 0 ? void 0 : options.params)
70
76
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
71
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
77
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
72
78
  const r = denormalize(res);
73
79
  const meta = {
74
80
  pageCount: Number((_a = res.meta) === null || _a === void 0 ? void 0 : _a.page_count),
@@ -84,7 +90,7 @@ class ResourceAdapter {
84
90
  if (options === null || options === void 0 ? void 0 : options.params)
85
91
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
86
92
  const data = normalize(resource);
87
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, Object.assign(Object.assign({}, options), { params: queryParams }));
93
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, { ...options, params: queryParams });
88
94
  const r = denormalize(res);
89
95
  return r;
90
96
  }
@@ -94,7 +100,7 @@ class ResourceAdapter {
94
100
  if (options === null || options === void 0 ? void 0 : options.params)
95
101
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
96
102
  const data = normalize(resource);
97
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, Object.assign(Object.assign({}, options), { params: queryParams }));
103
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, { ...options, params: queryParams });
98
104
  const r = denormalize(res);
99
105
  return r;
100
106
  }
@@ -108,7 +114,7 @@ class ResourceAdapter {
108
114
  const queryParams = generateQueryStringParams(params, resource);
109
115
  if (options === null || options === void 0 ? void 0 : options.params)
110
116
  Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
111
- const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
117
+ const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, { ...options, params: queryParams });
112
118
  const r = denormalize(res);
113
119
  if (Array.isArray(r)) {
114
120
  const p = params;
@@ -125,15 +131,33 @@ class ResourceAdapter {
125
131
  }
126
132
  }
127
133
  _ResourceAdapter_client = new WeakMap(), _ResourceAdapter_config = new WeakMap();
128
- class ApiResource {
134
+ class ApiResourceBase {
129
135
  constructor(adapter) {
130
136
  debug('new resource instance: %s', this.type());
131
137
  this.resources = adapter;
132
138
  }
133
139
  // reference, reference_origin and metadata attributes are always updatable
134
140
  async update(resource, params, options) {
135
- return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
141
+ return this.resources.update({ ...resource, type: this.type() }, params, options);
142
+ }
143
+ async count(filter, options) {
144
+ const params = { filters: isParamsList(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
145
+ const response = await this.resources.list({ type: this.type() }, params, options);
146
+ return Promise.resolve(response.meta.recordCount);
147
+ }
148
+ }
149
+ class ApiResource extends ApiResourceBase {
150
+ async retrieve(id, params, options) {
151
+ return this.resources.retrieve((typeof id === 'string') ? { type: this.type(), id } : id, params, options);
152
+ }
153
+ async list(params, options) {
154
+ return this.resources.list({ type: this.type() }, params, options);
155
+ }
156
+ }
157
+ class ApiSingleton extends ApiResourceBase {
158
+ async retrieve(params, options) {
159
+ return this.resources.singleton({ type: this.type() }, params, options);
136
160
  }
137
161
  }
138
162
  export default ResourceAdapter;
139
- export { ApiResource };
163
+ export { ApiResource, ApiSingleton };
@@ -1,88 +1,100 @@
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';
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';
5
+ import type { Event } from './events';
6
+ import type { Tag, TagType } from './tags';
7
+ type AddressType = 'addresses';
4
8
  type AddressRel = ResourceRel & {
5
- type: typeof Addresses.TYPE;
9
+ type: AddressType;
6
10
  };
7
11
  type GeocoderRel = ResourceRel & {
8
- type: 'geocoders';
12
+ type: GeocoderType;
13
+ };
14
+ type TagRel = ResourceRel & {
15
+ type: TagType;
9
16
  };
10
17
  interface Address extends Resource {
11
- business?: boolean;
12
- first_name?: string;
13
- last_name?: string;
14
- company?: string;
15
- full_name?: string;
16
- line_1?: string;
17
- line_2?: string;
18
- city?: string;
19
- zip_code?: string;
20
- state_code?: string;
21
- country_code?: string;
22
- phone?: string;
23
- full_address?: string;
24
- name?: string;
25
- email?: string;
26
- notes?: string;
27
- lat?: number;
28
- lng?: number;
29
- is_localized?: boolean;
30
- is_geocoded?: boolean;
31
- provider_name?: string;
32
- map_url?: string;
33
- static_map_url?: string;
34
- billing_info?: string;
35
- geocoder?: Geocoder;
18
+ readonly type: AddressType;
19
+ business?: boolean | null;
20
+ first_name?: string | null;
21
+ last_name?: string | null;
22
+ company?: string | null;
23
+ full_name?: string | null;
24
+ line_1: string;
25
+ line_2?: string | null;
26
+ city: string;
27
+ zip_code?: string | null;
28
+ state_code: string;
29
+ country_code: string;
30
+ phone: string;
31
+ full_address?: string | null;
32
+ name?: string | null;
33
+ email?: string | null;
34
+ notes?: string | null;
35
+ lat?: number | null;
36
+ lng?: number | null;
37
+ is_localized?: boolean | null;
38
+ is_geocoded?: boolean | null;
39
+ provider_name?: string | null;
40
+ map_url?: string | null;
41
+ static_map_url?: string | null;
42
+ billing_info?: string | null;
43
+ geocoder?: Geocoder | null;
44
+ events?: Event[] | null;
45
+ tags?: Tag[] | null;
36
46
  }
37
47
  interface AddressCreate extends ResourceCreate {
38
- business?: boolean;
39
- first_name?: string;
40
- last_name?: string;
41
- company?: string;
48
+ business?: boolean | null;
49
+ first_name?: string | null;
50
+ last_name?: string | null;
51
+ company?: string | null;
42
52
  line_1: string;
43
- line_2?: string;
53
+ line_2?: string | null;
44
54
  city: string;
45
- zip_code?: string;
55
+ zip_code?: string | null;
46
56
  state_code: string;
47
57
  country_code: string;
48
58
  phone: string;
49
- email?: string;
50
- notes?: string;
51
- lat?: number;
52
- lng?: number;
53
- billing_info?: string;
54
- geocoder?: GeocoderRel;
59
+ email?: string | null;
60
+ notes?: string | null;
61
+ lat?: number | null;
62
+ lng?: number | null;
63
+ billing_info?: string | null;
64
+ geocoder?: GeocoderRel | null;
65
+ tags?: TagRel[] | null;
55
66
  }
56
67
  interface AddressUpdate extends ResourceUpdate {
57
- business?: boolean;
58
- first_name?: string;
59
- last_name?: string;
60
- company?: string;
61
- line_1?: string;
62
- line_2?: string;
63
- city?: string;
64
- zip_code?: string;
65
- state_code?: string;
66
- country_code?: string;
67
- phone?: string;
68
- email?: string;
69
- notes?: string;
70
- lat?: number;
71
- lng?: number;
72
- billing_info?: string;
73
- geocoder?: GeocoderRel;
68
+ business?: boolean | null;
69
+ first_name?: string | null;
70
+ last_name?: string | null;
71
+ company?: string | null;
72
+ line_1?: string | null;
73
+ line_2?: string | null;
74
+ city?: string | null;
75
+ zip_code?: string | null;
76
+ state_code?: string | null;
77
+ country_code?: string | null;
78
+ phone?: string | null;
79
+ email?: string | null;
80
+ notes?: string | null;
81
+ lat?: number | null;
82
+ lng?: number | null;
83
+ billing_info?: string | null;
84
+ geocoder?: GeocoderRel | null;
85
+ tags?: TagRel[] | null;
74
86
  }
75
- declare class Addresses extends ApiResource {
76
- static readonly TYPE: 'addresses';
77
- list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
87
+ declare class Addresses extends ApiResource<Address> {
88
+ static readonly TYPE: AddressType;
78
89
  create(resource: AddressCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
79
- retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
80
90
  update(resource: AddressUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
81
- delete(id: string, options?: ResourcesConfig): Promise<void>;
91
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
82
92
  geocoder(addressId: string | Address, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
93
+ events(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
94
+ tags(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
83
95
  isAddress(resource: any): resource is Address;
84
96
  relationship(id: string | ResourceId | null): AddressRel;
85
- type(): string;
97
+ type(): AddressType;
86
98
  }
87
99
  export default Addresses;
88
- export { Address, AddressCreate, AddressUpdate };
100
+ export type { Address, AddressCreate, AddressUpdate, AddressType };
@@ -1,26 +1,26 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Addresses extends ApiResource {
3
- // static readonly PATH = 'addresses'
4
- async list(params, options) {
5
- return this.resources.list({ type: Addresses.TYPE }, params, options);
6
- }
7
3
  async create(resource, params, options) {
8
- return this.resources.create(Object.assign(Object.assign({}, resource), { type: Addresses.TYPE }), params, options);
9
- }
10
- async retrieve(id, params, options) {
11
- return this.resources.retrieve({ type: Addresses.TYPE, id }, params, options);
4
+ return this.resources.create({ ...resource, type: Addresses.TYPE }, params, options);
12
5
  }
13
6
  async update(resource, params, options) {
14
- return this.resources.update(Object.assign(Object.assign({}, resource), { type: Addresses.TYPE }), params, options);
7
+ return this.resources.update({ ...resource, type: Addresses.TYPE }, params, options);
15
8
  }
16
9
  async delete(id, options) {
17
- await this.resources.delete({ type: Addresses.TYPE, id }, options);
10
+ await this.resources.delete((typeof id === 'string') ? { id, type: Addresses.TYPE } : id, options);
18
11
  }
19
12
  async geocoder(addressId, params, options) {
20
13
  const _addressId = addressId.id || addressId;
21
14
  return this.resources.fetch({ type: 'geocoders' }, `addresses/${_addressId}/geocoder`, params, options);
22
15
  }
23
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
16
+ async events(addressId, params, options) {
17
+ const _addressId = addressId.id || addressId;
18
+ return this.resources.fetch({ type: 'events' }, `addresses/${_addressId}/events`, params, options);
19
+ }
20
+ async tags(addressId, params, options) {
21
+ const _addressId = addressId.id || addressId;
22
+ return this.resources.fetch({ type: 'tags' }, `addresses/${_addressId}/tags`, params, options);
23
+ }
24
24
  isAddress(resource) {
25
25
  return resource.type && (resource.type === Addresses.TYPE);
26
26
  }
@@ -1,14 +1,17 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
- import type { QueryParamsList, QueryParamsRetrieve } from '../query';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
3
+ import type { QueryParamsRetrieve } from '../query';
4
+ type AdjustmentType = 'adjustments';
3
5
  type AdjustmentRel = ResourceRel & {
4
- type: typeof Adjustments.TYPE;
6
+ type: AdjustmentType;
5
7
  };
6
8
  interface Adjustment extends Resource {
7
- name?: string;
8
- currency_code?: string;
9
- amount_cents?: number;
10
- amount_float?: number;
11
- formatted_amount?: string;
9
+ readonly type: AdjustmentType;
10
+ name: string;
11
+ currency_code: string;
12
+ amount_cents: number;
13
+ amount_float: number;
14
+ formatted_amount: string;
12
15
  }
13
16
  interface AdjustmentCreate extends ResourceCreate {
14
17
  name: string;
@@ -16,20 +19,18 @@ interface AdjustmentCreate extends ResourceCreate {
16
19
  amount_cents: number;
17
20
  }
18
21
  interface AdjustmentUpdate extends ResourceUpdate {
19
- name?: string;
20
- currency_code?: string;
21
- amount_cents?: number;
22
+ name?: string | null;
23
+ currency_code?: string | null;
24
+ amount_cents?: number | null;
22
25
  }
23
- declare class Adjustments extends ApiResource {
24
- static readonly TYPE: 'adjustments';
25
- list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Adjustment>>;
26
+ declare class Adjustments extends ApiResource<Adjustment> {
27
+ static readonly TYPE: AdjustmentType;
26
28
  create(resource: AdjustmentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
27
- retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
28
29
  update(resource: AdjustmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
29
- delete(id: string, options?: ResourcesConfig): Promise<void>;
30
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
30
31
  isAdjustment(resource: any): resource is Adjustment;
31
32
  relationship(id: string | ResourceId | null): AdjustmentRel;
32
- type(): string;
33
+ type(): AdjustmentType;
33
34
  }
34
35
  export default Adjustments;
35
- export { Adjustment, AdjustmentCreate, AdjustmentUpdate };
36
+ export type { Adjustment, AdjustmentCreate, AdjustmentUpdate, AdjustmentType };
@@ -1,22 +1,14 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Adjustments extends ApiResource {
3
- // static readonly PATH = 'adjustments'
4
- async list(params, options) {
5
- return this.resources.list({ type: Adjustments.TYPE }, params, options);
6
- }
7
3
  async create(resource, params, options) {
8
- return this.resources.create(Object.assign(Object.assign({}, resource), { type: Adjustments.TYPE }), params, options);
9
- }
10
- async retrieve(id, params, options) {
11
- return this.resources.retrieve({ type: Adjustments.TYPE, id }, params, options);
4
+ return this.resources.create({ ...resource, type: Adjustments.TYPE }, params, options);
12
5
  }
13
6
  async update(resource, params, options) {
14
- return this.resources.update(Object.assign(Object.assign({}, resource), { type: Adjustments.TYPE }), params, options);
7
+ return this.resources.update({ ...resource, type: Adjustments.TYPE }, params, options);
15
8
  }
16
9
  async delete(id, options) {
17
- await this.resources.delete({ type: Adjustments.TYPE, id }, options);
10
+ await this.resources.delete((typeof id === 'string') ? { id, type: Adjustments.TYPE } : id, options);
18
11
  }
19
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
20
12
  isAdjustment(resource) {
21
13
  return resource.type && (resource.type === Adjustments.TYPE);
22
14
  }
@@ -1,56 +1,57 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
- import type { QueryParamsList, QueryParamsRetrieve } from '../query';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
+ import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { PaymentMethod } from './payment_methods';
4
- import type { AdyenPayment } from './adyen_payments';
5
+ import type { AdyenPayment, AdyenPaymentType } from './adyen_payments';
6
+ type AdyenGatewayType = 'adyen_gateways';
5
7
  type AdyenGatewayRel = ResourceRel & {
6
- type: typeof AdyenGateways.TYPE;
8
+ type: AdyenGatewayType;
7
9
  };
8
10
  type AdyenPaymentRel = ResourceRel & {
9
- type: 'adyen_payments';
11
+ type: AdyenPaymentType;
10
12
  };
11
13
  interface AdyenGateway extends Resource {
12
- name?: string;
13
- live_url_prefix?: string;
14
- async_api?: boolean;
15
- webhook_endpoint_secret?: string;
16
- webhook_endpoint_url?: string;
17
- payment_methods?: PaymentMethod[];
18
- adyen_payments?: AdyenPayment[];
14
+ readonly type: AdyenGatewayType;
15
+ name: string;
16
+ live_url_prefix: string;
17
+ async_api?: boolean | null;
18
+ webhook_endpoint_secret?: string | null;
19
+ webhook_endpoint_url?: string | null;
20
+ payment_methods?: PaymentMethod[] | null;
21
+ adyen_payments?: AdyenPayment[] | null;
19
22
  }
20
23
  interface AdyenGatewayCreate extends ResourceCreate {
21
24
  name: string;
22
25
  merchant_account: string;
23
26
  api_key: string;
24
- public_key?: string;
27
+ public_key?: string | null;
25
28
  live_url_prefix: string;
26
- api_version?: string;
27
- async_api?: boolean;
28
- webhook_endpoint_secret?: string;
29
- adyen_payments?: AdyenPaymentRel[];
29
+ api_version?: string | null;
30
+ async_api?: boolean | null;
31
+ webhook_endpoint_secret?: string | null;
32
+ adyen_payments?: AdyenPaymentRel[] | null;
30
33
  }
31
34
  interface AdyenGatewayUpdate extends ResourceUpdate {
32
- name?: string;
33
- merchant_account?: string;
34
- api_key?: string;
35
- public_key?: string;
36
- live_url_prefix?: string;
37
- api_version?: string;
38
- async_api?: boolean;
39
- webhook_endpoint_secret?: string;
40
- adyen_payments?: AdyenPaymentRel[];
35
+ name?: string | null;
36
+ merchant_account?: string | null;
37
+ api_key?: string | null;
38
+ public_key?: string | null;
39
+ live_url_prefix?: string | null;
40
+ api_version?: string | null;
41
+ async_api?: boolean | null;
42
+ webhook_endpoint_secret?: string | null;
43
+ adyen_payments?: AdyenPaymentRel[] | null;
41
44
  }
42
- declare class AdyenGateways extends ApiResource {
43
- static readonly TYPE: 'adyen_gateways';
44
- list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenGateway>>;
45
+ declare class AdyenGateways extends ApiResource<AdyenGateway> {
46
+ static readonly TYPE: AdyenGatewayType;
45
47
  create(resource: AdyenGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
46
- retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
47
48
  update(resource: AdyenGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
48
- delete(id: string, options?: ResourcesConfig): Promise<void>;
49
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
49
50
  payment_methods(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
50
51
  adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
51
52
  isAdyenGateway(resource: any): resource is AdyenGateway;
52
53
  relationship(id: string | ResourceId | null): AdyenGatewayRel;
53
- type(): string;
54
+ type(): AdyenGatewayType;
54
55
  }
55
56
  export default AdyenGateways;
56
- export { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate };
57
+ export type { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate, AdyenGatewayType };
@@ -1,20 +1,13 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class AdyenGateways extends ApiResource {
3
- // static readonly PATH = 'adyen_gateways'
4
- async list(params, options) {
5
- return this.resources.list({ type: AdyenGateways.TYPE }, params, options);
6
- }
7
3
  async create(resource, params, options) {
8
- return this.resources.create(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
9
- }
10
- async retrieve(id, params, options) {
11
- return this.resources.retrieve({ type: AdyenGateways.TYPE, id }, params, options);
4
+ return this.resources.create({ ...resource, type: AdyenGateways.TYPE }, params, options);
12
5
  }
13
6
  async update(resource, params, options) {
14
- return this.resources.update(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
7
+ return this.resources.update({ ...resource, type: AdyenGateways.TYPE }, params, options);
15
8
  }
16
9
  async delete(id, options) {
17
- await this.resources.delete({ type: AdyenGateways.TYPE, id }, options);
10
+ await this.resources.delete((typeof id === 'string') ? { id, type: AdyenGateways.TYPE } : id, options);
18
11
  }
19
12
  async payment_methods(adyenGatewayId, params, options) {
20
13
  const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
@@ -24,7 +17,6 @@ class AdyenGateways extends ApiResource {
24
17
  const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
25
18
  return this.resources.fetch({ type: 'adyen_payments' }, `adyen_gateways/${_adyenGatewayId}/adyen_payments`, params, options);
26
19
  }
27
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
28
20
  isAdyenGateway(resource) {
29
21
  return resource.type && (resource.type === AdyenGateways.TYPE);
30
22
  }