@commercelayer/sdk 5.0.0-beta.9 → 5.0.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 (291) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +18 -0
  3. package/lib/cjs/api.d.ts +22 -12
  4. package/lib/cjs/api.js +17 -2
  5. package/lib/cjs/client.d.ts +3 -5
  6. package/lib/cjs/commercelayer.d.ts +9 -4
  7. package/lib/cjs/commercelayer.js +8 -3
  8. package/lib/cjs/common.d.ts +1 -0
  9. package/lib/cjs/common.js +11 -0
  10. package/lib/cjs/index.d.ts +1 -2
  11. package/lib/cjs/index.js +0 -16
  12. package/lib/cjs/interceptor.d.ts +1 -1
  13. package/lib/cjs/model.d.ts +6 -1
  14. package/lib/cjs/query.d.ts +5 -13
  15. package/lib/cjs/resource.d.ts +7 -9
  16. package/lib/cjs/resources/addresses.d.ts +51 -50
  17. package/lib/cjs/resources/adjustments.d.ts +5 -4
  18. package/lib/cjs/resources/adyen_gateways.d.ts +21 -20
  19. package/lib/cjs/resources/adyen_payments.d.ts +15 -14
  20. package/lib/cjs/resources/application.d.ts +7 -6
  21. package/lib/cjs/resources/attachments.d.ts +11 -10
  22. package/lib/cjs/resources/authorizations.d.ts +28 -27
  23. package/lib/cjs/resources/avalara_accounts.d.ts +17 -16
  24. package/lib/cjs/resources/axerve_gateways.d.ts +9 -8
  25. package/lib/cjs/resources/axerve_payments.d.ts +12 -11
  26. package/lib/cjs/resources/billing_info_validation_rules.d.ts +5 -4
  27. package/lib/cjs/resources/bing_geocoders.d.ts +6 -5
  28. package/lib/cjs/resources/braintree_gateways.d.ts +21 -20
  29. package/lib/cjs/resources/braintree_payments.d.ts +17 -16
  30. package/lib/cjs/resources/bundles.d.ts +27 -26
  31. package/lib/cjs/resources/captures.d.ts +19 -18
  32. package/lib/cjs/resources/carrier_accounts.d.ts +7 -6
  33. package/lib/cjs/resources/checkout_com_gateways.d.ts +12 -11
  34. package/lib/cjs/resources/checkout_com_payments.d.ts +25 -24
  35. package/lib/cjs/resources/cleanups.d.ts +13 -12
  36. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -6
  37. package/lib/cjs/resources/coupon_recipients.d.ts +13 -12
  38. package/lib/cjs/resources/coupons.d.ts +13 -12
  39. package/lib/cjs/resources/customer_addresses.d.ts +8 -7
  40. package/lib/cjs/resources/customer_groups.d.ts +6 -5
  41. package/lib/cjs/resources/customer_password_resets.d.ts +8 -7
  42. package/lib/cjs/resources/customer_payment_sources.d.ts +9 -8
  43. package/lib/cjs/resources/customer_subscriptions.d.ts +4 -3
  44. package/lib/cjs/resources/customers.d.ts +19 -18
  45. package/lib/cjs/resources/delivery_lead_times.d.ts +11 -10
  46. package/lib/cjs/resources/event_callbacks.d.ts +6 -5
  47. package/lib/cjs/resources/events.d.ts +4 -3
  48. package/lib/cjs/resources/exports.d.ts +17 -16
  49. package/lib/cjs/resources/external_gateways.d.ts +20 -19
  50. package/lib/cjs/resources/external_payments.d.ts +10 -9
  51. package/lib/cjs/resources/external_promotions.d.ts +29 -28
  52. package/lib/cjs/resources/external_tax_calculators.d.ts +6 -5
  53. package/lib/cjs/resources/fixed_amount_promotions.d.ts +31 -30
  54. package/lib/cjs/resources/fixed_price_promotions.d.ts +36 -35
  55. package/lib/cjs/resources/fixed_price_promotions.js +4 -4
  56. package/lib/cjs/resources/free_gift_promotions.d.ts +36 -35
  57. package/lib/cjs/resources/free_gift_promotions.js +4 -4
  58. package/lib/cjs/resources/free_shipping_promotions.d.ts +30 -26
  59. package/lib/cjs/resources/free_shipping_promotions.js +4 -0
  60. package/lib/cjs/resources/geocoders.d.ts +4 -3
  61. package/lib/cjs/resources/gift_card_recipients.d.ts +13 -12
  62. package/lib/cjs/resources/gift_cards.d.ts +41 -40
  63. package/lib/cjs/resources/google_geocoders.d.ts +6 -5
  64. package/lib/cjs/resources/imports.d.ts +20 -19
  65. package/lib/cjs/resources/in_stock_subscriptions.d.ts +20 -19
  66. package/lib/cjs/resources/inventory_models.d.ts +12 -11
  67. package/lib/cjs/resources/inventory_return_locations.d.ts +7 -6
  68. package/lib/cjs/resources/inventory_stock_locations.d.ts +10 -9
  69. package/lib/cjs/resources/klarna_gateways.d.ts +10 -9
  70. package/lib/cjs/resources/klarna_payments.d.ts +14 -13
  71. package/lib/cjs/resources/line_item_options.d.ts +18 -17
  72. package/lib/cjs/resources/line_items.d.ts +47 -43
  73. package/lib/cjs/resources/manual_gateways.d.ts +4 -3
  74. package/lib/cjs/resources/manual_tax_calculators.d.ts +8 -7
  75. package/lib/cjs/resources/markets.d.ts +41 -32
  76. package/lib/cjs/resources/markets.js +4 -0
  77. package/lib/cjs/resources/merchants.d.ts +6 -5
  78. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +9 -8
  79. package/lib/cjs/resources/order_copies.d.ts +23 -20
  80. package/lib/cjs/resources/order_copies.js +7 -4
  81. package/lib/cjs/resources/order_factories.d.ts +34 -0
  82. package/lib/cjs/resources/order_factories.js +28 -0
  83. package/lib/cjs/resources/order_subscription_items.d.ts +61 -0
  84. package/lib/cjs/resources/order_subscription_items.js +29 -0
  85. package/lib/cjs/resources/order_subscriptions.d.ts +52 -29
  86. package/lib/cjs/resources/order_subscriptions.js +18 -2
  87. package/lib/cjs/resources/order_validation_rules.d.ts +4 -3
  88. package/lib/cjs/resources/orders.d.ts +192 -183
  89. package/lib/cjs/resources/orders.js +8 -0
  90. package/lib/cjs/resources/organization.d.ts +18 -17
  91. package/lib/cjs/resources/packages.d.ts +14 -13
  92. package/lib/cjs/resources/parcel_line_items.d.ts +7 -6
  93. package/lib/cjs/resources/parcels.d.ts +75 -74
  94. package/lib/cjs/resources/payment_gateways.d.ts +3 -2
  95. package/lib/cjs/resources/payment_methods.d.ts +33 -32
  96. package/lib/cjs/resources/paypal_gateways.d.ts +7 -6
  97. package/lib/cjs/resources/paypal_payments.d.ts +17 -16
  98. package/lib/cjs/resources/percentage_discount_promotions.d.ts +35 -34
  99. package/lib/cjs/resources/percentage_discount_promotions.js +4 -4
  100. package/lib/cjs/resources/price_frequency_tiers.d.ts +50 -0
  101. package/lib/cjs/resources/price_frequency_tiers.js +37 -0
  102. package/lib/cjs/resources/price_lists.d.ts +9 -8
  103. package/lib/cjs/resources/price_tiers.d.ts +7 -6
  104. package/lib/cjs/resources/price_volume_tiers.d.ts +15 -11
  105. package/lib/cjs/resources/price_volume_tiers.js +4 -0
  106. package/lib/cjs/resources/prices.d.ts +20 -16
  107. package/lib/cjs/resources/prices.js +4 -0
  108. package/lib/cjs/resources/promotion_rules.d.ts +3 -2
  109. package/lib/cjs/resources/promotions.d.ts +14 -10
  110. package/lib/cjs/resources/promotions.js +4 -0
  111. package/lib/cjs/resources/recurring_order_copies.d.ts +53 -0
  112. package/lib/cjs/resources/recurring_order_copies.js +41 -0
  113. package/lib/cjs/resources/refunds.d.ts +10 -9
  114. package/lib/cjs/resources/return_line_items.d.ts +13 -12
  115. package/lib/cjs/resources/returns.d.ts +31 -30
  116. package/lib/cjs/resources/satispay_gateways.d.ts +8 -7
  117. package/lib/cjs/resources/satispay_payments.d.ts +12 -11
  118. package/lib/cjs/resources/shipments.d.ts +42 -41
  119. package/lib/cjs/resources/shipping_categories.d.ts +5 -4
  120. package/lib/cjs/resources/shipping_method_tiers.d.ts +7 -6
  121. package/lib/cjs/resources/shipping_methods.d.ts +50 -49
  122. package/lib/cjs/resources/shipping_weight_tiers.d.ts +12 -11
  123. package/lib/cjs/resources/shipping_zones.d.ts +22 -21
  124. package/lib/cjs/resources/sku_list_items.d.ts +13 -12
  125. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +14 -13
  126. package/lib/cjs/resources/sku_lists.d.ts +22 -21
  127. package/lib/cjs/resources/sku_options.d.ts +25 -24
  128. package/lib/cjs/resources/skus.d.ts +36 -35
  129. package/lib/cjs/resources/stock_items.d.ts +12 -11
  130. package/lib/cjs/resources/stock_line_items.d.ts +7 -6
  131. package/lib/cjs/resources/stock_locations.d.ts +17 -16
  132. package/lib/cjs/resources/stock_transfers.d.ts +24 -23
  133. package/lib/cjs/resources/stripe_gateways.d.ts +12 -11
  134. package/lib/cjs/resources/stripe_payments.d.ts +15 -14
  135. package/lib/cjs/resources/subscription_models.d.ts +49 -0
  136. package/lib/cjs/resources/subscription_models.js +37 -0
  137. package/lib/cjs/resources/tax_calculators.d.ts +4 -3
  138. package/lib/cjs/resources/tax_categories.d.ts +10 -9
  139. package/lib/cjs/resources/tax_rules.d.ts +39 -38
  140. package/lib/cjs/resources/taxjar_accounts.d.ts +9 -8
  141. package/lib/cjs/resources/transactions.d.ts +8 -7
  142. package/lib/cjs/resources/voids.d.ts +10 -9
  143. package/lib/cjs/resources/webhooks.d.ts +14 -13
  144. package/lib/cjs/resources/wire_transfers.d.ts +5 -4
  145. package/lib/cjs/util.d.ts +1 -3
  146. package/lib/esm/api.d.ts +22 -12
  147. package/lib/esm/api.js +10 -0
  148. package/lib/esm/client.d.ts +3 -5
  149. package/lib/esm/commercelayer.d.ts +9 -4
  150. package/lib/esm/commercelayer.js +8 -3
  151. package/lib/esm/common.d.ts +1 -0
  152. package/lib/esm/common.js +11 -0
  153. package/lib/esm/index.d.ts +1 -2
  154. package/lib/esm/index.js +0 -2
  155. package/lib/esm/interceptor.d.ts +1 -1
  156. package/lib/esm/model.d.ts +6 -1
  157. package/lib/esm/query.d.ts +5 -13
  158. package/lib/esm/resource.d.ts +7 -9
  159. package/lib/esm/resources/addresses.d.ts +51 -50
  160. package/lib/esm/resources/adjustments.d.ts +5 -4
  161. package/lib/esm/resources/adyen_gateways.d.ts +21 -20
  162. package/lib/esm/resources/adyen_payments.d.ts +15 -14
  163. package/lib/esm/resources/application.d.ts +7 -6
  164. package/lib/esm/resources/attachments.d.ts +11 -10
  165. package/lib/esm/resources/authorizations.d.ts +28 -27
  166. package/lib/esm/resources/avalara_accounts.d.ts +17 -16
  167. package/lib/esm/resources/axerve_gateways.d.ts +9 -8
  168. package/lib/esm/resources/axerve_payments.d.ts +12 -11
  169. package/lib/esm/resources/billing_info_validation_rules.d.ts +5 -4
  170. package/lib/esm/resources/bing_geocoders.d.ts +6 -5
  171. package/lib/esm/resources/braintree_gateways.d.ts +21 -20
  172. package/lib/esm/resources/braintree_payments.d.ts +17 -16
  173. package/lib/esm/resources/bundles.d.ts +27 -26
  174. package/lib/esm/resources/captures.d.ts +19 -18
  175. package/lib/esm/resources/carrier_accounts.d.ts +7 -6
  176. package/lib/esm/resources/checkout_com_gateways.d.ts +12 -11
  177. package/lib/esm/resources/checkout_com_payments.d.ts +25 -24
  178. package/lib/esm/resources/cleanups.d.ts +13 -12
  179. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -6
  180. package/lib/esm/resources/coupon_recipients.d.ts +13 -12
  181. package/lib/esm/resources/coupons.d.ts +13 -12
  182. package/lib/esm/resources/customer_addresses.d.ts +8 -7
  183. package/lib/esm/resources/customer_groups.d.ts +6 -5
  184. package/lib/esm/resources/customer_password_resets.d.ts +8 -7
  185. package/lib/esm/resources/customer_payment_sources.d.ts +9 -8
  186. package/lib/esm/resources/customer_subscriptions.d.ts +4 -3
  187. package/lib/esm/resources/customers.d.ts +19 -18
  188. package/lib/esm/resources/delivery_lead_times.d.ts +11 -10
  189. package/lib/esm/resources/event_callbacks.d.ts +6 -5
  190. package/lib/esm/resources/events.d.ts +4 -3
  191. package/lib/esm/resources/exports.d.ts +17 -16
  192. package/lib/esm/resources/external_gateways.d.ts +20 -19
  193. package/lib/esm/resources/external_payments.d.ts +10 -9
  194. package/lib/esm/resources/external_promotions.d.ts +29 -28
  195. package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
  196. package/lib/esm/resources/fixed_amount_promotions.d.ts +31 -30
  197. package/lib/esm/resources/fixed_price_promotions.d.ts +36 -35
  198. package/lib/esm/resources/fixed_price_promotions.js +4 -4
  199. package/lib/esm/resources/free_gift_promotions.d.ts +36 -35
  200. package/lib/esm/resources/free_gift_promotions.js +4 -4
  201. package/lib/esm/resources/free_shipping_promotions.d.ts +30 -26
  202. package/lib/esm/resources/free_shipping_promotions.js +4 -0
  203. package/lib/esm/resources/geocoders.d.ts +4 -3
  204. package/lib/esm/resources/gift_card_recipients.d.ts +13 -12
  205. package/lib/esm/resources/gift_cards.d.ts +41 -40
  206. package/lib/esm/resources/google_geocoders.d.ts +6 -5
  207. package/lib/esm/resources/imports.d.ts +20 -19
  208. package/lib/esm/resources/in_stock_subscriptions.d.ts +20 -19
  209. package/lib/esm/resources/inventory_models.d.ts +12 -11
  210. package/lib/esm/resources/inventory_return_locations.d.ts +7 -6
  211. package/lib/esm/resources/inventory_stock_locations.d.ts +10 -9
  212. package/lib/esm/resources/klarna_gateways.d.ts +10 -9
  213. package/lib/esm/resources/klarna_payments.d.ts +14 -13
  214. package/lib/esm/resources/line_item_options.d.ts +18 -17
  215. package/lib/esm/resources/line_items.d.ts +47 -43
  216. package/lib/esm/resources/manual_gateways.d.ts +4 -3
  217. package/lib/esm/resources/manual_tax_calculators.d.ts +8 -7
  218. package/lib/esm/resources/markets.d.ts +41 -32
  219. package/lib/esm/resources/markets.js +4 -0
  220. package/lib/esm/resources/merchants.d.ts +6 -5
  221. package/lib/esm/resources/order_amount_promotion_rules.d.ts +9 -8
  222. package/lib/esm/resources/order_copies.d.ts +23 -20
  223. package/lib/esm/resources/order_copies.js +7 -4
  224. package/lib/esm/resources/order_factories.d.ts +34 -0
  225. package/lib/esm/resources/order_factories.js +26 -0
  226. package/lib/esm/resources/order_subscription_items.d.ts +61 -0
  227. package/lib/esm/resources/order_subscription_items.js +27 -0
  228. package/lib/esm/resources/order_subscriptions.d.ts +52 -29
  229. package/lib/esm/resources/order_subscriptions.js +18 -2
  230. package/lib/esm/resources/order_validation_rules.d.ts +4 -3
  231. package/lib/esm/resources/orders.d.ts +192 -183
  232. package/lib/esm/resources/orders.js +8 -0
  233. package/lib/esm/resources/organization.d.ts +18 -17
  234. package/lib/esm/resources/packages.d.ts +14 -13
  235. package/lib/esm/resources/parcel_line_items.d.ts +7 -6
  236. package/lib/esm/resources/parcels.d.ts +75 -74
  237. package/lib/esm/resources/payment_gateways.d.ts +3 -2
  238. package/lib/esm/resources/payment_methods.d.ts +33 -32
  239. package/lib/esm/resources/paypal_gateways.d.ts +7 -6
  240. package/lib/esm/resources/paypal_payments.d.ts +17 -16
  241. package/lib/esm/resources/percentage_discount_promotions.d.ts +35 -34
  242. package/lib/esm/resources/percentage_discount_promotions.js +4 -4
  243. package/lib/esm/resources/price_frequency_tiers.d.ts +50 -0
  244. package/lib/esm/resources/price_frequency_tiers.js +35 -0
  245. package/lib/esm/resources/price_lists.d.ts +9 -8
  246. package/lib/esm/resources/price_tiers.d.ts +7 -6
  247. package/lib/esm/resources/price_volume_tiers.d.ts +15 -11
  248. package/lib/esm/resources/price_volume_tiers.js +4 -0
  249. package/lib/esm/resources/prices.d.ts +20 -16
  250. package/lib/esm/resources/prices.js +4 -0
  251. package/lib/esm/resources/promotion_rules.d.ts +3 -2
  252. package/lib/esm/resources/promotions.d.ts +14 -10
  253. package/lib/esm/resources/promotions.js +4 -0
  254. package/lib/esm/resources/recurring_order_copies.d.ts +53 -0
  255. package/lib/esm/resources/recurring_order_copies.js +39 -0
  256. package/lib/esm/resources/refunds.d.ts +10 -9
  257. package/lib/esm/resources/return_line_items.d.ts +13 -12
  258. package/lib/esm/resources/returns.d.ts +31 -30
  259. package/lib/esm/resources/satispay_gateways.d.ts +8 -7
  260. package/lib/esm/resources/satispay_payments.d.ts +12 -11
  261. package/lib/esm/resources/shipments.d.ts +42 -41
  262. package/lib/esm/resources/shipping_categories.d.ts +5 -4
  263. package/lib/esm/resources/shipping_method_tiers.d.ts +7 -6
  264. package/lib/esm/resources/shipping_methods.d.ts +50 -49
  265. package/lib/esm/resources/shipping_weight_tiers.d.ts +12 -11
  266. package/lib/esm/resources/shipping_zones.d.ts +22 -21
  267. package/lib/esm/resources/sku_list_items.d.ts +13 -12
  268. package/lib/esm/resources/sku_list_promotion_rules.d.ts +14 -13
  269. package/lib/esm/resources/sku_lists.d.ts +22 -21
  270. package/lib/esm/resources/sku_options.d.ts +25 -24
  271. package/lib/esm/resources/skus.d.ts +36 -35
  272. package/lib/esm/resources/stock_items.d.ts +12 -11
  273. package/lib/esm/resources/stock_line_items.d.ts +7 -6
  274. package/lib/esm/resources/stock_locations.d.ts +17 -16
  275. package/lib/esm/resources/stock_transfers.d.ts +24 -23
  276. package/lib/esm/resources/stripe_gateways.d.ts +12 -11
  277. package/lib/esm/resources/stripe_payments.d.ts +15 -14
  278. package/lib/esm/resources/subscription_models.d.ts +49 -0
  279. package/lib/esm/resources/subscription_models.js +35 -0
  280. package/lib/esm/resources/tax_calculators.d.ts +4 -3
  281. package/lib/esm/resources/tax_categories.d.ts +10 -9
  282. package/lib/esm/resources/tax_rules.d.ts +39 -38
  283. package/lib/esm/resources/taxjar_accounts.d.ts +9 -8
  284. package/lib/esm/resources/transactions.d.ts +8 -7
  285. package/lib/esm/resources/voids.d.ts +10 -9
  286. package/lib/esm/resources/webhooks.d.ts +14 -13
  287. package/lib/esm/resources/wire_transfers.d.ts +5 -4
  288. package/lib/esm/util.d.ts +1 -3
  289. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  290. package/lib/tsconfig.tsbuildinfo +1 -1
  291. package/package.json +10 -10
@@ -0,0 +1,50 @@
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 { Price, PriceType } from './prices';
5
+ import type { Attachment } from './attachments';
6
+ import type { Event } from './events';
7
+ type PriceFrequencyTierType = 'price_frequency_tiers';
8
+ type PriceFrequencyTierRel = ResourceRel & {
9
+ type: PriceFrequencyTierType;
10
+ };
11
+ type PriceRel = ResourceRel & {
12
+ type: PriceType;
13
+ };
14
+ interface PriceFrequencyTier extends Resource {
15
+ readonly type: PriceFrequencyTierType;
16
+ name: string;
17
+ up_to?: number | null;
18
+ price_amount_cents: number;
19
+ price_amount_float?: number | null;
20
+ formatted_price_amount?: string | null;
21
+ price?: Price | null;
22
+ attachments?: Attachment[] | null;
23
+ events?: Event[] | null;
24
+ }
25
+ interface PriceFrequencyTierCreate extends ResourceCreate {
26
+ name: string;
27
+ up_to?: number | null;
28
+ price_amount_cents: number;
29
+ price: PriceRel;
30
+ }
31
+ interface PriceFrequencyTierUpdate extends ResourceUpdate {
32
+ name?: string | null;
33
+ up_to?: number | null;
34
+ price_amount_cents?: number | null;
35
+ price?: PriceRel | null;
36
+ }
37
+ declare class PriceFrequencyTiers extends ApiResource<PriceFrequencyTier> {
38
+ static readonly TYPE: PriceFrequencyTierType;
39
+ create(resource: PriceFrequencyTierCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceFrequencyTier>;
40
+ update(resource: PriceFrequencyTierUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceFrequencyTier>;
41
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
42
+ price(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
43
+ attachments(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
44
+ events(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
45
+ isPriceFrequencyTier(resource: any): resource is PriceFrequencyTier;
46
+ relationship(id: string | ResourceId | null): PriceFrequencyTierRel;
47
+ type(): PriceFrequencyTierType;
48
+ }
49
+ export default PriceFrequencyTiers;
50
+ export type { PriceFrequencyTier, PriceFrequencyTierCreate, PriceFrequencyTierUpdate, PriceFrequencyTierType };
@@ -0,0 +1,35 @@
1
+ import { ApiResource } from '../resource';
2
+ class PriceFrequencyTiers extends ApiResource {
3
+ async create(resource, params, options) {
4
+ return this.resources.create({ ...resource, type: PriceFrequencyTiers.TYPE }, params, options);
5
+ }
6
+ async update(resource, params, options) {
7
+ return this.resources.update({ ...resource, type: PriceFrequencyTiers.TYPE }, params, options);
8
+ }
9
+ async delete(id, options) {
10
+ await this.resources.delete((typeof id === 'string') ? { id, type: PriceFrequencyTiers.TYPE } : id, options);
11
+ }
12
+ async price(priceFrequencyTierId, params, options) {
13
+ const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
14
+ return this.resources.fetch({ type: 'prices' }, `price_frequency_tiers/${_priceFrequencyTierId}/price`, params, options);
15
+ }
16
+ async attachments(priceFrequencyTierId, params, options) {
17
+ const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
18
+ return this.resources.fetch({ type: 'attachments' }, `price_frequency_tiers/${_priceFrequencyTierId}/attachments`, params, options);
19
+ }
20
+ async events(priceFrequencyTierId, params, options) {
21
+ const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
22
+ return this.resources.fetch({ type: 'events' }, `price_frequency_tiers/${_priceFrequencyTierId}/events`, params, options);
23
+ }
24
+ isPriceFrequencyTier(resource) {
25
+ return resource.type && (resource.type === PriceFrequencyTiers.TYPE);
26
+ }
27
+ relationship(id) {
28
+ return ((id === null) || (typeof id === 'string')) ? { id, type: PriceFrequencyTiers.TYPE } : { id: id.id, type: PriceFrequencyTiers.TYPE };
29
+ }
30
+ type() {
31
+ return PriceFrequencyTiers.TYPE;
32
+ }
33
+ }
34
+ PriceFrequencyTiers.TYPE = 'price_frequency_tiers';
35
+ export default PriceFrequencyTiers;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Price } from './prices';
4
5
  import type { Attachment } from './attachments';
@@ -10,19 +11,19 @@ interface PriceList extends Resource {
10
11
  readonly type: PriceListType;
11
12
  name: string;
12
13
  currency_code: string;
13
- tax_included?: boolean;
14
- prices?: Price[];
15
- attachments?: Attachment[];
14
+ tax_included?: boolean | null;
15
+ prices?: Price[] | null;
16
+ attachments?: Attachment[] | null;
16
17
  }
17
18
  interface PriceListCreate extends ResourceCreate {
18
19
  name: string;
19
20
  currency_code: string;
20
- tax_included?: boolean;
21
+ tax_included?: boolean | null;
21
22
  }
22
23
  interface PriceListUpdate extends ResourceUpdate {
23
- name: string;
24
- currency_code: string;
25
- tax_included?: boolean;
24
+ name?: string | null;
25
+ currency_code?: string | null;
26
+ tax_included?: boolean | null;
26
27
  }
27
28
  declare class PriceLists extends ApiResource<PriceList> {
28
29
  static readonly TYPE: PriceListType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Price } from './prices';
4
5
  import type { Attachment } from './attachments';
@@ -9,12 +10,12 @@ type PriceTierRel = ResourceRel & {
9
10
  interface PriceTier extends Resource {
10
11
  readonly type: PriceTierType;
11
12
  name: string;
12
- up_to?: number;
13
+ up_to?: number | null;
13
14
  price_amount_cents: number;
14
- price_amount_float?: number;
15
- formatted_price_amount?: string;
16
- price?: Price;
17
- attachments?: Attachment[];
15
+ price_amount_float?: number | null;
16
+ formatted_price_amount?: string | null;
17
+ price?: Price | null;
18
+ attachments?: Attachment[] | null;
18
19
  }
19
20
  declare class PriceTiers extends ApiResource<PriceTier> {
20
21
  static readonly TYPE: PriceTierType;
@@ -1,7 +1,9 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Price, PriceType } from './prices';
4
5
  import type { Attachment } from './attachments';
6
+ import type { Event } from './events';
5
7
  type PriceVolumeTierType = 'price_volume_tiers';
6
8
  type PriceVolumeTierRel = ResourceRel & {
7
9
  type: PriceVolumeTierType;
@@ -12,24 +14,25 @@ type PriceRel = ResourceRel & {
12
14
  interface PriceVolumeTier extends Resource {
13
15
  readonly type: PriceVolumeTierType;
14
16
  name: string;
15
- up_to?: number;
17
+ up_to?: number | null;
16
18
  price_amount_cents: number;
17
- price_amount_float?: number;
18
- formatted_price_amount?: string;
19
- price?: Price;
20
- attachments?: Attachment[];
19
+ price_amount_float?: number | null;
20
+ formatted_price_amount?: string | null;
21
+ price?: Price | null;
22
+ attachments?: Attachment[] | null;
23
+ events?: Event[] | null;
21
24
  }
22
25
  interface PriceVolumeTierCreate extends ResourceCreate {
23
26
  name: string;
24
- up_to?: number;
27
+ up_to?: number | null;
25
28
  price_amount_cents: number;
26
29
  price: PriceRel;
27
30
  }
28
31
  interface PriceVolumeTierUpdate extends ResourceUpdate {
29
- name: string;
30
- up_to?: number;
31
- price_amount_cents: number;
32
- price?: PriceRel;
32
+ name?: string | null;
33
+ up_to?: number | null;
34
+ price_amount_cents?: number | null;
35
+ price?: PriceRel | null;
33
36
  }
34
37
  declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
35
38
  static readonly TYPE: PriceVolumeTierType;
@@ -38,6 +41,7 @@ declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
38
41
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
39
42
  price(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
40
43
  attachments(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
44
+ events(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
41
45
  isPriceVolumeTier(resource: any): resource is PriceVolumeTier;
42
46
  relationship(id: string | ResourceId | null): PriceVolumeTierRel;
43
47
  type(): PriceVolumeTierType;
@@ -17,6 +17,10 @@ class PriceVolumeTiers extends ApiResource {
17
17
  const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
18
18
  return this.resources.fetch({ type: 'attachments' }, `price_volume_tiers/${_priceVolumeTierId}/attachments`, params, options);
19
19
  }
20
+ async events(priceVolumeTierId, params, options) {
21
+ const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
22
+ return this.resources.fetch({ type: 'events' }, `price_volume_tiers/${_priceVolumeTierId}/events`, params, options);
23
+ }
20
24
  isPriceVolumeTier(resource) {
21
25
  return resource.type && (resource.type === PriceVolumeTiers.TYPE);
22
26
  }
@@ -1,9 +1,11 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { PriceList, PriceListType } from './price_lists';
4
5
  import type { Sku, SkuType } from './skus';
5
6
  import type { PriceTier, PriceTierType } from './price_tiers';
6
7
  import type { PriceVolumeTier } from './price_volume_tiers';
8
+ import type { PriceFrequencyTier } from './price_frequency_tiers';
7
9
  import type { Attachment } from './attachments';
8
10
  type PriceType = 'prices';
9
11
  type PriceRel = ResourceRel & {
@@ -20,35 +22,36 @@ type PriceTierRel = ResourceRel & {
20
22
  };
21
23
  interface Price extends Resource {
22
24
  readonly type: PriceType;
23
- currency_code?: string;
24
- sku_code?: string;
25
+ currency_code?: string | null;
26
+ sku_code?: string | null;
25
27
  amount_cents: number;
26
28
  amount_float: number;
27
29
  formatted_amount: string;
28
30
  compare_at_amount_cents: number;
29
31
  compare_at_amount_float: number;
30
32
  formatted_compare_at_amount: string;
31
- price_list?: PriceList;
32
- sku?: Sku;
33
- price_tiers?: PriceTier[];
34
- price_volume_tiers?: PriceVolumeTier[];
35
- attachments?: Attachment[];
33
+ price_list?: PriceList | null;
34
+ sku?: Sku | null;
35
+ price_tiers?: PriceTier[] | null;
36
+ price_volume_tiers?: PriceVolumeTier[] | null;
37
+ price_frequency_tiers?: PriceFrequencyTier[] | null;
38
+ attachments?: Attachment[] | null;
36
39
  }
37
40
  interface PriceCreate extends ResourceCreate {
38
- sku_code?: string;
41
+ sku_code?: string | null;
39
42
  amount_cents: number;
40
43
  compare_at_amount_cents: number;
41
44
  price_list: PriceListRel;
42
45
  sku: SkuRel;
43
- price_tiers?: PriceTierRel[];
46
+ price_tiers?: PriceTierRel[] | null;
44
47
  }
45
48
  interface PriceUpdate extends ResourceUpdate {
46
- sku_code?: string;
47
- amount_cents: number;
48
- compare_at_amount_cents: number;
49
- price_list?: PriceListRel;
50
- sku?: SkuRel;
51
- price_tiers?: PriceTierRel[];
49
+ sku_code?: string | null;
50
+ amount_cents?: number | null;
51
+ compare_at_amount_cents?: number | null;
52
+ price_list?: PriceListRel | null;
53
+ sku?: SkuRel | null;
54
+ price_tiers?: PriceTierRel[] | null;
52
55
  }
53
56
  declare class Prices extends ApiResource<Price> {
54
57
  static readonly TYPE: PriceType;
@@ -59,6 +62,7 @@ declare class Prices extends ApiResource<Price> {
59
62
  sku(priceId: string | Price, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
60
63
  price_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceTier>>;
61
64
  price_volume_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceVolumeTier>>;
65
+ price_frequency_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceFrequencyTier>>;
62
66
  attachments(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
63
67
  isPrice(resource: any): resource is Price;
64
68
  relationship(id: string | ResourceId | null): PriceRel;
@@ -25,6 +25,10 @@ class Prices extends ApiResource {
25
25
  const _priceId = priceId.id || priceId;
26
26
  return this.resources.fetch({ type: 'price_volume_tiers' }, `prices/${_priceId}/price_volume_tiers`, params, options);
27
27
  }
28
+ async price_frequency_tiers(priceId, params, options) {
29
+ const _priceId = priceId.id || priceId;
30
+ return this.resources.fetch({ type: 'price_frequency_tiers' }, `prices/${_priceId}/price_frequency_tiers`, params, options);
31
+ }
28
32
  async attachments(priceId, params, options) {
29
33
  const _priceId = priceId.id || priceId;
30
34
  return this.resources.fetch({ type: 'attachments' }, `prices/${_priceId}/attachments`, params, options);
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceId, ResourceRel } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourceRel } from '../resource';
2
3
  import type { PercentageDiscountPromotion } from './percentage_discount_promotions';
3
4
  import type { FreeShippingPromotion } from './free_shipping_promotions';
4
5
  import type { FreeGiftPromotion } from './free_gift_promotions';
@@ -11,7 +12,7 @@ type PromotionRuleRel = ResourceRel & {
11
12
  };
12
13
  interface PromotionRule extends Resource {
13
14
  readonly type: PromotionRuleType;
14
- promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
15
+ promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
15
16
  }
16
17
  declare class PromotionRules extends ApiResource<PromotionRule> {
17
18
  static readonly TYPE: PromotionRuleType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Market } from './markets';
4
5
  import type { PromotionRule } from './promotion_rules';
@@ -6,6 +7,7 @@ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
6
7
  import type { SkuListPromotionRule } from './sku_list_promotion_rules';
7
8
  import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
8
9
  import type { Attachment } from './attachments';
10
+ import type { Event } from './events';
9
11
  type PromotionType = 'promotions';
10
12
  type PromotionRel = ResourceRel & {
11
13
  type: PromotionType;
@@ -13,18 +15,19 @@ type PromotionRel = ResourceRel & {
13
15
  interface Promotion extends Resource {
14
16
  readonly type: PromotionType;
15
17
  name: string;
16
- currency_code?: string;
18
+ currency_code?: string | null;
17
19
  starts_at: string;
18
20
  expires_at: string;
19
21
  total_usage_limit: number;
20
- total_usage_count?: number;
21
- active?: boolean;
22
- market?: Market;
23
- promotion_rules?: PromotionRule[];
24
- order_amount_promotion_rule?: OrderAmountPromotionRule;
25
- sku_list_promotion_rule?: SkuListPromotionRule;
26
- coupon_codes_promotion_rule?: CouponCodesPromotionRule;
27
- attachments?: Attachment[];
22
+ total_usage_count?: number | null;
23
+ active?: boolean | null;
24
+ market?: Market | null;
25
+ promotion_rules?: PromotionRule[] | null;
26
+ order_amount_promotion_rule?: OrderAmountPromotionRule | null;
27
+ sku_list_promotion_rule?: SkuListPromotionRule | null;
28
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
29
+ attachments?: Attachment[] | null;
30
+ events?: Event[] | null;
28
31
  }
29
32
  declare class Promotions extends ApiResource<Promotion> {
30
33
  static readonly TYPE: PromotionType;
@@ -33,6 +36,7 @@ declare class Promotions extends ApiResource<Promotion> {
33
36
  sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
34
37
  coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
35
38
  attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
39
+ events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
36
40
  isPromotion(resource: any): resource is Promotion;
37
41
  relationship(id: string | ResourceId | null): PromotionRel;
38
42
  type(): PromotionType;
@@ -20,6 +20,10 @@ class Promotions extends ApiResource {
20
20
  const _promotionId = promotionId.id || promotionId;
21
21
  return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
22
22
  }
23
+ async events(promotionId, params, options) {
24
+ const _promotionId = promotionId.id || promotionId;
25
+ return this.resources.fetch({ type: 'events' }, `promotions/${_promotionId}/events`, params, options);
26
+ }
23
27
  isPromotion(resource) {
24
28
  return resource.type && (resource.type === Promotions.TYPE);
25
29
  }
@@ -0,0 +1,53 @@
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 { Order, OrderType } from './orders';
5
+ import type { Event } from './events';
6
+ import type { OrderSubscription, OrderSubscriptionType } from './order_subscriptions';
7
+ type RecurringOrderCopyType = 'recurring_order_copies';
8
+ type RecurringOrderCopyRel = ResourceRel & {
9
+ type: RecurringOrderCopyType;
10
+ };
11
+ type OrderRel = ResourceRel & {
12
+ type: OrderType;
13
+ };
14
+ type OrderSubscriptionRel = ResourceRel & {
15
+ type: OrderSubscriptionType;
16
+ };
17
+ interface RecurringOrderCopy extends Resource {
18
+ readonly type: RecurringOrderCopyType;
19
+ status: 'pending' | 'in_progress' | 'failed' | 'completed';
20
+ started_at?: string | null;
21
+ completed_at?: string | null;
22
+ failed_at?: string | null;
23
+ errors_log?: object | null;
24
+ errors_count?: number | null;
25
+ place_target_order?: boolean | null;
26
+ reuse_wallet?: boolean | null;
27
+ source_order?: Order | null;
28
+ target_order?: Order | null;
29
+ events?: Event[] | null;
30
+ order_subscription?: OrderSubscription | null;
31
+ }
32
+ interface RecurringOrderCopyCreate extends ResourceCreate {
33
+ place_target_order?: boolean | null;
34
+ reuse_wallet?: boolean | null;
35
+ source_order: OrderRel;
36
+ order_subscription: OrderSubscriptionRel;
37
+ }
38
+ type RecurringOrderCopyUpdate = ResourceUpdate;
39
+ declare class RecurringOrderCopies extends ApiResource<RecurringOrderCopy> {
40
+ static readonly TYPE: RecurringOrderCopyType;
41
+ create(resource: RecurringOrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
42
+ update(resource: RecurringOrderCopyUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
43
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
44
+ source_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
45
+ target_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
46
+ events(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
47
+ order_subscription(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
48
+ isRecurringOrderCopy(resource: any): resource is RecurringOrderCopy;
49
+ relationship(id: string | ResourceId | null): RecurringOrderCopyRel;
50
+ type(): RecurringOrderCopyType;
51
+ }
52
+ export default RecurringOrderCopies;
53
+ export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate, RecurringOrderCopyType };
@@ -0,0 +1,39 @@
1
+ import { ApiResource } from '../resource';
2
+ class RecurringOrderCopies extends ApiResource {
3
+ async create(resource, params, options) {
4
+ return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
5
+ }
6
+ async update(resource, params, options) {
7
+ return this.resources.update({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
8
+ }
9
+ async delete(id, options) {
10
+ await this.resources.delete((typeof id === 'string') ? { id, type: RecurringOrderCopies.TYPE } : id, options);
11
+ }
12
+ async source_order(recurringOrderCopyId, params, options) {
13
+ const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
14
+ return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/source_order`, params, options);
15
+ }
16
+ async target_order(recurringOrderCopyId, params, options) {
17
+ const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
18
+ return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/target_order`, params, options);
19
+ }
20
+ async events(recurringOrderCopyId, params, options) {
21
+ const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
22
+ return this.resources.fetch({ type: 'events' }, `recurring_order_copies/${_recurringOrderCopyId}/events`, params, options);
23
+ }
24
+ async order_subscription(recurringOrderCopyId, params, options) {
25
+ const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
26
+ return this.resources.fetch({ type: 'order_subscriptions' }, `recurring_order_copies/${_recurringOrderCopyId}/order_subscription`, params, options);
27
+ }
28
+ isRecurringOrderCopy(resource) {
29
+ return resource.type && (resource.type === RecurringOrderCopies.TYPE);
30
+ }
31
+ relationship(id) {
32
+ return ((id === null) || (typeof id === 'string')) ? { id, type: RecurringOrderCopies.TYPE } : { id: id.id, type: RecurringOrderCopies.TYPE };
33
+ }
34
+ type() {
35
+ return RecurringOrderCopies.TYPE;
36
+ }
37
+ }
38
+ RecurringOrderCopies.TYPE = 'recurring_order_copies';
39
+ export default RecurringOrderCopies;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Order } from './orders';
4
5
  import type { Capture } from './captures';
@@ -15,14 +16,14 @@ interface Refund extends Resource {
15
16
  amount_float: number;
16
17
  formatted_amount: string;
17
18
  succeeded: boolean;
18
- message?: string;
19
- error_code?: string;
20
- error_detail?: string;
21
- token?: string;
22
- gateway_transaction_id?: string;
23
- order?: Order;
24
- reference_capture?: Capture;
25
- events?: Event[];
19
+ message?: string | null;
20
+ error_code?: string | null;
21
+ error_detail?: string | null;
22
+ token?: string | null;
23
+ gateway_transaction_id?: string | null;
24
+ order?: Order | null;
25
+ reference_capture?: Capture | null;
26
+ events?: Event[] | null;
26
27
  }
27
28
  declare class Refunds extends ApiResource<Refund> {
28
29
  static readonly TYPE: RefundType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
2
3
  import type { QueryParamsRetrieve } from '../query';
3
4
  import type { Return, ReturnType } from './returns';
4
5
  import type { LineItem, LineItemType } from './line_items';
@@ -14,25 +15,25 @@ type LineItemRel = ResourceRel & {
14
15
  };
15
16
  interface ReturnLineItem extends Resource {
16
17
  readonly type: ReturnLineItemType;
17
- sku_code?: string;
18
- bundle_code?: string;
19
- name?: string;
18
+ sku_code?: string | null;
19
+ bundle_code?: string | null;
20
+ name?: string | null;
20
21
  quantity: number;
21
- return_reason?: object;
22
- restocked_at?: string;
23
- return?: Return;
24
- line_item?: LineItem;
22
+ return_reason?: object | null;
23
+ restocked_at?: string | null;
24
+ return?: Return | null;
25
+ line_item?: LineItem | null;
25
26
  }
26
27
  interface ReturnLineItemCreate extends ResourceCreate {
27
28
  quantity: number;
28
- return_reason?: object;
29
+ return_reason?: object | null;
29
30
  return: ReturnRel;
30
31
  line_item: LineItemRel;
31
32
  }
32
33
  interface ReturnLineItemUpdate extends ResourceUpdate {
33
- quantity: number;
34
- _restock?: boolean;
35
- return_reason?: object;
34
+ quantity?: number | null;
35
+ _restock?: boolean | null;
36
+ return_reason?: object | null;
36
37
  }
37
38
  declare class ReturnLineItems extends ApiResource<ReturnLineItem> {
38
39
  static readonly TYPE: ReturnLineItemType;
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Order, OrderType } from './orders';
4
5
  import type { Customer } from './customers';
@@ -19,40 +20,40 @@ type StockLocationRel = ResourceRel & {
19
20
  };
20
21
  interface Return extends Resource {
21
22
  readonly type: ReturnType;
22
- number?: string;
23
- status?: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
24
- customer_email?: string;
25
- skus_count?: number;
26
- approved_at?: string;
27
- cancelled_at?: string;
28
- shipped_at?: string;
29
- rejected_at?: string;
30
- received_at?: string;
31
- archived_at?: string;
32
- order?: Order;
33
- customer?: Customer;
34
- stock_location?: StockLocation;
35
- origin_address?: Address;
36
- destination_address?: Address;
37
- return_line_items?: ReturnLineItem[];
38
- attachments?: Attachment[];
39
- events?: Event[];
23
+ number?: string | null;
24
+ status: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
25
+ customer_email?: string | null;
26
+ skus_count?: number | null;
27
+ approved_at?: string | null;
28
+ cancelled_at?: string | null;
29
+ shipped_at?: string | null;
30
+ rejected_at?: string | null;
31
+ received_at?: string | null;
32
+ archived_at?: string | null;
33
+ order?: Order | null;
34
+ customer?: Customer | null;
35
+ stock_location?: StockLocation | null;
36
+ origin_address?: Address | null;
37
+ destination_address?: Address | null;
38
+ return_line_items?: ReturnLineItem[] | null;
39
+ attachments?: Attachment[] | null;
40
+ events?: Event[] | null;
40
41
  }
41
42
  interface ReturnCreate extends ResourceCreate {
42
43
  order: OrderRel;
43
- stock_location?: StockLocationRel;
44
+ stock_location?: StockLocationRel | null;
44
45
  }
45
46
  interface ReturnUpdate extends ResourceUpdate {
46
- _request?: boolean;
47
- _approve?: boolean;
48
- _cancel?: boolean;
49
- _ship?: boolean;
50
- _reject?: boolean;
51
- _receive?: boolean;
52
- _restock?: boolean;
53
- _archive?: boolean;
54
- _unarchive?: boolean;
55
- stock_location?: StockLocationRel;
47
+ _request?: boolean | null;
48
+ _approve?: boolean | null;
49
+ _cancel?: boolean | null;
50
+ _ship?: boolean | null;
51
+ _reject?: boolean | null;
52
+ _receive?: boolean | null;
53
+ _restock?: boolean | null;
54
+ _archive?: boolean | null;
55
+ _unarchive?: boolean | null;
56
+ stock_location?: StockLocationRel | null;
56
57
  }
57
58
  declare class Returns extends ApiResource<Return> {
58
59
  static readonly TYPE: ReturnType;