@commercelayer/sdk 4.28.0 → 4.28.1

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 (533) hide show
  1. package/lib/cjs/api.d.ts +9 -23
  2. package/lib/cjs/api.js +35 -4
  3. package/lib/cjs/client.d.ts +5 -3
  4. package/lib/cjs/client.js +8 -11
  5. package/lib/cjs/commercelayer.d.ts +11 -5
  6. package/lib/cjs/commercelayer.js +9 -3
  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 -1
  11. package/lib/cjs/debug.js +4 -0
  12. package/lib/cjs/error.js +4 -1
  13. package/lib/cjs/index.d.ts +1 -1
  14. package/lib/cjs/index.js +16 -0
  15. package/lib/cjs/interceptor.d.ts +2 -6
  16. package/lib/cjs/jsonapi.js +1 -5
  17. package/lib/cjs/model.d.ts +9 -3
  18. package/lib/cjs/query.d.ts +15 -9
  19. package/lib/cjs/query.js +2 -3
  20. package/lib/cjs/resource.d.ts +19 -29
  21. package/lib/cjs/resource.js +9 -34
  22. package/lib/cjs/resources/addresses.d.ts +75 -73
  23. package/lib/cjs/resources/addresses.js +15 -3
  24. package/lib/cjs/resources/adjustments.d.ts +21 -19
  25. package/lib/cjs/resources/adjustments.js +15 -3
  26. package/lib/cjs/resources/adyen_gateways.d.ts +36 -34
  27. package/lib/cjs/resources/adyen_gateways.js +15 -3
  28. package/lib/cjs/resources/adyen_payments.d.ts +29 -27
  29. package/lib/cjs/resources/adyen_payments.js +15 -3
  30. package/lib/cjs/resources/application.d.ts +13 -14
  31. package/lib/cjs/resources/application.js +6 -1
  32. package/lib/cjs/resources/attachments.d.ts +80 -81
  33. package/lib/cjs/resources/attachments.js +11 -3
  34. package/lib/cjs/resources/authorizations.d.ts +49 -44
  35. package/lib/cjs/resources/authorizations.js +21 -5
  36. package/lib/cjs/resources/avalara_accounts.d.ts +33 -31
  37. package/lib/cjs/resources/avalara_accounts.js +15 -3
  38. package/lib/cjs/resources/axerve_gateways.d.ts +25 -22
  39. package/lib/cjs/resources/axerve_gateways.js +15 -3
  40. package/lib/cjs/resources/axerve_payments.d.ts +34 -26
  41. package/lib/cjs/resources/axerve_payments.js +15 -3
  42. package/lib/cjs/resources/billing_info_validation_rules.d.ts +18 -16
  43. package/lib/cjs/resources/billing_info_validation_rules.js +15 -3
  44. package/lib/cjs/resources/bing_geocoders.d.ts +15 -16
  45. package/lib/cjs/resources/bing_geocoders.js +11 -3
  46. package/lib/cjs/resources/braintree_gateways.d.ts +35 -33
  47. package/lib/cjs/resources/braintree_gateways.js +15 -3
  48. package/lib/cjs/resources/braintree_payments.d.ts +31 -29
  49. package/lib/cjs/resources/braintree_payments.js +15 -3
  50. package/lib/cjs/resources/bundles.d.ts +58 -56
  51. package/lib/cjs/resources/bundles.js +15 -3
  52. package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +134 -0
  53. package/lib/cjs/resources/buy_x_pay_y_promotions.js +81 -0
  54. package/lib/cjs/resources/captures.d.ts +40 -35
  55. package/lib/cjs/resources/captures.js +21 -5
  56. package/lib/cjs/resources/carrier_accounts.d.ts +17 -15
  57. package/lib/cjs/resources/carrier_accounts.js +12 -0
  58. package/lib/cjs/resources/checkout_com_gateways.d.ts +26 -24
  59. package/lib/cjs/resources/checkout_com_gateways.js +15 -3
  60. package/lib/cjs/resources/checkout_com_payments.d.ts +40 -38
  61. package/lib/cjs/resources/checkout_com_payments.js +15 -3
  62. package/lib/cjs/resources/cleanups.d.ts +25 -23
  63. package/lib/cjs/resources/cleanups.js +14 -2
  64. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +37 -31
  65. package/lib/cjs/resources/coupon_codes_promotion_rules.js +15 -3
  66. package/lib/cjs/resources/coupon_recipients.d.ts +27 -25
  67. package/lib/cjs/resources/coupon_recipients.js +15 -3
  68. package/lib/cjs/resources/coupons.d.ts +46 -33
  69. package/lib/cjs/resources/coupons.js +19 -3
  70. package/lib/cjs/resources/custom_promotion_rules.d.ts +61 -0
  71. package/lib/cjs/resources/custom_promotion_rules.js +37 -0
  72. package/lib/cjs/resources/customer_addresses.d.ts +25 -21
  73. package/lib/cjs/resources/customer_addresses.js +15 -3
  74. package/lib/cjs/resources/customer_groups.d.ts +18 -16
  75. package/lib/cjs/resources/customer_groups.js +15 -3
  76. package/lib/cjs/resources/customer_password_resets.d.ts +17 -18
  77. package/lib/cjs/resources/customer_password_resets.js +11 -3
  78. package/lib/cjs/resources/customer_payment_sources.d.ts +51 -45
  79. package/lib/cjs/resources/customer_payment_sources.js +19 -3
  80. package/lib/cjs/resources/customer_subscriptions.d.ts +16 -14
  81. package/lib/cjs/resources/customer_subscriptions.js +15 -3
  82. package/lib/cjs/resources/customers.d.ts +36 -36
  83. package/lib/cjs/resources/customers.js +11 -3
  84. package/lib/cjs/resources/delivery_lead_times.d.ts +28 -26
  85. package/lib/cjs/resources/delivery_lead_times.js +15 -3
  86. package/lib/cjs/resources/event_callbacks.d.ts +14 -15
  87. package/lib/cjs/resources/event_callbacks.js +8 -0
  88. package/lib/cjs/resources/events.d.ts +12 -13
  89. package/lib/cjs/resources/events.js +8 -0
  90. package/lib/cjs/resources/exports.d.ts +26 -27
  91. package/lib/cjs/resources/exports.js +10 -2
  92. package/lib/cjs/resources/external_gateways.d.ts +33 -31
  93. package/lib/cjs/resources/external_gateways.js +15 -3
  94. package/lib/cjs/resources/external_payments.d.ts +24 -22
  95. package/lib/cjs/resources/external_payments.js +15 -3
  96. package/lib/cjs/resources/external_promotions.d.ts +92 -62
  97. package/lib/cjs/resources/external_promotions.js +31 -3
  98. package/lib/cjs/resources/external_tax_calculators.d.ts +20 -18
  99. package/lib/cjs/resources/external_tax_calculators.js +15 -3
  100. package/lib/cjs/resources/fixed_amount_promotions.d.ts +93 -63
  101. package/lib/cjs/resources/fixed_amount_promotions.js +31 -3
  102. package/lib/cjs/resources/fixed_price_promotions.d.ts +89 -70
  103. package/lib/cjs/resources/fixed_price_promotions.js +25 -5
  104. package/lib/cjs/resources/free_gift_promotions.d.ts +88 -69
  105. package/lib/cjs/resources/free_gift_promotions.js +25 -5
  106. package/lib/cjs/resources/free_shipping_promotions.d.ts +86 -59
  107. package/lib/cjs/resources/free_shipping_promotions.js +27 -3
  108. package/lib/cjs/resources/geocoders.d.ts +12 -13
  109. package/lib/cjs/resources/geocoders.js +8 -0
  110. package/lib/cjs/resources/gift_card_recipients.d.ts +27 -25
  111. package/lib/cjs/resources/gift_card_recipients.js +15 -3
  112. package/lib/cjs/resources/gift_cards.d.ts +68 -66
  113. package/lib/cjs/resources/gift_cards.js +15 -3
  114. package/lib/cjs/resources/google_geocoders.d.ts +15 -16
  115. package/lib/cjs/resources/google_geocoders.js +11 -3
  116. package/lib/cjs/resources/imports.d.ts +29 -32
  117. package/lib/cjs/resources/imports.js +10 -2
  118. package/lib/cjs/resources/in_stock_subscriptions.d.ts +37 -35
  119. package/lib/cjs/resources/in_stock_subscriptions.js +15 -3
  120. package/lib/cjs/resources/inventory_models.d.ts +33 -22
  121. package/lib/cjs/resources/inventory_models.js +15 -3
  122. package/lib/cjs/resources/inventory_return_locations.d.ts +23 -21
  123. package/lib/cjs/resources/inventory_return_locations.js +15 -3
  124. package/lib/cjs/resources/inventory_stock_locations.d.ts +26 -24
  125. package/lib/cjs/resources/inventory_stock_locations.js +15 -3
  126. package/lib/cjs/resources/klarna_gateways.d.ts +24 -22
  127. package/lib/cjs/resources/klarna_gateways.js +15 -3
  128. package/lib/cjs/resources/klarna_payments.d.ts +29 -27
  129. package/lib/cjs/resources/klarna_payments.js +15 -3
  130. package/lib/cjs/resources/line_item_options.d.ts +40 -41
  131. package/lib/cjs/resources/line_item_options.js +11 -3
  132. package/lib/cjs/resources/line_items.d.ts +105 -87
  133. package/lib/cjs/resources/line_items.js +19 -3
  134. package/lib/cjs/resources/manual_gateways.d.ts +16 -14
  135. package/lib/cjs/resources/manual_gateways.js +15 -3
  136. package/lib/cjs/resources/manual_tax_calculators.d.ts +22 -20
  137. package/lib/cjs/resources/manual_tax_calculators.js +15 -3
  138. package/lib/cjs/resources/markets.d.ts +66 -59
  139. package/lib/cjs/resources/markets.js +15 -3
  140. package/lib/cjs/resources/merchants.d.ts +20 -18
  141. package/lib/cjs/resources/merchants.js +15 -3
  142. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +40 -31
  143. package/lib/cjs/resources/order_amount_promotion_rules.js +15 -3
  144. package/lib/cjs/resources/order_copies.d.ts +28 -29
  145. package/lib/cjs/resources/order_copies.js +11 -3
  146. package/lib/cjs/resources/order_factories.d.ts +20 -21
  147. package/lib/cjs/resources/order_factories.js +8 -0
  148. package/lib/cjs/resources/order_subscription_items.d.ts +41 -35
  149. package/lib/cjs/resources/order_subscription_items.js +15 -3
  150. package/lib/cjs/resources/order_subscriptions.d.ts +54 -51
  151. package/lib/cjs/resources/order_subscriptions.js +15 -3
  152. package/lib/cjs/resources/order_validation_rules.d.ts +14 -12
  153. package/lib/cjs/resources/order_validation_rules.js +12 -0
  154. package/lib/cjs/resources/orders.d.ts +266 -231
  155. package/lib/cjs/resources/orders.js +39 -3
  156. package/lib/cjs/resources/organization.d.ts +24 -25
  157. package/lib/cjs/resources/organization.js +6 -1
  158. package/lib/cjs/resources/packages.d.ts +32 -30
  159. package/lib/cjs/resources/packages.js +15 -3
  160. package/lib/cjs/resources/parcel_line_items.d.ts +24 -22
  161. package/lib/cjs/resources/parcel_line_items.js +15 -3
  162. package/lib/cjs/resources/parcels.d.ts +95 -93
  163. package/lib/cjs/resources/parcels.js +15 -3
  164. package/lib/cjs/resources/payment_gateways.d.ts +14 -12
  165. package/lib/cjs/resources/payment_gateways.js +12 -0
  166. package/lib/cjs/resources/payment_methods.d.ts +55 -48
  167. package/lib/cjs/resources/payment_methods.js +15 -3
  168. package/lib/cjs/resources/payment_options.d.ts +43 -0
  169. package/lib/cjs/resources/payment_options.js +41 -0
  170. package/lib/cjs/resources/paypal_gateways.d.ts +19 -17
  171. package/lib/cjs/resources/paypal_gateways.js +15 -3
  172. package/lib/cjs/resources/paypal_payments.d.ts +33 -31
  173. package/lib/cjs/resources/paypal_payments.js +15 -3
  174. package/lib/cjs/resources/percentage_discount_promotions.d.ts +88 -69
  175. package/lib/cjs/resources/percentage_discount_promotions.js +25 -5
  176. package/lib/cjs/resources/price_frequency_tiers.d.ts +28 -26
  177. package/lib/cjs/resources/price_frequency_tiers.js +15 -3
  178. package/lib/cjs/resources/price_lists.d.ts +25 -20
  179. package/lib/cjs/resources/price_lists.js +15 -3
  180. package/lib/cjs/resources/price_tiers.d.ts +19 -17
  181. package/lib/cjs/resources/price_tiers.js +12 -0
  182. package/lib/cjs/resources/price_volume_tiers.d.ts +28 -26
  183. package/lib/cjs/resources/price_volume_tiers.js +15 -3
  184. package/lib/cjs/resources/prices.d.ts +42 -40
  185. package/lib/cjs/resources/prices.js +15 -3
  186. package/lib/cjs/resources/promotion_rules.d.ts +14 -10
  187. package/lib/cjs/resources/promotion_rules.js +12 -0
  188. package/lib/cjs/resources/promotions.d.ts +39 -25
  189. package/lib/cjs/resources/promotions.js +24 -0
  190. package/lib/cjs/resources/recurring_order_copies.d.ts +28 -29
  191. package/lib/cjs/resources/recurring_order_copies.js +11 -3
  192. package/lib/cjs/resources/refunds.d.ts +31 -26
  193. package/lib/cjs/resources/refunds.js +18 -2
  194. package/lib/cjs/resources/reserved_stocks.d.ts +27 -0
  195. package/lib/cjs/resources/reserved_stocks.js +36 -0
  196. package/lib/cjs/resources/return_line_items.d.ts +27 -27
  197. package/lib/cjs/resources/return_line_items.js +11 -3
  198. package/lib/cjs/resources/returns.d.ts +51 -49
  199. package/lib/cjs/resources/returns.js +15 -3
  200. package/lib/cjs/resources/satispay_gateways.d.ts +24 -22
  201. package/lib/cjs/resources/satispay_gateways.js +15 -3
  202. package/lib/cjs/resources/satispay_payments.d.ts +31 -21
  203. package/lib/cjs/resources/satispay_payments.js +15 -3
  204. package/lib/cjs/resources/shipments.d.ts +98 -52
  205. package/lib/cjs/resources/shipments.js +27 -1
  206. package/lib/cjs/resources/shipping_categories.d.ts +20 -15
  207. package/lib/cjs/resources/shipping_categories.js +15 -3
  208. package/lib/cjs/resources/shipping_method_tiers.d.ts +19 -17
  209. package/lib/cjs/resources/shipping_method_tiers.js +12 -0
  210. package/lib/cjs/resources/shipping_methods.d.ts +81 -71
  211. package/lib/cjs/resources/shipping_methods.js +15 -3
  212. package/lib/cjs/resources/shipping_weight_tiers.d.ts +27 -25
  213. package/lib/cjs/resources/shipping_weight_tiers.js +15 -3
  214. package/lib/cjs/resources/shipping_zones.d.ts +34 -32
  215. package/lib/cjs/resources/shipping_zones.js +15 -3
  216. package/lib/cjs/resources/sku_list_items.d.ts +28 -26
  217. package/lib/cjs/resources/sku_list_items.js +15 -3
  218. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +44 -38
  219. package/lib/cjs/resources/sku_list_promotion_rules.js +15 -3
  220. package/lib/cjs/resources/sku_lists.d.ts +37 -35
  221. package/lib/cjs/resources/sku_lists.js +15 -3
  222. package/lib/cjs/resources/sku_options.d.ts +45 -43
  223. package/lib/cjs/resources/sku_options.js +15 -3
  224. package/lib/cjs/resources/skus.d.ts +60 -55
  225. package/lib/cjs/resources/skus.js +19 -3
  226. package/lib/cjs/resources/stock_items.d.ts +34 -26
  227. package/lib/cjs/resources/stock_items.js +23 -3
  228. package/lib/cjs/resources/stock_line_items.d.ts +54 -15
  229. package/lib/cjs/resources/stock_line_items.js +25 -0
  230. package/lib/cjs/resources/stock_locations.d.ts +34 -29
  231. package/lib/cjs/resources/stock_locations.js +15 -3
  232. package/lib/cjs/resources/stock_reservations.d.ts +49 -0
  233. package/lib/cjs/resources/stock_reservations.js +53 -0
  234. package/lib/cjs/resources/stock_transfers.d.ts +46 -42
  235. package/lib/cjs/resources/stock_transfers.js +15 -3
  236. package/lib/cjs/resources/stripe_gateways.d.ts +24 -22
  237. package/lib/cjs/resources/stripe_gateways.js +15 -3
  238. package/lib/cjs/resources/stripe_payments.d.ts +39 -28
  239. package/lib/cjs/resources/stripe_payments.js +15 -3
  240. package/lib/cjs/resources/subscription_models.d.ts +26 -27
  241. package/lib/cjs/resources/subscription_models.js +11 -3
  242. package/lib/cjs/resources/tags.d.ts +12 -13
  243. package/lib/cjs/resources/tags.js +11 -3
  244. package/lib/cjs/resources/tax_calculators.d.ts +15 -13
  245. package/lib/cjs/resources/tax_calculators.js +12 -0
  246. package/lib/cjs/resources/tax_categories.d.ts +32 -30
  247. package/lib/cjs/resources/tax_categories.js +15 -3
  248. package/lib/cjs/resources/tax_rules.d.ts +53 -51
  249. package/lib/cjs/resources/tax_rules.js +15 -3
  250. package/lib/cjs/resources/taxjar_accounts.d.ts +23 -21
  251. package/lib/cjs/resources/taxjar_accounts.js +15 -3
  252. package/lib/cjs/resources/transactions.d.ts +30 -22
  253. package/lib/cjs/resources/transactions.js +20 -0
  254. package/lib/cjs/resources/versions.d.ts +22 -0
  255. package/lib/cjs/resources/versions.js +24 -0
  256. package/lib/cjs/resources/voids.d.ts +31 -26
  257. package/lib/cjs/resources/voids.js +18 -2
  258. package/lib/cjs/resources/webhooks.d.ts +33 -26
  259. package/lib/cjs/resources/webhooks.js +15 -3
  260. package/lib/cjs/resources/wire_transfers.d.ts +18 -16
  261. package/lib/cjs/resources/wire_transfers.js +15 -3
  262. package/lib/cjs/static.d.ts +1 -1
  263. package/lib/cjs/util.d.ts +4 -1
  264. package/lib/esm/api.d.ts +9 -23
  265. package/lib/esm/api.js +26 -1
  266. package/lib/esm/client.d.ts +5 -3
  267. package/lib/esm/client.js +8 -11
  268. package/lib/esm/commercelayer.d.ts +11 -5
  269. package/lib/esm/commercelayer.js +9 -3
  270. package/lib/esm/common.d.ts +0 -1
  271. package/lib/esm/common.js +2 -11
  272. package/lib/esm/config.d.ts +0 -1
  273. package/lib/esm/config.js +0 -1
  274. package/lib/esm/debug.js +4 -0
  275. package/lib/esm/error.js +4 -1
  276. package/lib/esm/index.d.ts +1 -1
  277. package/lib/esm/index.js +2 -0
  278. package/lib/esm/interceptor.d.ts +2 -6
  279. package/lib/esm/jsonapi.js +1 -5
  280. package/lib/esm/model.d.ts +9 -3
  281. package/lib/esm/query.d.ts +15 -9
  282. package/lib/esm/query.js +2 -2
  283. package/lib/esm/resource.d.ts +19 -29
  284. package/lib/esm/resource.js +10 -34
  285. package/lib/esm/resources/addresses.d.ts +75 -73
  286. package/lib/esm/resources/addresses.js +15 -3
  287. package/lib/esm/resources/adjustments.d.ts +21 -19
  288. package/lib/esm/resources/adjustments.js +15 -3
  289. package/lib/esm/resources/adyen_gateways.d.ts +36 -34
  290. package/lib/esm/resources/adyen_gateways.js +15 -3
  291. package/lib/esm/resources/adyen_payments.d.ts +29 -27
  292. package/lib/esm/resources/adyen_payments.js +15 -3
  293. package/lib/esm/resources/application.d.ts +13 -14
  294. package/lib/esm/resources/application.js +7 -2
  295. package/lib/esm/resources/attachments.d.ts +80 -81
  296. package/lib/esm/resources/attachments.js +11 -3
  297. package/lib/esm/resources/authorizations.d.ts +49 -44
  298. package/lib/esm/resources/authorizations.js +21 -5
  299. package/lib/esm/resources/avalara_accounts.d.ts +33 -31
  300. package/lib/esm/resources/avalara_accounts.js +15 -3
  301. package/lib/esm/resources/axerve_gateways.d.ts +25 -22
  302. package/lib/esm/resources/axerve_gateways.js +15 -3
  303. package/lib/esm/resources/axerve_payments.d.ts +34 -26
  304. package/lib/esm/resources/axerve_payments.js +15 -3
  305. package/lib/esm/resources/billing_info_validation_rules.d.ts +18 -16
  306. package/lib/esm/resources/billing_info_validation_rules.js +15 -3
  307. package/lib/esm/resources/bing_geocoders.d.ts +15 -16
  308. package/lib/esm/resources/bing_geocoders.js +11 -3
  309. package/lib/esm/resources/braintree_gateways.d.ts +35 -33
  310. package/lib/esm/resources/braintree_gateways.js +15 -3
  311. package/lib/esm/resources/braintree_payments.d.ts +31 -29
  312. package/lib/esm/resources/braintree_payments.js +15 -3
  313. package/lib/esm/resources/bundles.d.ts +58 -56
  314. package/lib/esm/resources/bundles.js +15 -3
  315. package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +134 -0
  316. package/lib/esm/resources/buy_x_pay_y_promotions.js +79 -0
  317. package/lib/esm/resources/captures.d.ts +40 -35
  318. package/lib/esm/resources/captures.js +21 -5
  319. package/lib/esm/resources/carrier_accounts.d.ts +17 -15
  320. package/lib/esm/resources/carrier_accounts.js +12 -0
  321. package/lib/esm/resources/checkout_com_gateways.d.ts +26 -24
  322. package/lib/esm/resources/checkout_com_gateways.js +15 -3
  323. package/lib/esm/resources/checkout_com_payments.d.ts +40 -38
  324. package/lib/esm/resources/checkout_com_payments.js +15 -3
  325. package/lib/esm/resources/cleanups.d.ts +25 -23
  326. package/lib/esm/resources/cleanups.js +14 -2
  327. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +37 -31
  328. package/lib/esm/resources/coupon_codes_promotion_rules.js +15 -3
  329. package/lib/esm/resources/coupon_recipients.d.ts +27 -25
  330. package/lib/esm/resources/coupon_recipients.js +15 -3
  331. package/lib/esm/resources/coupons.d.ts +46 -33
  332. package/lib/esm/resources/coupons.js +19 -3
  333. package/lib/esm/resources/custom_promotion_rules.d.ts +61 -0
  334. package/lib/esm/resources/custom_promotion_rules.js +35 -0
  335. package/lib/esm/resources/customer_addresses.d.ts +25 -21
  336. package/lib/esm/resources/customer_addresses.js +15 -3
  337. package/lib/esm/resources/customer_groups.d.ts +18 -16
  338. package/lib/esm/resources/customer_groups.js +15 -3
  339. package/lib/esm/resources/customer_password_resets.d.ts +17 -18
  340. package/lib/esm/resources/customer_password_resets.js +11 -3
  341. package/lib/esm/resources/customer_payment_sources.d.ts +51 -45
  342. package/lib/esm/resources/customer_payment_sources.js +19 -3
  343. package/lib/esm/resources/customer_subscriptions.d.ts +16 -14
  344. package/lib/esm/resources/customer_subscriptions.js +15 -3
  345. package/lib/esm/resources/customers.d.ts +36 -36
  346. package/lib/esm/resources/customers.js +11 -3
  347. package/lib/esm/resources/delivery_lead_times.d.ts +28 -26
  348. package/lib/esm/resources/delivery_lead_times.js +15 -3
  349. package/lib/esm/resources/event_callbacks.d.ts +14 -15
  350. package/lib/esm/resources/event_callbacks.js +8 -0
  351. package/lib/esm/resources/events.d.ts +12 -13
  352. package/lib/esm/resources/events.js +8 -0
  353. package/lib/esm/resources/exports.d.ts +26 -27
  354. package/lib/esm/resources/exports.js +10 -2
  355. package/lib/esm/resources/external_gateways.d.ts +33 -31
  356. package/lib/esm/resources/external_gateways.js +15 -3
  357. package/lib/esm/resources/external_payments.d.ts +24 -22
  358. package/lib/esm/resources/external_payments.js +15 -3
  359. package/lib/esm/resources/external_promotions.d.ts +92 -62
  360. package/lib/esm/resources/external_promotions.js +31 -3
  361. package/lib/esm/resources/external_tax_calculators.d.ts +20 -18
  362. package/lib/esm/resources/external_tax_calculators.js +15 -3
  363. package/lib/esm/resources/fixed_amount_promotions.d.ts +93 -63
  364. package/lib/esm/resources/fixed_amount_promotions.js +31 -3
  365. package/lib/esm/resources/fixed_price_promotions.d.ts +89 -70
  366. package/lib/esm/resources/fixed_price_promotions.js +25 -5
  367. package/lib/esm/resources/free_gift_promotions.d.ts +88 -69
  368. package/lib/esm/resources/free_gift_promotions.js +25 -5
  369. package/lib/esm/resources/free_shipping_promotions.d.ts +86 -59
  370. package/lib/esm/resources/free_shipping_promotions.js +27 -3
  371. package/lib/esm/resources/geocoders.d.ts +12 -13
  372. package/lib/esm/resources/geocoders.js +8 -0
  373. package/lib/esm/resources/gift_card_recipients.d.ts +27 -25
  374. package/lib/esm/resources/gift_card_recipients.js +15 -3
  375. package/lib/esm/resources/gift_cards.d.ts +68 -66
  376. package/lib/esm/resources/gift_cards.js +15 -3
  377. package/lib/esm/resources/google_geocoders.d.ts +15 -16
  378. package/lib/esm/resources/google_geocoders.js +11 -3
  379. package/lib/esm/resources/imports.d.ts +29 -32
  380. package/lib/esm/resources/imports.js +10 -2
  381. package/lib/esm/resources/in_stock_subscriptions.d.ts +37 -35
  382. package/lib/esm/resources/in_stock_subscriptions.js +15 -3
  383. package/lib/esm/resources/inventory_models.d.ts +33 -22
  384. package/lib/esm/resources/inventory_models.js +15 -3
  385. package/lib/esm/resources/inventory_return_locations.d.ts +23 -21
  386. package/lib/esm/resources/inventory_return_locations.js +15 -3
  387. package/lib/esm/resources/inventory_stock_locations.d.ts +26 -24
  388. package/lib/esm/resources/inventory_stock_locations.js +15 -3
  389. package/lib/esm/resources/klarna_gateways.d.ts +24 -22
  390. package/lib/esm/resources/klarna_gateways.js +15 -3
  391. package/lib/esm/resources/klarna_payments.d.ts +29 -27
  392. package/lib/esm/resources/klarna_payments.js +15 -3
  393. package/lib/esm/resources/line_item_options.d.ts +40 -41
  394. package/lib/esm/resources/line_item_options.js +11 -3
  395. package/lib/esm/resources/line_items.d.ts +105 -87
  396. package/lib/esm/resources/line_items.js +19 -3
  397. package/lib/esm/resources/manual_gateways.d.ts +16 -14
  398. package/lib/esm/resources/manual_gateways.js +15 -3
  399. package/lib/esm/resources/manual_tax_calculators.d.ts +22 -20
  400. package/lib/esm/resources/manual_tax_calculators.js +15 -3
  401. package/lib/esm/resources/markets.d.ts +66 -59
  402. package/lib/esm/resources/markets.js +15 -3
  403. package/lib/esm/resources/merchants.d.ts +20 -18
  404. package/lib/esm/resources/merchants.js +15 -3
  405. package/lib/esm/resources/order_amount_promotion_rules.d.ts +40 -31
  406. package/lib/esm/resources/order_amount_promotion_rules.js +15 -3
  407. package/lib/esm/resources/order_copies.d.ts +28 -29
  408. package/lib/esm/resources/order_copies.js +11 -3
  409. package/lib/esm/resources/order_factories.d.ts +20 -21
  410. package/lib/esm/resources/order_factories.js +8 -0
  411. package/lib/esm/resources/order_subscription_items.d.ts +41 -35
  412. package/lib/esm/resources/order_subscription_items.js +15 -3
  413. package/lib/esm/resources/order_subscriptions.d.ts +54 -51
  414. package/lib/esm/resources/order_subscriptions.js +15 -3
  415. package/lib/esm/resources/order_validation_rules.d.ts +14 -12
  416. package/lib/esm/resources/order_validation_rules.js +12 -0
  417. package/lib/esm/resources/orders.d.ts +266 -231
  418. package/lib/esm/resources/orders.js +39 -3
  419. package/lib/esm/resources/organization.d.ts +24 -25
  420. package/lib/esm/resources/organization.js +7 -2
  421. package/lib/esm/resources/packages.d.ts +32 -30
  422. package/lib/esm/resources/packages.js +15 -3
  423. package/lib/esm/resources/parcel_line_items.d.ts +24 -22
  424. package/lib/esm/resources/parcel_line_items.js +15 -3
  425. package/lib/esm/resources/parcels.d.ts +95 -93
  426. package/lib/esm/resources/parcels.js +15 -3
  427. package/lib/esm/resources/payment_gateways.d.ts +14 -12
  428. package/lib/esm/resources/payment_gateways.js +12 -0
  429. package/lib/esm/resources/payment_methods.d.ts +55 -48
  430. package/lib/esm/resources/payment_methods.js +15 -3
  431. package/lib/esm/resources/payment_options.d.ts +43 -0
  432. package/lib/esm/resources/payment_options.js +39 -0
  433. package/lib/esm/resources/paypal_gateways.d.ts +19 -17
  434. package/lib/esm/resources/paypal_gateways.js +15 -3
  435. package/lib/esm/resources/paypal_payments.d.ts +33 -31
  436. package/lib/esm/resources/paypal_payments.js +15 -3
  437. package/lib/esm/resources/percentage_discount_promotions.d.ts +88 -69
  438. package/lib/esm/resources/percentage_discount_promotions.js +25 -5
  439. package/lib/esm/resources/price_frequency_tiers.d.ts +28 -26
  440. package/lib/esm/resources/price_frequency_tiers.js +15 -3
  441. package/lib/esm/resources/price_lists.d.ts +25 -20
  442. package/lib/esm/resources/price_lists.js +15 -3
  443. package/lib/esm/resources/price_tiers.d.ts +19 -17
  444. package/lib/esm/resources/price_tiers.js +12 -0
  445. package/lib/esm/resources/price_volume_tiers.d.ts +28 -26
  446. package/lib/esm/resources/price_volume_tiers.js +15 -3
  447. package/lib/esm/resources/prices.d.ts +42 -40
  448. package/lib/esm/resources/prices.js +15 -3
  449. package/lib/esm/resources/promotion_rules.d.ts +14 -10
  450. package/lib/esm/resources/promotion_rules.js +12 -0
  451. package/lib/esm/resources/promotions.d.ts +39 -25
  452. package/lib/esm/resources/promotions.js +24 -0
  453. package/lib/esm/resources/recurring_order_copies.d.ts +28 -29
  454. package/lib/esm/resources/recurring_order_copies.js +11 -3
  455. package/lib/esm/resources/refunds.d.ts +31 -26
  456. package/lib/esm/resources/refunds.js +18 -2
  457. package/lib/esm/resources/reserved_stocks.d.ts +27 -0
  458. package/lib/esm/resources/reserved_stocks.js +34 -0
  459. package/lib/esm/resources/return_line_items.d.ts +27 -27
  460. package/lib/esm/resources/return_line_items.js +11 -3
  461. package/lib/esm/resources/returns.d.ts +51 -49
  462. package/lib/esm/resources/returns.js +15 -3
  463. package/lib/esm/resources/satispay_gateways.d.ts +24 -22
  464. package/lib/esm/resources/satispay_gateways.js +15 -3
  465. package/lib/esm/resources/satispay_payments.d.ts +31 -21
  466. package/lib/esm/resources/satispay_payments.js +15 -3
  467. package/lib/esm/resources/shipments.d.ts +98 -52
  468. package/lib/esm/resources/shipments.js +27 -1
  469. package/lib/esm/resources/shipping_categories.d.ts +20 -15
  470. package/lib/esm/resources/shipping_categories.js +15 -3
  471. package/lib/esm/resources/shipping_method_tiers.d.ts +19 -17
  472. package/lib/esm/resources/shipping_method_tiers.js +12 -0
  473. package/lib/esm/resources/shipping_methods.d.ts +81 -71
  474. package/lib/esm/resources/shipping_methods.js +15 -3
  475. package/lib/esm/resources/shipping_weight_tiers.d.ts +27 -25
  476. package/lib/esm/resources/shipping_weight_tiers.js +15 -3
  477. package/lib/esm/resources/shipping_zones.d.ts +34 -32
  478. package/lib/esm/resources/shipping_zones.js +15 -3
  479. package/lib/esm/resources/sku_list_items.d.ts +28 -26
  480. package/lib/esm/resources/sku_list_items.js +15 -3
  481. package/lib/esm/resources/sku_list_promotion_rules.d.ts +44 -38
  482. package/lib/esm/resources/sku_list_promotion_rules.js +15 -3
  483. package/lib/esm/resources/sku_lists.d.ts +37 -35
  484. package/lib/esm/resources/sku_lists.js +15 -3
  485. package/lib/esm/resources/sku_options.d.ts +45 -43
  486. package/lib/esm/resources/sku_options.js +15 -3
  487. package/lib/esm/resources/skus.d.ts +60 -55
  488. package/lib/esm/resources/skus.js +19 -3
  489. package/lib/esm/resources/stock_items.d.ts +34 -26
  490. package/lib/esm/resources/stock_items.js +23 -3
  491. package/lib/esm/resources/stock_line_items.d.ts +54 -15
  492. package/lib/esm/resources/stock_line_items.js +25 -0
  493. package/lib/esm/resources/stock_locations.d.ts +34 -29
  494. package/lib/esm/resources/stock_locations.js +15 -3
  495. package/lib/esm/resources/stock_reservations.d.ts +49 -0
  496. package/lib/esm/resources/stock_reservations.js +51 -0
  497. package/lib/esm/resources/stock_transfers.d.ts +46 -42
  498. package/lib/esm/resources/stock_transfers.js +15 -3
  499. package/lib/esm/resources/stripe_gateways.d.ts +24 -22
  500. package/lib/esm/resources/stripe_gateways.js +15 -3
  501. package/lib/esm/resources/stripe_payments.d.ts +39 -28
  502. package/lib/esm/resources/stripe_payments.js +15 -3
  503. package/lib/esm/resources/subscription_models.d.ts +26 -27
  504. package/lib/esm/resources/subscription_models.js +11 -3
  505. package/lib/esm/resources/tags.d.ts +12 -13
  506. package/lib/esm/resources/tags.js +11 -3
  507. package/lib/esm/resources/tax_calculators.d.ts +15 -13
  508. package/lib/esm/resources/tax_calculators.js +12 -0
  509. package/lib/esm/resources/tax_categories.d.ts +32 -30
  510. package/lib/esm/resources/tax_categories.js +15 -3
  511. package/lib/esm/resources/tax_rules.d.ts +53 -51
  512. package/lib/esm/resources/tax_rules.js +15 -3
  513. package/lib/esm/resources/taxjar_accounts.d.ts +23 -21
  514. package/lib/esm/resources/taxjar_accounts.js +15 -3
  515. package/lib/esm/resources/transactions.d.ts +30 -22
  516. package/lib/esm/resources/transactions.js +20 -0
  517. package/lib/esm/resources/versions.d.ts +22 -0
  518. package/lib/esm/resources/versions.js +22 -0
  519. package/lib/esm/resources/voids.d.ts +31 -26
  520. package/lib/esm/resources/voids.js +18 -2
  521. package/lib/esm/resources/webhooks.d.ts +33 -26
  522. package/lib/esm/resources/webhooks.js +15 -3
  523. package/lib/esm/resources/wire_transfers.d.ts +18 -16
  524. package/lib/esm/resources/wire_transfers.js +15 -3
  525. package/lib/esm/static.d.ts +1 -1
  526. package/lib/esm/util.d.ts +4 -1
  527. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  528. package/lib/tsconfig.tsbuildinfo +1 -1
  529. package/package.json +25 -25
  530. package/lib/cjs/micro.d.ts +0 -4
  531. package/lib/cjs/micro.js +0 -13
  532. package/lib/esm/micro.d.ts +0 -4
  533. package/lib/esm/micro.js +0 -7
@@ -1,109 +1,128 @@
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 { Market, MarketType } from './markets';
5
- import type { PromotionRule, PromotionRuleType } from './promotion_rules';
6
- import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
7
- import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
8
- import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
1
+ import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
+ import type { QueryParamsList, QueryParamsRetrieve } from '../query';
3
+ import type { Market } from './markets';
4
+ import type { PromotionRule } from './promotion_rules';
5
+ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
6
+ import type { SkuListPromotionRule } from './sku_list_promotion_rules';
7
+ import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
8
+ import type { CustomPromotionRule } from './custom_promotion_rules';
9
+ import type { SkuList } from './sku_lists';
10
+ import type { Coupon } from './coupons';
9
11
  import type { Attachment } from './attachments';
10
12
  import type { Event } from './events';
11
- import type { Tag, TagType } from './tags';
12
- import type { SkuList, SkuListType } from './sku_lists';
13
+ import type { Tag } from './tags';
14
+ import type { Version } from './versions';
13
15
  import type { Sku } from './skus';
14
- type FreeGiftPromotionType = 'free_gift_promotions';
15
16
  type FreeGiftPromotionRel = ResourceRel & {
16
- type: FreeGiftPromotionType;
17
+ type: typeof FreeGiftPromotions.TYPE;
17
18
  };
18
19
  type MarketRel = ResourceRel & {
19
- type: MarketType;
20
- };
21
- type PromotionRuleRel = ResourceRel & {
22
- type: PromotionRuleType;
20
+ type: 'markets';
23
21
  };
24
22
  type OrderAmountPromotionRuleRel = ResourceRel & {
25
- type: OrderAmountPromotionRuleType;
23
+ type: 'order_amount_promotion_rules';
26
24
  };
27
25
  type SkuListPromotionRuleRel = ResourceRel & {
28
- type: SkuListPromotionRuleType;
26
+ type: 'sku_list_promotion_rules';
29
27
  };
30
28
  type CouponCodesPromotionRuleRel = ResourceRel & {
31
- type: CouponCodesPromotionRuleType;
29
+ type: 'coupon_codes_promotion_rules';
32
30
  };
33
- type TagRel = ResourceRel & {
34
- type: TagType;
31
+ type CustomPromotionRuleRel = ResourceRel & {
32
+ type: 'custom_promotion_rules';
35
33
  };
36
34
  type SkuListRel = ResourceRel & {
37
- type: SkuListType;
35
+ type: 'sku_lists';
36
+ };
37
+ type TagRel = ResourceRel & {
38
+ type: 'tags';
38
39
  };
39
40
  interface FreeGiftPromotion extends Resource {
40
- readonly type: FreeGiftPromotionType;
41
- name: string;
42
- currency_code?: string | null;
43
- starts_at: string;
44
- expires_at: string;
45
- total_usage_limit: number;
46
- total_usage_count?: number | null;
47
- active?: boolean | null;
48
- max_quantity?: number | null;
49
- market?: Market | null;
50
- promotion_rules?: PromotionRule[] | null;
51
- order_amount_promotion_rule?: OrderAmountPromotionRule | null;
52
- sku_list_promotion_rule?: SkuListPromotionRule | null;
53
- coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
54
- attachments?: Attachment[] | null;
55
- events?: Event[] | null;
56
- tags?: Tag[] | null;
57
- sku_list?: SkuList | null;
58
- skus?: Sku[] | null;
41
+ name?: string;
42
+ currency_code?: string;
43
+ exclusive?: boolean;
44
+ priority?: number;
45
+ starts_at?: string;
46
+ expires_at?: string;
47
+ total_usage_limit?: number;
48
+ total_usage_count?: number;
49
+ active?: boolean;
50
+ disabled_at?: string;
51
+ max_quantity?: number;
52
+ market?: Market;
53
+ promotion_rules?: PromotionRule[];
54
+ order_amount_promotion_rule?: OrderAmountPromotionRule;
55
+ sku_list_promotion_rule?: SkuListPromotionRule;
56
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule;
57
+ custom_promotion_rule?: CustomPromotionRule;
58
+ sku_list?: SkuList;
59
+ coupons?: Coupon[];
60
+ attachments?: Attachment[];
61
+ events?: Event[];
62
+ tags?: Tag[];
63
+ versions?: Version[];
64
+ skus?: Sku[];
59
65
  }
60
66
  interface FreeGiftPromotionCreate extends ResourceCreate {
61
67
  name: string;
62
- currency_code?: string | null;
68
+ currency_code?: string;
69
+ exclusive?: boolean;
70
+ priority?: number;
63
71
  starts_at: string;
64
72
  expires_at: string;
65
- total_usage_limit: number;
66
- max_quantity?: number | null;
67
- market?: MarketRel | null;
68
- promotion_rules?: PromotionRuleRel[] | null;
69
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
70
- sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
71
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
72
- tags?: TagRel[] | null;
73
+ total_usage_limit?: number;
74
+ _disable?: boolean;
75
+ _enable?: boolean;
76
+ max_quantity?: number;
77
+ market?: MarketRel;
78
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
79
+ sku_list_promotion_rule?: SkuListPromotionRuleRel;
80
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
81
+ custom_promotion_rule?: CustomPromotionRuleRel;
73
82
  sku_list: SkuListRel;
83
+ tags?: TagRel[];
74
84
  }
75
85
  interface FreeGiftPromotionUpdate extends ResourceUpdate {
76
- name?: string | null;
77
- currency_code?: string | null;
78
- starts_at?: string | null;
79
- expires_at?: string | null;
80
- total_usage_limit?: number | null;
81
- max_quantity?: number | null;
82
- market?: MarketRel | null;
83
- promotion_rules?: PromotionRuleRel[] | null;
84
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
85
- sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
86
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
87
- tags?: TagRel[] | null;
88
- sku_list?: SkuListRel | null;
86
+ name?: string;
87
+ currency_code?: string;
88
+ exclusive?: boolean;
89
+ priority?: number;
90
+ starts_at?: string;
91
+ expires_at?: string;
92
+ total_usage_limit?: number;
93
+ _disable?: boolean;
94
+ _enable?: boolean;
95
+ max_quantity?: number;
96
+ market?: MarketRel;
97
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
98
+ sku_list_promotion_rule?: SkuListPromotionRuleRel;
99
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
100
+ custom_promotion_rule?: CustomPromotionRuleRel;
101
+ sku_list?: SkuListRel;
102
+ tags?: TagRel[];
89
103
  }
90
- declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
91
- static readonly TYPE: FreeGiftPromotionType;
104
+ declare class FreeGiftPromotions extends ApiResource {
105
+ static readonly TYPE: 'free_gift_promotions';
106
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<FreeGiftPromotion>>;
92
107
  create(resource: FreeGiftPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
108
+ retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
93
109
  update(resource: FreeGiftPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
94
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
110
+ delete(id: string, options?: ResourcesConfig): Promise<void>;
95
111
  market(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
96
112
  order_amount_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
97
113
  sku_list_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
98
114
  coupon_codes_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
115
+ custom_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
116
+ sku_list(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
117
+ coupons(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
99
118
  attachments(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
100
119
  events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
101
120
  tags(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
102
- sku_list(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
121
+ versions(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
103
122
  skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
104
123
  isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
105
124
  relationship(id: string | ResourceId | null): FreeGiftPromotionRel;
106
- type(): FreeGiftPromotionType;
125
+ type(): string;
107
126
  }
108
127
  export default FreeGiftPromotions;
109
- export type { FreeGiftPromotion, FreeGiftPromotionCreate, FreeGiftPromotionUpdate, FreeGiftPromotionType };
128
+ export { FreeGiftPromotion, FreeGiftPromotionCreate, FreeGiftPromotionUpdate };
@@ -1,13 +1,20 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class FreeGiftPromotions extends ApiResource {
3
+ // static readonly PATH = 'free_gift_promotions'
4
+ async list(params, options) {
5
+ return this.resources.list({ type: FreeGiftPromotions.TYPE }, params, options);
6
+ }
3
7
  async create(resource, params, options) {
4
- return this.resources.create({ ...resource, type: FreeGiftPromotions.TYPE }, params, options);
8
+ return this.resources.create(Object.assign(Object.assign({}, resource), { type: FreeGiftPromotions.TYPE }), params, options);
9
+ }
10
+ async retrieve(id, params, options) {
11
+ return this.resources.retrieve({ type: FreeGiftPromotions.TYPE, id }, params, options);
5
12
  }
6
13
  async update(resource, params, options) {
7
- return this.resources.update({ ...resource, type: FreeGiftPromotions.TYPE }, params, options);
14
+ return this.resources.update(Object.assign(Object.assign({}, resource), { type: FreeGiftPromotions.TYPE }), params, options);
8
15
  }
9
16
  async delete(id, options) {
10
- await this.resources.delete((typeof id === 'string') ? { id, type: FreeGiftPromotions.TYPE } : id, options);
17
+ await this.resources.delete({ type: FreeGiftPromotions.TYPE, id }, options);
11
18
  }
12
19
  async market(freeGiftPromotionId, params, options) {
13
20
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
@@ -25,6 +32,18 @@ class FreeGiftPromotions extends ApiResource {
25
32
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
26
33
  return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `free_gift_promotions/${_freeGiftPromotionId}/coupon_codes_promotion_rule`, params, options);
27
34
  }
35
+ async custom_promotion_rule(freeGiftPromotionId, params, options) {
36
+ const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
37
+ return this.resources.fetch({ type: 'custom_promotion_rules' }, `free_gift_promotions/${_freeGiftPromotionId}/custom_promotion_rule`, params, options);
38
+ }
39
+ async sku_list(freeGiftPromotionId, params, options) {
40
+ const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
41
+ return this.resources.fetch({ type: 'sku_lists' }, `free_gift_promotions/${_freeGiftPromotionId}/sku_list`, params, options);
42
+ }
43
+ async coupons(freeGiftPromotionId, params, options) {
44
+ const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
45
+ return this.resources.fetch({ type: 'coupons' }, `free_gift_promotions/${_freeGiftPromotionId}/coupons`, params, options);
46
+ }
28
47
  async attachments(freeGiftPromotionId, params, options) {
29
48
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
30
49
  return this.resources.fetch({ type: 'attachments' }, `free_gift_promotions/${_freeGiftPromotionId}/attachments`, params, options);
@@ -37,14 +56,15 @@ class FreeGiftPromotions extends ApiResource {
37
56
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
38
57
  return this.resources.fetch({ type: 'tags' }, `free_gift_promotions/${_freeGiftPromotionId}/tags`, params, options);
39
58
  }
40
- async sku_list(freeGiftPromotionId, params, options) {
59
+ async versions(freeGiftPromotionId, params, options) {
41
60
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
42
- return this.resources.fetch({ type: 'sku_lists' }, `free_gift_promotions/${_freeGiftPromotionId}/sku_list`, params, options);
61
+ return this.resources.fetch({ type: 'versions' }, `free_gift_promotions/${_freeGiftPromotionId}/versions`, params, options);
43
62
  }
44
63
  async skus(freeGiftPromotionId, params, options) {
45
64
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
46
65
  return this.resources.fetch({ type: 'skus' }, `free_gift_promotions/${_freeGiftPromotionId}/skus`, params, options);
47
66
  }
67
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
48
68
  isFreeGiftPromotion(resource) {
49
69
  return resource.type && (resource.type === FreeGiftPromotions.TYPE);
50
70
  }
@@ -1,95 +1,122 @@
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 { Market, MarketType } from './markets';
5
- import type { PromotionRule, PromotionRuleType } from './promotion_rules';
6
- import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
7
- import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
8
- import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
1
+ import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
+ import type { QueryParamsList, QueryParamsRetrieve } from '../query';
3
+ import type { Market } from './markets';
4
+ import type { PromotionRule } from './promotion_rules';
5
+ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
6
+ import type { SkuListPromotionRule } from './sku_list_promotion_rules';
7
+ import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
8
+ import type { CustomPromotionRule } from './custom_promotion_rules';
9
+ import type { SkuList } from './sku_lists';
10
+ import type { Coupon } from './coupons';
9
11
  import type { Attachment } from './attachments';
10
12
  import type { Event } from './events';
11
- import type { Tag, TagType } from './tags';
12
- type FreeShippingPromotionType = 'free_shipping_promotions';
13
+ import type { Tag } from './tags';
14
+ import type { Version } from './versions';
13
15
  type FreeShippingPromotionRel = ResourceRel & {
14
- type: FreeShippingPromotionType;
16
+ type: typeof FreeShippingPromotions.TYPE;
15
17
  };
16
18
  type MarketRel = ResourceRel & {
17
- type: MarketType;
18
- };
19
- type PromotionRuleRel = ResourceRel & {
20
- type: PromotionRuleType;
19
+ type: 'markets';
21
20
  };
22
21
  type OrderAmountPromotionRuleRel = ResourceRel & {
23
- type: OrderAmountPromotionRuleType;
22
+ type: 'order_amount_promotion_rules';
24
23
  };
25
24
  type SkuListPromotionRuleRel = ResourceRel & {
26
- type: SkuListPromotionRuleType;
25
+ type: 'sku_list_promotion_rules';
27
26
  };
28
27
  type CouponCodesPromotionRuleRel = ResourceRel & {
29
- type: CouponCodesPromotionRuleType;
28
+ type: 'coupon_codes_promotion_rules';
29
+ };
30
+ type CustomPromotionRuleRel = ResourceRel & {
31
+ type: 'custom_promotion_rules';
32
+ };
33
+ type SkuListRel = ResourceRel & {
34
+ type: 'sku_lists';
30
35
  };
31
36
  type TagRel = ResourceRel & {
32
- type: TagType;
37
+ type: 'tags';
33
38
  };
34
39
  interface FreeShippingPromotion extends Resource {
35
- readonly type: FreeShippingPromotionType;
36
- name: string;
37
- currency_code?: string | null;
38
- starts_at: string;
39
- expires_at: string;
40
- total_usage_limit: number;
41
- total_usage_count?: number | null;
42
- active?: boolean | null;
43
- market?: Market | null;
44
- promotion_rules?: PromotionRule[] | null;
45
- order_amount_promotion_rule?: OrderAmountPromotionRule | null;
46
- sku_list_promotion_rule?: SkuListPromotionRule | null;
47
- coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
48
- attachments?: Attachment[] | null;
49
- events?: Event[] | null;
50
- tags?: Tag[] | null;
40
+ name?: string;
41
+ currency_code?: string;
42
+ exclusive?: boolean;
43
+ priority?: number;
44
+ starts_at?: string;
45
+ expires_at?: string;
46
+ total_usage_limit?: number;
47
+ total_usage_count?: number;
48
+ active?: boolean;
49
+ disabled_at?: string;
50
+ market?: Market;
51
+ promotion_rules?: PromotionRule[];
52
+ order_amount_promotion_rule?: OrderAmountPromotionRule;
53
+ sku_list_promotion_rule?: SkuListPromotionRule;
54
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule;
55
+ custom_promotion_rule?: CustomPromotionRule;
56
+ sku_list?: SkuList;
57
+ coupons?: Coupon[];
58
+ attachments?: Attachment[];
59
+ events?: Event[];
60
+ tags?: Tag[];
61
+ versions?: Version[];
51
62
  }
52
63
  interface FreeShippingPromotionCreate extends ResourceCreate {
53
64
  name: string;
54
- currency_code?: string | null;
65
+ currency_code?: string;
66
+ exclusive?: boolean;
67
+ priority?: number;
55
68
  starts_at: string;
56
69
  expires_at: string;
57
- total_usage_limit: number;
58
- market?: MarketRel | null;
59
- promotion_rules?: PromotionRuleRel[] | null;
60
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
61
- sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
62
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
63
- tags?: TagRel[] | null;
70
+ total_usage_limit?: number;
71
+ _disable?: boolean;
72
+ _enable?: boolean;
73
+ market?: MarketRel;
74
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
75
+ sku_list_promotion_rule?: SkuListPromotionRuleRel;
76
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
77
+ custom_promotion_rule?: CustomPromotionRuleRel;
78
+ sku_list?: SkuListRel;
79
+ tags?: TagRel[];
64
80
  }
65
81
  interface FreeShippingPromotionUpdate extends ResourceUpdate {
66
- name?: string | null;
67
- currency_code?: string | null;
68
- starts_at?: string | null;
69
- expires_at?: string | null;
70
- total_usage_limit?: number | null;
71
- market?: MarketRel | null;
72
- promotion_rules?: PromotionRuleRel[] | null;
73
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
74
- sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
75
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
76
- tags?: TagRel[] | null;
82
+ name?: string;
83
+ currency_code?: string;
84
+ exclusive?: boolean;
85
+ priority?: number;
86
+ starts_at?: string;
87
+ expires_at?: string;
88
+ total_usage_limit?: number;
89
+ _disable?: boolean;
90
+ _enable?: boolean;
91
+ market?: MarketRel;
92
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
93
+ sku_list_promotion_rule?: SkuListPromotionRuleRel;
94
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
95
+ custom_promotion_rule?: CustomPromotionRuleRel;
96
+ sku_list?: SkuListRel;
97
+ tags?: TagRel[];
77
98
  }
78
- declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion> {
79
- static readonly TYPE: FreeShippingPromotionType;
99
+ declare class FreeShippingPromotions extends ApiResource {
100
+ static readonly TYPE: 'free_shipping_promotions';
101
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<FreeShippingPromotion>>;
80
102
  create(resource: FreeShippingPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
103
+ retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
81
104
  update(resource: FreeShippingPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
82
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
105
+ delete(id: string, options?: ResourcesConfig): Promise<void>;
83
106
  market(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
84
107
  order_amount_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
85
108
  sku_list_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
86
109
  coupon_codes_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
110
+ custom_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
111
+ sku_list(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
112
+ coupons(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
87
113
  attachments(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
88
114
  events(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
89
115
  tags(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
116
+ versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
90
117
  isFreeShippingPromotion(resource: any): resource is FreeShippingPromotion;
91
118
  relationship(id: string | ResourceId | null): FreeShippingPromotionRel;
92
- type(): FreeShippingPromotionType;
119
+ type(): string;
93
120
  }
94
121
  export default FreeShippingPromotions;
95
- export type { FreeShippingPromotion, FreeShippingPromotionCreate, FreeShippingPromotionUpdate, FreeShippingPromotionType };
122
+ export { FreeShippingPromotion, FreeShippingPromotionCreate, FreeShippingPromotionUpdate };
@@ -1,13 +1,20 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class FreeShippingPromotions extends ApiResource {
3
+ // static readonly PATH = 'free_shipping_promotions'
4
+ async list(params, options) {
5
+ return this.resources.list({ type: FreeShippingPromotions.TYPE }, params, options);
6
+ }
3
7
  async create(resource, params, options) {
4
- return this.resources.create({ ...resource, type: FreeShippingPromotions.TYPE }, params, options);
8
+ return this.resources.create(Object.assign(Object.assign({}, resource), { type: FreeShippingPromotions.TYPE }), params, options);
9
+ }
10
+ async retrieve(id, params, options) {
11
+ return this.resources.retrieve({ type: FreeShippingPromotions.TYPE, id }, params, options);
5
12
  }
6
13
  async update(resource, params, options) {
7
- return this.resources.update({ ...resource, type: FreeShippingPromotions.TYPE }, params, options);
14
+ return this.resources.update(Object.assign(Object.assign({}, resource), { type: FreeShippingPromotions.TYPE }), params, options);
8
15
  }
9
16
  async delete(id, options) {
10
- await this.resources.delete((typeof id === 'string') ? { id, type: FreeShippingPromotions.TYPE } : id, options);
17
+ await this.resources.delete({ type: FreeShippingPromotions.TYPE, id }, options);
11
18
  }
12
19
  async market(freeShippingPromotionId, params, options) {
13
20
  const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
@@ -25,6 +32,18 @@ class FreeShippingPromotions extends ApiResource {
25
32
  const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
26
33
  return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `free_shipping_promotions/${_freeShippingPromotionId}/coupon_codes_promotion_rule`, params, options);
27
34
  }
35
+ async custom_promotion_rule(freeShippingPromotionId, params, options) {
36
+ const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
37
+ return this.resources.fetch({ type: 'custom_promotion_rules' }, `free_shipping_promotions/${_freeShippingPromotionId}/custom_promotion_rule`, params, options);
38
+ }
39
+ async sku_list(freeShippingPromotionId, params, options) {
40
+ const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
41
+ return this.resources.fetch({ type: 'sku_lists' }, `free_shipping_promotions/${_freeShippingPromotionId}/sku_list`, params, options);
42
+ }
43
+ async coupons(freeShippingPromotionId, params, options) {
44
+ const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
45
+ return this.resources.fetch({ type: 'coupons' }, `free_shipping_promotions/${_freeShippingPromotionId}/coupons`, params, options);
46
+ }
28
47
  async attachments(freeShippingPromotionId, params, options) {
29
48
  const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
30
49
  return this.resources.fetch({ type: 'attachments' }, `free_shipping_promotions/${_freeShippingPromotionId}/attachments`, params, options);
@@ -37,6 +56,11 @@ class FreeShippingPromotions extends ApiResource {
37
56
  const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
38
57
  return this.resources.fetch({ type: 'tags' }, `free_shipping_promotions/${_freeShippingPromotionId}/tags`, params, options);
39
58
  }
59
+ async versions(freeShippingPromotionId, params, options) {
60
+ const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
61
+ return this.resources.fetch({ type: 'versions' }, `free_shipping_promotions/${_freeShippingPromotionId}/versions`, params, options);
62
+ }
63
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
40
64
  isFreeShippingPromotion(resource) {
41
65
  return resource.type && (resource.type === FreeShippingPromotions.TYPE);
42
66
  }
@@ -1,25 +1,24 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsList } from '../query';
1
+ import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
+ import type { QueryParamsList, QueryParamsRetrieve } from '../query';
4
3
  import type { Address } from './addresses';
5
4
  import type { Attachment } from './attachments';
6
- type GeocoderType = 'geocoders';
7
5
  type GeocoderRel = ResourceRel & {
8
- type: GeocoderType;
6
+ type: typeof Geocoders.TYPE;
9
7
  };
10
8
  interface Geocoder extends Resource {
11
- readonly type: GeocoderType;
12
- name: string;
13
- addresses?: Address[] | null;
14
- attachments?: Attachment[] | null;
9
+ name?: string;
10
+ addresses?: Address[];
11
+ attachments?: Attachment[];
15
12
  }
16
- declare class Geocoders extends ApiResource<Geocoder> {
17
- static readonly TYPE: GeocoderType;
13
+ declare class Geocoders extends ApiResource {
14
+ static readonly TYPE: 'geocoders';
15
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Geocoder>>;
16
+ retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
18
17
  addresses(geocoderId: string | Geocoder, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
19
18
  attachments(geocoderId: string | Geocoder, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
20
19
  isGeocoder(resource: any): resource is Geocoder;
21
20
  relationship(id: string | ResourceId | null): GeocoderRel;
22
- type(): GeocoderType;
21
+ type(): string;
23
22
  }
24
23
  export default Geocoders;
25
- export type { Geocoder, GeocoderType };
24
+ export { Geocoder };
@@ -1,5 +1,12 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Geocoders extends ApiResource {
3
+ // static readonly PATH = 'geocoders'
4
+ async list(params, options) {
5
+ return this.resources.list({ type: Geocoders.TYPE }, params, options);
6
+ }
7
+ async retrieve(id, params, options) {
8
+ return this.resources.retrieve({ type: Geocoders.TYPE, id }, params, options);
9
+ }
3
10
  async addresses(geocoderId, params, options) {
4
11
  const _geocoderId = geocoderId.id || geocoderId;
5
12
  return this.resources.fetch({ type: 'addresses' }, `geocoders/${_geocoderId}/addresses`, params, options);
@@ -8,6 +15,7 @@ class Geocoders extends ApiResource {
8
15
  const _geocoderId = geocoderId.id || geocoderId;
9
16
  return this.resources.fetch({ type: 'attachments' }, `geocoders/${_geocoderId}/attachments`, params, options);
10
17
  }
18
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
11
19
  isGeocoder(resource) {
12
20
  return resource.type && (resource.type === Geocoders.TYPE);
13
21
  }
@@ -1,45 +1,47 @@
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 { Customer, CustomerType } from './customers';
1
+ import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
2
+ import type { QueryParamsList, QueryParamsRetrieve } from '../query';
3
+ import type { Customer } from './customers';
5
4
  import type { Attachment } from './attachments';
6
- type GiftCardRecipientType = 'gift_card_recipients';
5
+ import type { Version } from './versions';
7
6
  type GiftCardRecipientRel = ResourceRel & {
8
- type: GiftCardRecipientType;
7
+ type: typeof GiftCardRecipients.TYPE;
9
8
  };
10
9
  type CustomerRel = ResourceRel & {
11
- type: CustomerType;
10
+ type: 'customers';
12
11
  };
13
12
  interface GiftCardRecipient extends Resource {
14
- readonly type: GiftCardRecipientType;
15
- email: string;
16
- first_name?: string | null;
17
- last_name?: string | null;
18
- customer?: Customer | null;
19
- attachments?: Attachment[] | null;
13
+ email?: string;
14
+ first_name?: string;
15
+ last_name?: string;
16
+ customer?: Customer;
17
+ attachments?: Attachment[];
18
+ versions?: Version[];
20
19
  }
21
20
  interface GiftCardRecipientCreate extends ResourceCreate {
22
21
  email: string;
23
- first_name?: string | null;
24
- last_name?: string | null;
25
- customer?: CustomerRel | null;
22
+ first_name?: string;
23
+ last_name?: string;
24
+ customer?: CustomerRel;
26
25
  }
27
26
  interface GiftCardRecipientUpdate extends ResourceUpdate {
28
- email?: string | null;
29
- first_name?: string | null;
30
- last_name?: string | null;
31
- customer?: CustomerRel | null;
27
+ email?: string;
28
+ first_name?: string;
29
+ last_name?: string;
30
+ customer?: CustomerRel;
32
31
  }
33
- declare class GiftCardRecipients extends ApiResource<GiftCardRecipient> {
34
- static readonly TYPE: GiftCardRecipientType;
32
+ declare class GiftCardRecipients extends ApiResource {
33
+ static readonly TYPE: 'gift_card_recipients';
34
+ list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<GiftCardRecipient>>;
35
35
  create(resource: GiftCardRecipientCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
36
+ retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
36
37
  update(resource: GiftCardRecipientUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
37
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
38
+ delete(id: string, options?: ResourcesConfig): Promise<void>;
38
39
  customer(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
39
40
  attachments(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
41
+ versions(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
40
42
  isGiftCardRecipient(resource: any): resource is GiftCardRecipient;
41
43
  relationship(id: string | ResourceId | null): GiftCardRecipientRel;
42
- type(): GiftCardRecipientType;
44
+ type(): string;
43
45
  }
44
46
  export default GiftCardRecipients;
45
- export type { GiftCardRecipient, GiftCardRecipientCreate, GiftCardRecipientUpdate, GiftCardRecipientType };
47
+ export { GiftCardRecipient, GiftCardRecipientCreate, GiftCardRecipientUpdate };