@commercelayer/sdk 5.0.0-beta.8 → 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 (293) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +18 -0
  3. package/lib/cjs/api.d.ts +27 -2
  4. package/lib/cjs/api.js +17 -15
  5. package/lib/cjs/client.d.ts +3 -5
  6. package/lib/cjs/commercelayer.d.ts +10 -5
  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 -1
  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 +6 -14
  15. package/lib/cjs/resource.d.ts +14 -20
  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/static.d.ts +1 -1
  146. package/lib/cjs/util.d.ts +1 -3
  147. package/lib/esm/api.d.ts +27 -2
  148. package/lib/esm/api.js +10 -13
  149. package/lib/esm/client.d.ts +3 -5
  150. package/lib/esm/commercelayer.d.ts +10 -5
  151. package/lib/esm/commercelayer.js +8 -3
  152. package/lib/esm/common.d.ts +1 -0
  153. package/lib/esm/common.js +11 -0
  154. package/lib/esm/index.d.ts +1 -1
  155. package/lib/esm/index.js +0 -2
  156. package/lib/esm/interceptor.d.ts +1 -1
  157. package/lib/esm/model.d.ts +6 -1
  158. package/lib/esm/query.d.ts +6 -14
  159. package/lib/esm/resource.d.ts +14 -20
  160. package/lib/esm/resources/addresses.d.ts +51 -50
  161. package/lib/esm/resources/adjustments.d.ts +5 -4
  162. package/lib/esm/resources/adyen_gateways.d.ts +21 -20
  163. package/lib/esm/resources/adyen_payments.d.ts +15 -14
  164. package/lib/esm/resources/application.d.ts +7 -6
  165. package/lib/esm/resources/attachments.d.ts +11 -10
  166. package/lib/esm/resources/authorizations.d.ts +28 -27
  167. package/lib/esm/resources/avalara_accounts.d.ts +17 -16
  168. package/lib/esm/resources/axerve_gateways.d.ts +9 -8
  169. package/lib/esm/resources/axerve_payments.d.ts +12 -11
  170. package/lib/esm/resources/billing_info_validation_rules.d.ts +5 -4
  171. package/lib/esm/resources/bing_geocoders.d.ts +6 -5
  172. package/lib/esm/resources/braintree_gateways.d.ts +21 -20
  173. package/lib/esm/resources/braintree_payments.d.ts +17 -16
  174. package/lib/esm/resources/bundles.d.ts +27 -26
  175. package/lib/esm/resources/captures.d.ts +19 -18
  176. package/lib/esm/resources/carrier_accounts.d.ts +7 -6
  177. package/lib/esm/resources/checkout_com_gateways.d.ts +12 -11
  178. package/lib/esm/resources/checkout_com_payments.d.ts +25 -24
  179. package/lib/esm/resources/cleanups.d.ts +13 -12
  180. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -6
  181. package/lib/esm/resources/coupon_recipients.d.ts +13 -12
  182. package/lib/esm/resources/coupons.d.ts +13 -12
  183. package/lib/esm/resources/customer_addresses.d.ts +8 -7
  184. package/lib/esm/resources/customer_groups.d.ts +6 -5
  185. package/lib/esm/resources/customer_password_resets.d.ts +8 -7
  186. package/lib/esm/resources/customer_payment_sources.d.ts +9 -8
  187. package/lib/esm/resources/customer_subscriptions.d.ts +4 -3
  188. package/lib/esm/resources/customers.d.ts +19 -18
  189. package/lib/esm/resources/delivery_lead_times.d.ts +11 -10
  190. package/lib/esm/resources/event_callbacks.d.ts +6 -5
  191. package/lib/esm/resources/events.d.ts +4 -3
  192. package/lib/esm/resources/exports.d.ts +17 -16
  193. package/lib/esm/resources/external_gateways.d.ts +20 -19
  194. package/lib/esm/resources/external_payments.d.ts +10 -9
  195. package/lib/esm/resources/external_promotions.d.ts +29 -28
  196. package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
  197. package/lib/esm/resources/fixed_amount_promotions.d.ts +31 -30
  198. package/lib/esm/resources/fixed_price_promotions.d.ts +36 -35
  199. package/lib/esm/resources/fixed_price_promotions.js +4 -4
  200. package/lib/esm/resources/free_gift_promotions.d.ts +36 -35
  201. package/lib/esm/resources/free_gift_promotions.js +4 -4
  202. package/lib/esm/resources/free_shipping_promotions.d.ts +30 -26
  203. package/lib/esm/resources/free_shipping_promotions.js +4 -0
  204. package/lib/esm/resources/geocoders.d.ts +4 -3
  205. package/lib/esm/resources/gift_card_recipients.d.ts +13 -12
  206. package/lib/esm/resources/gift_cards.d.ts +41 -40
  207. package/lib/esm/resources/google_geocoders.d.ts +6 -5
  208. package/lib/esm/resources/imports.d.ts +20 -19
  209. package/lib/esm/resources/in_stock_subscriptions.d.ts +20 -19
  210. package/lib/esm/resources/inventory_models.d.ts +12 -11
  211. package/lib/esm/resources/inventory_return_locations.d.ts +7 -6
  212. package/lib/esm/resources/inventory_stock_locations.d.ts +10 -9
  213. package/lib/esm/resources/klarna_gateways.d.ts +10 -9
  214. package/lib/esm/resources/klarna_payments.d.ts +14 -13
  215. package/lib/esm/resources/line_item_options.d.ts +18 -17
  216. package/lib/esm/resources/line_items.d.ts +47 -43
  217. package/lib/esm/resources/manual_gateways.d.ts +4 -3
  218. package/lib/esm/resources/manual_tax_calculators.d.ts +8 -7
  219. package/lib/esm/resources/markets.d.ts +41 -32
  220. package/lib/esm/resources/markets.js +4 -0
  221. package/lib/esm/resources/merchants.d.ts +6 -5
  222. package/lib/esm/resources/order_amount_promotion_rules.d.ts +9 -8
  223. package/lib/esm/resources/order_copies.d.ts +23 -20
  224. package/lib/esm/resources/order_copies.js +7 -4
  225. package/lib/esm/resources/order_factories.d.ts +34 -0
  226. package/lib/esm/resources/order_factories.js +26 -0
  227. package/lib/esm/resources/order_subscription_items.d.ts +61 -0
  228. package/lib/esm/resources/order_subscription_items.js +27 -0
  229. package/lib/esm/resources/order_subscriptions.d.ts +52 -29
  230. package/lib/esm/resources/order_subscriptions.js +18 -2
  231. package/lib/esm/resources/order_validation_rules.d.ts +4 -3
  232. package/lib/esm/resources/orders.d.ts +192 -183
  233. package/lib/esm/resources/orders.js +8 -0
  234. package/lib/esm/resources/organization.d.ts +18 -17
  235. package/lib/esm/resources/packages.d.ts +14 -13
  236. package/lib/esm/resources/parcel_line_items.d.ts +7 -6
  237. package/lib/esm/resources/parcels.d.ts +75 -74
  238. package/lib/esm/resources/payment_gateways.d.ts +3 -2
  239. package/lib/esm/resources/payment_methods.d.ts +33 -32
  240. package/lib/esm/resources/paypal_gateways.d.ts +7 -6
  241. package/lib/esm/resources/paypal_payments.d.ts +17 -16
  242. package/lib/esm/resources/percentage_discount_promotions.d.ts +35 -34
  243. package/lib/esm/resources/percentage_discount_promotions.js +4 -4
  244. package/lib/esm/resources/price_frequency_tiers.d.ts +50 -0
  245. package/lib/esm/resources/price_frequency_tiers.js +35 -0
  246. package/lib/esm/resources/price_lists.d.ts +9 -8
  247. package/lib/esm/resources/price_tiers.d.ts +7 -6
  248. package/lib/esm/resources/price_volume_tiers.d.ts +15 -11
  249. package/lib/esm/resources/price_volume_tiers.js +4 -0
  250. package/lib/esm/resources/prices.d.ts +20 -16
  251. package/lib/esm/resources/prices.js +4 -0
  252. package/lib/esm/resources/promotion_rules.d.ts +3 -2
  253. package/lib/esm/resources/promotions.d.ts +14 -10
  254. package/lib/esm/resources/promotions.js +4 -0
  255. package/lib/esm/resources/recurring_order_copies.d.ts +53 -0
  256. package/lib/esm/resources/recurring_order_copies.js +39 -0
  257. package/lib/esm/resources/refunds.d.ts +10 -9
  258. package/lib/esm/resources/return_line_items.d.ts +13 -12
  259. package/lib/esm/resources/returns.d.ts +31 -30
  260. package/lib/esm/resources/satispay_gateways.d.ts +8 -7
  261. package/lib/esm/resources/satispay_payments.d.ts +12 -11
  262. package/lib/esm/resources/shipments.d.ts +42 -41
  263. package/lib/esm/resources/shipping_categories.d.ts +5 -4
  264. package/lib/esm/resources/shipping_method_tiers.d.ts +7 -6
  265. package/lib/esm/resources/shipping_methods.d.ts +50 -49
  266. package/lib/esm/resources/shipping_weight_tiers.d.ts +12 -11
  267. package/lib/esm/resources/shipping_zones.d.ts +22 -21
  268. package/lib/esm/resources/sku_list_items.d.ts +13 -12
  269. package/lib/esm/resources/sku_list_promotion_rules.d.ts +14 -13
  270. package/lib/esm/resources/sku_lists.d.ts +22 -21
  271. package/lib/esm/resources/sku_options.d.ts +25 -24
  272. package/lib/esm/resources/skus.d.ts +36 -35
  273. package/lib/esm/resources/stock_items.d.ts +12 -11
  274. package/lib/esm/resources/stock_line_items.d.ts +7 -6
  275. package/lib/esm/resources/stock_locations.d.ts +17 -16
  276. package/lib/esm/resources/stock_transfers.d.ts +24 -23
  277. package/lib/esm/resources/stripe_gateways.d.ts +12 -11
  278. package/lib/esm/resources/stripe_payments.d.ts +15 -14
  279. package/lib/esm/resources/subscription_models.d.ts +49 -0
  280. package/lib/esm/resources/subscription_models.js +35 -0
  281. package/lib/esm/resources/tax_calculators.d.ts +4 -3
  282. package/lib/esm/resources/tax_categories.d.ts +10 -9
  283. package/lib/esm/resources/tax_rules.d.ts +39 -38
  284. package/lib/esm/resources/taxjar_accounts.d.ts +9 -8
  285. package/lib/esm/resources/transactions.d.ts +8 -7
  286. package/lib/esm/resources/voids.d.ts +10 -9
  287. package/lib/esm/resources/webhooks.d.ts +14 -13
  288. package/lib/esm/resources/wire_transfers.d.ts +5 -4
  289. package/lib/esm/static.d.ts +1 -1
  290. package/lib/esm/util.d.ts +1 -3
  291. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  292. package/lib/tsconfig.tsbuildinfo +1 -1
  293. package/package.json +10 -10
@@ -1,4 +1,5 @@
1
- import { ApiResource, Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
2
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
3
4
  import type { Event } from './events';
4
5
  type ExportType = 'exports';
@@ -8,24 +9,24 @@ type ExportRel = ResourceRel & {
8
9
  interface Export extends Resource {
9
10
  readonly type: ExportType;
10
11
  resource_type: string;
11
- format?: string;
12
- status?: 'pending' | 'in_progress' | 'completed';
13
- includes?: string[];
14
- filters?: object;
15
- dry_data?: boolean;
16
- started_at?: string;
17
- completed_at?: string;
18
- interrupted_at?: string;
19
- records_count?: number;
20
- attachment_url?: string;
21
- events?: Event[];
12
+ format?: string | null;
13
+ status: 'pending' | 'in_progress' | 'completed';
14
+ includes?: string[] | null;
15
+ filters?: object | null;
16
+ dry_data?: boolean | null;
17
+ started_at?: string | null;
18
+ completed_at?: string | null;
19
+ interrupted_at?: string | null;
20
+ records_count?: number | null;
21
+ attachment_url?: string | null;
22
+ events?: Event[] | null;
22
23
  }
23
24
  interface ExportCreate extends ResourceCreate {
24
25
  resource_type: string;
25
- format?: string;
26
- includes?: string[];
27
- filters?: object;
28
- dry_data?: boolean;
26
+ format?: string | null;
27
+ includes?: string[] | null;
28
+ filters?: object | null;
29
+ dry_data?: boolean | null;
29
30
  }
30
31
  declare class Exports extends ApiResource<Export> {
31
32
  static readonly TYPE: ExportType;
@@ -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 { PaymentMethod } from './payment_methods';
4
5
  import type { ExternalPayment } from './external_payments';
@@ -10,29 +11,29 @@ interface ExternalGateway extends Resource {
10
11
  readonly type: ExternalGatewayType;
11
12
  name: string;
12
13
  shared_secret: string;
13
- authorize_url?: string;
14
- capture_url?: string;
15
- void_url?: string;
16
- refund_url?: string;
17
- token_url?: string;
18
- payment_methods?: PaymentMethod[];
19
- external_payments?: ExternalPayment[];
14
+ authorize_url?: string | null;
15
+ capture_url?: string | null;
16
+ void_url?: string | null;
17
+ refund_url?: string | null;
18
+ token_url?: string | null;
19
+ payment_methods?: PaymentMethod[] | null;
20
+ external_payments?: ExternalPayment[] | null;
20
21
  }
21
22
  interface ExternalGatewayCreate extends ResourceCreate {
22
23
  name: string;
23
- authorize_url?: string;
24
- capture_url?: string;
25
- void_url?: string;
26
- refund_url?: string;
27
- token_url?: string;
24
+ authorize_url?: string | null;
25
+ capture_url?: string | null;
26
+ void_url?: string | null;
27
+ refund_url?: string | null;
28
+ token_url?: string | null;
28
29
  }
29
30
  interface ExternalGatewayUpdate extends ResourceUpdate {
30
- name: string;
31
- authorize_url?: string;
32
- capture_url?: string;
33
- void_url?: string;
34
- refund_url?: string;
35
- token_url?: string;
31
+ name?: string | null;
32
+ authorize_url?: string | null;
33
+ capture_url?: string | null;
34
+ void_url?: string | null;
35
+ refund_url?: string | null;
36
+ token_url?: string | null;
36
37
  }
37
38
  declare class ExternalGateways extends ApiResource<ExternalGateway> {
38
39
  static readonly TYPE: ExternalGatewayType;
@@ -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 { Order, OrderType } from './orders';
4
5
  import type { PaymentGateway } from './payment_gateways';
@@ -13,20 +14,20 @@ type OrderRel = ResourceRel & {
13
14
  interface ExternalPayment extends Resource {
14
15
  readonly type: ExternalPaymentType;
15
16
  payment_source_token: string;
16
- options?: object;
17
- payment_instrument?: object;
18
- order?: Order;
19
- payment_gateway?: PaymentGateway;
20
- wallet?: CustomerPaymentSource;
17
+ options?: object | null;
18
+ payment_instrument?: object | null;
19
+ order?: Order | null;
20
+ payment_gateway?: PaymentGateway | null;
21
+ wallet?: CustomerPaymentSource | null;
21
22
  }
22
23
  interface ExternalPaymentCreate extends ResourceCreate {
23
24
  payment_source_token: string;
24
- options?: object;
25
+ options?: object | null;
25
26
  order: OrderRel;
26
27
  }
27
28
  interface ExternalPaymentUpdate extends ResourceUpdate {
28
- options?: object;
29
- order?: OrderRel;
29
+ options?: object | null;
30
+ order?: OrderRel | null;
30
31
  }
31
32
  declare class ExternalPayments extends ApiResource<ExternalPayment> {
32
33
  static readonly TYPE: ExternalPaymentType;
@@ -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 { Market, MarketType } from './markets';
4
5
  import type { PromotionRule, PromotionRuleType } from './promotion_rules';
@@ -29,47 +30,47 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
29
30
  interface ExternalPromotion extends Resource {
30
31
  readonly type: ExternalPromotionType;
31
32
  name: string;
32
- currency_code?: string;
33
+ currency_code?: string | null;
33
34
  starts_at: string;
34
35
  expires_at: string;
35
36
  total_usage_limit: number;
36
- total_usage_count?: number;
37
- active?: boolean;
37
+ total_usage_count?: number | null;
38
+ active?: boolean | null;
38
39
  promotion_url: string;
39
40
  shared_secret: string;
40
- market?: Market;
41
- promotion_rules?: PromotionRule[];
42
- order_amount_promotion_rule?: OrderAmountPromotionRule;
43
- sku_list_promotion_rule?: SkuListPromotionRule;
44
- coupon_codes_promotion_rule?: CouponCodesPromotionRule;
45
- attachments?: Attachment[];
46
- events?: Event[];
41
+ market?: Market | null;
42
+ promotion_rules?: PromotionRule[] | null;
43
+ order_amount_promotion_rule?: OrderAmountPromotionRule | null;
44
+ sku_list_promotion_rule?: SkuListPromotionRule | null;
45
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
46
+ attachments?: Attachment[] | null;
47
+ events?: Event[] | null;
47
48
  }
48
49
  interface ExternalPromotionCreate extends ResourceCreate {
49
50
  name: string;
50
- currency_code?: string;
51
+ currency_code?: string | null;
51
52
  starts_at: string;
52
53
  expires_at: string;
53
54
  total_usage_limit: number;
54
55
  promotion_url: string;
55
- market?: MarketRel;
56
- promotion_rules?: PromotionRuleRel[];
57
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
58
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
59
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
56
+ market?: MarketRel | null;
57
+ promotion_rules?: PromotionRuleRel[] | null;
58
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
59
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
60
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
60
61
  }
61
62
  interface ExternalPromotionUpdate extends ResourceUpdate {
62
- name: string;
63
- currency_code?: string;
64
- starts_at: string;
65
- expires_at: string;
66
- total_usage_limit: number;
67
- promotion_url: string;
68
- market?: MarketRel;
69
- promotion_rules?: PromotionRuleRel[];
70
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
71
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
72
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
63
+ name?: string | null;
64
+ currency_code?: string | null;
65
+ starts_at?: string | null;
66
+ expires_at?: string | null;
67
+ total_usage_limit?: number | null;
68
+ promotion_url?: string | null;
69
+ market?: MarketRel | null;
70
+ promotion_rules?: PromotionRuleRel[] | null;
71
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
72
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
73
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
73
74
  }
74
75
  declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
75
76
  static readonly TYPE: ExternalPromotionType;
@@ -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 { Market } from './markets';
4
5
  import type { Attachment } from './attachments';
@@ -11,16 +12,16 @@ interface ExternalTaxCalculator extends Resource {
11
12
  name: string;
12
13
  tax_calculator_url: string;
13
14
  shared_secret: string;
14
- markets?: Market[];
15
- attachments?: Attachment[];
15
+ markets?: Market[] | null;
16
+ attachments?: Attachment[] | null;
16
17
  }
17
18
  interface ExternalTaxCalculatorCreate extends ResourceCreate {
18
19
  name: string;
19
20
  tax_calculator_url: string;
20
21
  }
21
22
  interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
22
- name: string;
23
- tax_calculator_url: string;
23
+ name?: string | null;
24
+ tax_calculator_url?: string | null;
24
25
  }
25
26
  declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
26
27
  static readonly TYPE: ExternalTaxCalculatorType;
@@ -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 { Market, MarketType } from './markets';
4
5
  import type { PromotionRule, PromotionRuleType } from './promotion_rules';
@@ -29,48 +30,48 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
29
30
  interface FixedAmountPromotion extends Resource {
30
31
  readonly type: FixedAmountPromotionType;
31
32
  name: string;
32
- currency_code?: string;
33
+ currency_code?: string | null;
33
34
  starts_at: string;
34
35
  expires_at: string;
35
36
  total_usage_limit: number;
36
- total_usage_count?: number;
37
- active?: boolean;
37
+ total_usage_count?: number | null;
38
+ active?: boolean | null;
38
39
  fixed_amount_cents: number;
39
- fixed_amount_float?: number;
40
- formatted_fixed_amount?: string;
41
- market?: Market;
42
- promotion_rules?: PromotionRule[];
43
- order_amount_promotion_rule?: OrderAmountPromotionRule;
44
- sku_list_promotion_rule?: SkuListPromotionRule;
45
- coupon_codes_promotion_rule?: CouponCodesPromotionRule;
46
- attachments?: Attachment[];
47
- events?: Event[];
40
+ fixed_amount_float?: number | null;
41
+ formatted_fixed_amount?: string | null;
42
+ market?: Market | null;
43
+ promotion_rules?: PromotionRule[] | null;
44
+ order_amount_promotion_rule?: OrderAmountPromotionRule | null;
45
+ sku_list_promotion_rule?: SkuListPromotionRule | null;
46
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
47
+ attachments?: Attachment[] | null;
48
+ events?: Event[] | null;
48
49
  }
49
50
  interface FixedAmountPromotionCreate extends ResourceCreate {
50
51
  name: string;
51
- currency_code?: string;
52
+ currency_code?: string | null;
52
53
  starts_at: string;
53
54
  expires_at: string;
54
55
  total_usage_limit: number;
55
56
  fixed_amount_cents: number;
56
- market?: MarketRel;
57
- promotion_rules?: PromotionRuleRel[];
58
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
59
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
60
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
57
+ market?: MarketRel | null;
58
+ promotion_rules?: PromotionRuleRel[] | null;
59
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
60
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
61
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
61
62
  }
62
63
  interface FixedAmountPromotionUpdate extends ResourceUpdate {
63
- name: string;
64
- currency_code?: string;
65
- starts_at: string;
66
- expires_at: string;
67
- total_usage_limit: number;
68
- fixed_amount_cents: number;
69
- market?: MarketRel;
70
- promotion_rules?: PromotionRuleRel[];
71
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
72
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
73
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
64
+ name?: string | null;
65
+ currency_code?: string | null;
66
+ starts_at?: string | null;
67
+ expires_at?: string | null;
68
+ total_usage_limit?: number | null;
69
+ fixed_amount_cents?: number | null;
70
+ market?: MarketRel | null;
71
+ promotion_rules?: PromotionRuleRel[] | null;
72
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
73
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
74
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
74
75
  }
75
76
  declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
76
77
  static readonly TYPE: FixedAmountPromotionType;
@@ -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 { Market, MarketType } from './markets';
4
5
  import type { PromotionRule, PromotionRuleType } from './promotion_rules';
@@ -6,9 +7,9 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
6
7
  import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
7
8
  import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
8
9
  import type { Attachment } from './attachments';
10
+ import type { Event } from './events';
9
11
  import type { SkuList, SkuListType } from './sku_lists';
10
12
  import type { Sku } from './skus';
11
- import type { Event } from './events';
12
13
  type FixedPricePromotionType = 'fixed_price_promotions';
13
14
  type FixedPricePromotionRel = ResourceRel & {
14
15
  type: FixedPricePromotionType;
@@ -34,52 +35,52 @@ type SkuListRel = ResourceRel & {
34
35
  interface FixedPricePromotion extends Resource {
35
36
  readonly type: FixedPricePromotionType;
36
37
  name: string;
37
- currency_code?: string;
38
+ currency_code?: string | null;
38
39
  starts_at: string;
39
40
  expires_at: string;
40
41
  total_usage_limit: number;
41
- total_usage_count?: number;
42
- active?: boolean;
42
+ total_usage_count?: number | null;
43
+ active?: boolean | null;
43
44
  fixed_amount_cents: number;
44
- fixed_amount_float?: number;
45
- formatted_fixed_amount?: string;
46
- market?: Market;
47
- promotion_rules?: PromotionRule[];
48
- order_amount_promotion_rule?: OrderAmountPromotionRule;
49
- sku_list_promotion_rule?: SkuListPromotionRule;
50
- coupon_codes_promotion_rule?: CouponCodesPromotionRule;
51
- attachments?: Attachment[];
52
- sku_list?: SkuList;
53
- skus?: Sku[];
54
- events?: Event[];
45
+ fixed_amount_float?: number | null;
46
+ formatted_fixed_amount?: string | null;
47
+ market?: Market | null;
48
+ promotion_rules?: PromotionRule[] | null;
49
+ order_amount_promotion_rule?: OrderAmountPromotionRule | null;
50
+ sku_list_promotion_rule?: SkuListPromotionRule | null;
51
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
52
+ attachments?: Attachment[] | null;
53
+ events?: Event[] | null;
54
+ sku_list?: SkuList | null;
55
+ skus?: Sku[] | null;
55
56
  }
56
57
  interface FixedPricePromotionCreate extends ResourceCreate {
57
58
  name: string;
58
- currency_code?: string;
59
+ currency_code?: string | null;
59
60
  starts_at: string;
60
61
  expires_at: string;
61
62
  total_usage_limit: number;
62
63
  fixed_amount_cents: number;
63
- market?: MarketRel;
64
- promotion_rules?: PromotionRuleRel[];
65
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
66
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
67
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
64
+ market?: MarketRel | null;
65
+ promotion_rules?: PromotionRuleRel[] | null;
66
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
67
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
68
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
68
69
  sku_list: SkuListRel;
69
70
  }
70
71
  interface FixedPricePromotionUpdate extends ResourceUpdate {
71
- name: string;
72
- currency_code?: string;
73
- starts_at: string;
74
- expires_at: string;
75
- total_usage_limit: number;
76
- fixed_amount_cents: number;
77
- market?: MarketRel;
78
- promotion_rules?: PromotionRuleRel[];
79
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
80
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
81
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
82
- sku_list?: SkuListRel;
72
+ name?: string | null;
73
+ currency_code?: string | null;
74
+ starts_at?: string | null;
75
+ expires_at?: string | null;
76
+ total_usage_limit?: number | null;
77
+ fixed_amount_cents?: number | null;
78
+ market?: MarketRel | null;
79
+ promotion_rules?: PromotionRuleRel[] | null;
80
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
81
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
82
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
83
+ sku_list?: SkuListRel | null;
83
84
  }
84
85
  declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
85
86
  static readonly TYPE: FixedPricePromotionType;
@@ -91,9 +92,9 @@ declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
91
92
  sku_list_promotion_rule(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
92
93
  coupon_codes_promotion_rule(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
93
94
  attachments(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
95
+ events(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
94
96
  sku_list(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
95
97
  skus(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
96
- events(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
97
98
  isFixedPricePromotion(resource: any): resource is FixedPricePromotion;
98
99
  relationship(id: string | ResourceId | null): FixedPricePromotionRel;
99
100
  type(): FixedPricePromotionType;
@@ -29,6 +29,10 @@ class FixedPricePromotions extends ApiResource {
29
29
  const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
30
30
  return this.resources.fetch({ type: 'attachments' }, `fixed_price_promotions/${_fixedPricePromotionId}/attachments`, params, options);
31
31
  }
32
+ async events(fixedPricePromotionId, params, options) {
33
+ const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
34
+ return this.resources.fetch({ type: 'events' }, `fixed_price_promotions/${_fixedPricePromotionId}/events`, params, options);
35
+ }
32
36
  async sku_list(fixedPricePromotionId, params, options) {
33
37
  const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
34
38
  return this.resources.fetch({ type: 'sku_lists' }, `fixed_price_promotions/${_fixedPricePromotionId}/sku_list`, params, options);
@@ -37,10 +41,6 @@ class FixedPricePromotions extends ApiResource {
37
41
  const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
38
42
  return this.resources.fetch({ type: 'skus' }, `fixed_price_promotions/${_fixedPricePromotionId}/skus`, params, options);
39
43
  }
40
- async events(fixedPricePromotionId, params, options) {
41
- const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
42
- return this.resources.fetch({ type: 'events' }, `fixed_price_promotions/${_fixedPricePromotionId}/events`, params, options);
43
- }
44
44
  isFixedPricePromotion(resource) {
45
45
  return resource.type && (resource.type === FixedPricePromotions.TYPE);
46
46
  }
@@ -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 { Market, MarketType } from './markets';
4
5
  import type { PromotionRule, PromotionRuleType } from './promotion_rules';
@@ -6,9 +7,9 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
6
7
  import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
7
8
  import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
8
9
  import type { Attachment } from './attachments';
10
+ import type { Event } from './events';
9
11
  import type { SkuList, SkuListType } from './sku_lists';
10
12
  import type { Sku } from './skus';
11
- import type { Event } from './events';
12
13
  type FreeGiftPromotionType = 'free_gift_promotions';
13
14
  type FreeGiftPromotionRel = ResourceRel & {
14
15
  type: FreeGiftPromotionType;
@@ -34,50 +35,50 @@ type SkuListRel = ResourceRel & {
34
35
  interface FreeGiftPromotion extends Resource {
35
36
  readonly type: FreeGiftPromotionType;
36
37
  name: string;
37
- currency_code?: string;
38
+ currency_code?: string | null;
38
39
  starts_at: string;
39
40
  expires_at: string;
40
41
  total_usage_limit: number;
41
- total_usage_count?: number;
42
- active?: boolean;
43
- max_quantity?: number;
44
- market?: Market;
45
- promotion_rules?: PromotionRule[];
46
- order_amount_promotion_rule?: OrderAmountPromotionRule;
47
- sku_list_promotion_rule?: SkuListPromotionRule;
48
- coupon_codes_promotion_rule?: CouponCodesPromotionRule;
49
- attachments?: Attachment[];
50
- sku_list?: SkuList;
51
- skus?: Sku[];
52
- events?: Event[];
42
+ total_usage_count?: number | null;
43
+ active?: boolean | null;
44
+ max_quantity?: number | null;
45
+ market?: Market | null;
46
+ promotion_rules?: PromotionRule[] | null;
47
+ order_amount_promotion_rule?: OrderAmountPromotionRule | null;
48
+ sku_list_promotion_rule?: SkuListPromotionRule | null;
49
+ coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
50
+ attachments?: Attachment[] | null;
51
+ events?: Event[] | null;
52
+ sku_list?: SkuList | null;
53
+ skus?: Sku[] | null;
53
54
  }
54
55
  interface FreeGiftPromotionCreate extends ResourceCreate {
55
56
  name: string;
56
- currency_code?: string;
57
+ currency_code?: string | null;
57
58
  starts_at: string;
58
59
  expires_at: string;
59
60
  total_usage_limit: number;
60
- max_quantity?: number;
61
- market?: MarketRel;
62
- promotion_rules?: PromotionRuleRel[];
63
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
64
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
65
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
61
+ max_quantity?: number | null;
62
+ market?: MarketRel | null;
63
+ promotion_rules?: PromotionRuleRel[] | null;
64
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
65
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
66
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
66
67
  sku_list: SkuListRel;
67
68
  }
68
69
  interface FreeGiftPromotionUpdate extends ResourceUpdate {
69
- name: string;
70
- currency_code?: string;
71
- starts_at: string;
72
- expires_at: string;
73
- total_usage_limit: number;
74
- max_quantity?: number;
75
- market?: MarketRel;
76
- promotion_rules?: PromotionRuleRel[];
77
- order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
78
- sku_list_promotion_rule?: SkuListPromotionRuleRel;
79
- coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
80
- sku_list?: SkuListRel;
70
+ name?: string | null;
71
+ currency_code?: string | null;
72
+ starts_at?: string | null;
73
+ expires_at?: string | null;
74
+ total_usage_limit?: number | null;
75
+ max_quantity?: number | null;
76
+ market?: MarketRel | null;
77
+ promotion_rules?: PromotionRuleRel[] | null;
78
+ order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
79
+ sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
80
+ coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
81
+ sku_list?: SkuListRel | null;
81
82
  }
82
83
  declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
83
84
  static readonly TYPE: FreeGiftPromotionType;
@@ -89,9 +90,9 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
89
90
  sku_list_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
90
91
  coupon_codes_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
91
92
  attachments(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
93
+ events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
92
94
  sku_list(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
93
95
  skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
94
- events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
95
96
  isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
96
97
  relationship(id: string | ResourceId | null): FreeGiftPromotionRel;
97
98
  type(): FreeGiftPromotionType;
@@ -29,6 +29,10 @@ class FreeGiftPromotions extends ApiResource {
29
29
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
30
30
  return this.resources.fetch({ type: 'attachments' }, `free_gift_promotions/${_freeGiftPromotionId}/attachments`, params, options);
31
31
  }
32
+ async events(freeGiftPromotionId, params, options) {
33
+ const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
34
+ return this.resources.fetch({ type: 'events' }, `free_gift_promotions/${_freeGiftPromotionId}/events`, params, options);
35
+ }
32
36
  async sku_list(freeGiftPromotionId, params, options) {
33
37
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
34
38
  return this.resources.fetch({ type: 'sku_lists' }, `free_gift_promotions/${_freeGiftPromotionId}/sku_list`, params, options);
@@ -37,10 +41,6 @@ class FreeGiftPromotions extends ApiResource {
37
41
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
38
42
  return this.resources.fetch({ type: 'skus' }, `free_gift_promotions/${_freeGiftPromotionId}/skus`, params, options);
39
43
  }
40
- async events(freeGiftPromotionId, params, options) {
41
- const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
42
- return this.resources.fetch({ type: 'events' }, `free_gift_promotions/${_freeGiftPromotionId}/events`, params, options);
43
- }
44
44
  isFreeGiftPromotion(resource) {
45
45
  return resource.type && (resource.type === FreeGiftPromotions.TYPE);
46
46
  }