@commercelayer/sdk 5.28.0 → 5.29.0-alfa.2

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 (211) hide show
  1. package/lib/cjs/api.d.ts +3 -2
  2. package/lib/cjs/api.js +5 -2
  3. package/lib/cjs/client.js +5 -5
  4. package/lib/cjs/commercelayer.d.ts +3 -2
  5. package/lib/cjs/commercelayer.js +5 -4
  6. package/lib/cjs/common.js +1 -1
  7. package/lib/cjs/error.js +1 -2
  8. package/lib/cjs/model.d.ts +1 -0
  9. package/lib/cjs/query.d.ts +1 -1
  10. package/lib/cjs/query.js +1 -1
  11. package/lib/cjs/resource.js +22 -25
  12. package/lib/cjs/resources/adjustments.d.ts +3 -0
  13. package/lib/cjs/resources/adyen_gateways.d.ts +2 -2
  14. package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +4 -14
  15. package/lib/cjs/resources/buy_x_pay_y_promotions.js +4 -4
  16. package/lib/cjs/resources/external_gateways.d.ts +5 -1
  17. package/lib/cjs/resources/external_gateways.js +3 -0
  18. package/lib/cjs/resources/external_promotions.d.ts +8 -14
  19. package/lib/cjs/resources/external_promotions.js +7 -4
  20. package/lib/cjs/resources/external_tax_calculators.d.ts +4 -0
  21. package/lib/cjs/resources/external_tax_calculators.js +3 -0
  22. package/lib/cjs/resources/fixed_amount_promotions.d.ts +4 -14
  23. package/lib/cjs/resources/fixed_amount_promotions.js +4 -4
  24. package/lib/cjs/resources/fixed_price_promotions.d.ts +4 -14
  25. package/lib/cjs/resources/fixed_price_promotions.js +4 -4
  26. package/lib/cjs/resources/free_gift_promotions.d.ts +4 -14
  27. package/lib/cjs/resources/free_gift_promotions.js +4 -4
  28. package/lib/cjs/resources/free_shipping_promotions.d.ts +9 -14
  29. package/lib/cjs/resources/free_shipping_promotions.js +4 -4
  30. package/lib/cjs/resources/gift_cards.d.ts +3 -0
  31. package/lib/cjs/resources/line_items.d.ts +12 -4
  32. package/lib/cjs/resources/line_items.js +3 -0
  33. package/lib/cjs/resources/markets.d.ts +1 -1
  34. package/lib/cjs/resources/order_subscriptions.d.ts +1 -4
  35. package/lib/cjs/resources/orders.d.ts +14 -1
  36. package/lib/cjs/resources/orders.js +10 -0
  37. package/lib/cjs/resources/parcel_line_items.d.ts +0 -8
  38. package/lib/cjs/resources/payment_methods.d.ts +8 -5
  39. package/lib/cjs/resources/percentage_discount_promotions.d.ts +4 -14
  40. package/lib/cjs/resources/percentage_discount_promotions.js +4 -4
  41. package/lib/cjs/resources/promotions.d.ts +3 -3
  42. package/lib/cjs/resources/promotions.js +4 -4
  43. package/lib/cjs/resources/resource_errors.d.ts +22 -0
  44. package/lib/cjs/resources/resource_errors.js +16 -0
  45. package/lib/cjs/resources/shipments.d.ts +0 -4
  46. package/lib/cjs/resources/shipping_methods.d.ts +9 -5
  47. package/lib/cjs/resources/shipping_methods.js +3 -0
  48. package/lib/cjs/resources/stock_transfers.d.ts +1 -1
  49. package/lib/cjs/resources/stripe_payments.d.ts +4 -1
  50. package/lib/cjs/resources/webhooks.d.ts +3 -3
  51. package/lib/cjs/resources/webhooks.js +3 -3
  52. package/lib/esm/api.d.ts +3 -2
  53. package/lib/esm/api.js +2 -0
  54. package/lib/esm/client.js +19 -30
  55. package/lib/esm/commercelayer.d.ts +3 -2
  56. package/lib/esm/commercelayer.js +261 -149
  57. package/lib/esm/common.js +1 -1
  58. package/lib/esm/error.js +10 -5
  59. package/lib/esm/model.d.ts +1 -0
  60. package/lib/esm/query.d.ts +1 -1
  61. package/lib/esm/query.js +1 -1
  62. package/lib/esm/resource.js +37 -50
  63. package/lib/esm/resources/addresses.js +1 -1
  64. package/lib/esm/resources/adjustments.d.ts +3 -0
  65. package/lib/esm/resources/adjustments.js +1 -1
  66. package/lib/esm/resources/adyen_gateways.d.ts +2 -2
  67. package/lib/esm/resources/adyen_gateways.js +1 -1
  68. package/lib/esm/resources/adyen_payments.js +1 -1
  69. package/lib/esm/resources/application.js +1 -1
  70. package/lib/esm/resources/attachments.js +1 -1
  71. package/lib/esm/resources/authorizations.js +1 -1
  72. package/lib/esm/resources/avalara_accounts.js +1 -1
  73. package/lib/esm/resources/axerve_gateways.js +1 -1
  74. package/lib/esm/resources/axerve_payments.js +1 -1
  75. package/lib/esm/resources/billing_info_validation_rules.js +1 -1
  76. package/lib/esm/resources/bing_geocoders.js +1 -1
  77. package/lib/esm/resources/braintree_gateways.js +1 -1
  78. package/lib/esm/resources/braintree_payments.js +1 -1
  79. package/lib/esm/resources/bundles.js +1 -1
  80. package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +4 -14
  81. package/lib/esm/resources/buy_x_pay_y_promotions.js +5 -5
  82. package/lib/esm/resources/captures.js +1 -1
  83. package/lib/esm/resources/carrier_accounts.js +1 -1
  84. package/lib/esm/resources/checkout_com_gateways.js +1 -1
  85. package/lib/esm/resources/checkout_com_payments.js +1 -1
  86. package/lib/esm/resources/cleanups.js +1 -1
  87. package/lib/esm/resources/coupon_codes_promotion_rules.js +1 -1
  88. package/lib/esm/resources/coupon_recipients.js +1 -1
  89. package/lib/esm/resources/coupons.js +1 -1
  90. package/lib/esm/resources/custom_promotion_rules.js +1 -1
  91. package/lib/esm/resources/customer_addresses.js +1 -1
  92. package/lib/esm/resources/customer_groups.js +1 -1
  93. package/lib/esm/resources/customer_password_resets.js +1 -1
  94. package/lib/esm/resources/customer_payment_sources.js +1 -1
  95. package/lib/esm/resources/customer_subscriptions.js +1 -1
  96. package/lib/esm/resources/customers.js +1 -1
  97. package/lib/esm/resources/delivery_lead_times.js +1 -1
  98. package/lib/esm/resources/event_callbacks.js +1 -1
  99. package/lib/esm/resources/events.js +1 -1
  100. package/lib/esm/resources/exports.js +1 -1
  101. package/lib/esm/resources/external_gateways.d.ts +5 -1
  102. package/lib/esm/resources/external_gateways.js +4 -1
  103. package/lib/esm/resources/external_payments.js +1 -1
  104. package/lib/esm/resources/external_promotions.d.ts +8 -14
  105. package/lib/esm/resources/external_promotions.js +8 -5
  106. package/lib/esm/resources/external_tax_calculators.d.ts +4 -0
  107. package/lib/esm/resources/external_tax_calculators.js +4 -1
  108. package/lib/esm/resources/fixed_amount_promotions.d.ts +4 -14
  109. package/lib/esm/resources/fixed_amount_promotions.js +5 -5
  110. package/lib/esm/resources/fixed_price_promotions.d.ts +4 -14
  111. package/lib/esm/resources/fixed_price_promotions.js +5 -5
  112. package/lib/esm/resources/free_gift_promotions.d.ts +4 -14
  113. package/lib/esm/resources/free_gift_promotions.js +5 -5
  114. package/lib/esm/resources/free_shipping_promotions.d.ts +9 -14
  115. package/lib/esm/resources/free_shipping_promotions.js +5 -5
  116. package/lib/esm/resources/geocoders.js +1 -1
  117. package/lib/esm/resources/gift_card_recipients.js +1 -1
  118. package/lib/esm/resources/gift_cards.d.ts +3 -0
  119. package/lib/esm/resources/gift_cards.js +1 -1
  120. package/lib/esm/resources/google_geocoders.js +1 -1
  121. package/lib/esm/resources/imports.js +1 -1
  122. package/lib/esm/resources/in_stock_subscriptions.js +1 -1
  123. package/lib/esm/resources/inventory_models.js +1 -1
  124. package/lib/esm/resources/inventory_return_locations.js +1 -1
  125. package/lib/esm/resources/inventory_stock_locations.js +1 -1
  126. package/lib/esm/resources/klarna_gateways.js +1 -1
  127. package/lib/esm/resources/klarna_payments.js +1 -1
  128. package/lib/esm/resources/line_item_options.js +1 -1
  129. package/lib/esm/resources/line_items.d.ts +12 -4
  130. package/lib/esm/resources/line_items.js +4 -1
  131. package/lib/esm/resources/manual_gateways.js +1 -1
  132. package/lib/esm/resources/manual_tax_calculators.js +1 -1
  133. package/lib/esm/resources/markets.d.ts +1 -1
  134. package/lib/esm/resources/markets.js +1 -1
  135. package/lib/esm/resources/merchants.js +1 -1
  136. package/lib/esm/resources/order_amount_promotion_rules.js +1 -1
  137. package/lib/esm/resources/order_copies.js +1 -1
  138. package/lib/esm/resources/order_factories.js +1 -1
  139. package/lib/esm/resources/order_subscription_items.js +1 -1
  140. package/lib/esm/resources/order_subscriptions.d.ts +1 -4
  141. package/lib/esm/resources/order_subscriptions.js +1 -1
  142. package/lib/esm/resources/order_validation_rules.js +1 -1
  143. package/lib/esm/resources/orders.d.ts +14 -1
  144. package/lib/esm/resources/orders.js +11 -1
  145. package/lib/esm/resources/organization.js +1 -1
  146. package/lib/esm/resources/packages.js +1 -1
  147. package/lib/esm/resources/parcel_line_items.d.ts +0 -8
  148. package/lib/esm/resources/parcel_line_items.js +1 -1
  149. package/lib/esm/resources/parcels.js +1 -1
  150. package/lib/esm/resources/payment_gateways.js +1 -1
  151. package/lib/esm/resources/payment_methods.d.ts +8 -5
  152. package/lib/esm/resources/payment_methods.js +1 -1
  153. package/lib/esm/resources/payment_options.js +1 -1
  154. package/lib/esm/resources/paypal_gateways.js +1 -1
  155. package/lib/esm/resources/paypal_payments.js +1 -1
  156. package/lib/esm/resources/percentage_discount_promotions.d.ts +4 -14
  157. package/lib/esm/resources/percentage_discount_promotions.js +5 -5
  158. package/lib/esm/resources/price_frequency_tiers.js +1 -1
  159. package/lib/esm/resources/price_lists.js +1 -1
  160. package/lib/esm/resources/price_tiers.js +1 -1
  161. package/lib/esm/resources/price_volume_tiers.js +1 -1
  162. package/lib/esm/resources/prices.js +1 -1
  163. package/lib/esm/resources/promotion_rules.js +1 -1
  164. package/lib/esm/resources/promotions.d.ts +3 -3
  165. package/lib/esm/resources/promotions.js +5 -5
  166. package/lib/esm/resources/recurring_order_copies.js +1 -1
  167. package/lib/esm/resources/refunds.js +1 -1
  168. package/lib/esm/resources/reserved_stocks.js +1 -1
  169. package/lib/esm/resources/resource_errors.d.ts +22 -0
  170. package/lib/esm/resources/resource_errors.js +14 -0
  171. package/lib/esm/resources/return_line_items.js +1 -1
  172. package/lib/esm/resources/returns.js +1 -1
  173. package/lib/esm/resources/satispay_gateways.js +1 -1
  174. package/lib/esm/resources/satispay_payments.js +1 -1
  175. package/lib/esm/resources/shipments.d.ts +0 -4
  176. package/lib/esm/resources/shipments.js +1 -1
  177. package/lib/esm/resources/shipping_categories.js +1 -1
  178. package/lib/esm/resources/shipping_method_tiers.js +1 -1
  179. package/lib/esm/resources/shipping_methods.d.ts +9 -5
  180. package/lib/esm/resources/shipping_methods.js +4 -1
  181. package/lib/esm/resources/shipping_weight_tiers.js +1 -1
  182. package/lib/esm/resources/shipping_zones.js +1 -1
  183. package/lib/esm/resources/sku_list_items.js +1 -1
  184. package/lib/esm/resources/sku_list_promotion_rules.js +1 -1
  185. package/lib/esm/resources/sku_lists.js +1 -1
  186. package/lib/esm/resources/sku_options.js +1 -1
  187. package/lib/esm/resources/skus.js +1 -1
  188. package/lib/esm/resources/stock_items.js +1 -1
  189. package/lib/esm/resources/stock_line_items.js +1 -1
  190. package/lib/esm/resources/stock_locations.js +1 -1
  191. package/lib/esm/resources/stock_reservations.js +1 -1
  192. package/lib/esm/resources/stock_transfers.d.ts +1 -1
  193. package/lib/esm/resources/stock_transfers.js +1 -1
  194. package/lib/esm/resources/stripe_gateways.js +1 -1
  195. package/lib/esm/resources/stripe_payments.d.ts +4 -1
  196. package/lib/esm/resources/stripe_payments.js +1 -1
  197. package/lib/esm/resources/subscription_models.js +1 -1
  198. package/lib/esm/resources/tags.js +1 -1
  199. package/lib/esm/resources/tax_calculators.js +1 -1
  200. package/lib/esm/resources/tax_categories.js +1 -1
  201. package/lib/esm/resources/tax_rules.js +1 -1
  202. package/lib/esm/resources/taxjar_accounts.js +1 -1
  203. package/lib/esm/resources/transactions.js +1 -1
  204. package/lib/esm/resources/versions.js +1 -1
  205. package/lib/esm/resources/voids.js +1 -1
  206. package/lib/esm/resources/webhooks.d.ts +3 -3
  207. package/lib/esm/resources/webhooks.js +4 -4
  208. package/lib/esm/resources/wire_transfers.js +1 -1
  209. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  210. package/lib/tsconfig.tsbuildinfo +1 -1
  211. package/package.json +16 -16
@@ -7,8 +7,8 @@ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
7
7
  import type { SkuListPromotionRule } from './sku_list_promotion_rules';
8
8
  import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
9
9
  import type { CustomPromotionRule } from './custom_promotion_rules';
10
- import type { Coupon } from './coupons';
11
10
  import type { SkuList } from './sku_lists';
11
+ import type { Coupon } from './coupons';
12
12
  import type { Attachment } from './attachments';
13
13
  import type { Event } from './events';
14
14
  import type { Tag } from './tags';
@@ -35,8 +35,8 @@ interface Promotion extends Resource {
35
35
  sku_list_promotion_rule?: SkuListPromotionRule | null;
36
36
  coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
37
37
  custom_promotion_rule?: CustomPromotionRule | null;
38
- coupons?: Coupon[] | null;
39
38
  sku_list?: SkuList | null;
39
+ coupons?: Coupon[] | null;
40
40
  attachments?: Attachment[] | null;
41
41
  events?: Event[] | null;
42
42
  tags?: Tag[] | null;
@@ -49,8 +49,8 @@ declare class Promotions extends ApiResource<Promotion> {
49
49
  sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
50
50
  coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
51
51
  custom_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
52
- coupons(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
53
52
  sku_list(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
53
+ coupons(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
54
54
  attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
55
55
  events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
56
56
  tags(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Promotions extends ApiResource {
3
+ static TYPE = 'promotions';
3
4
  async market(promotionId, params, options) {
4
5
  const _promotionId = promotionId.id || promotionId;
5
6
  return this.resources.fetch({ type: 'markets' }, `promotions/${_promotionId}/market`, params, options);
@@ -20,14 +21,14 @@ class Promotions extends ApiResource {
20
21
  const _promotionId = promotionId.id || promotionId;
21
22
  return this.resources.fetch({ type: 'custom_promotion_rules' }, `promotions/${_promotionId}/custom_promotion_rule`, params, options);
22
23
  }
23
- async coupons(promotionId, params, options) {
24
- const _promotionId = promotionId.id || promotionId;
25
- return this.resources.fetch({ type: 'coupons' }, `promotions/${_promotionId}/coupons`, params, options);
26
- }
27
24
  async sku_list(promotionId, params, options) {
28
25
  const _promotionId = promotionId.id || promotionId;
29
26
  return this.resources.fetch({ type: 'sku_lists' }, `promotions/${_promotionId}/sku_list`, params, options);
30
27
  }
28
+ async coupons(promotionId, params, options) {
29
+ const _promotionId = promotionId.id || promotionId;
30
+ return this.resources.fetch({ type: 'coupons' }, `promotions/${_promotionId}/coupons`, params, options);
31
+ }
31
32
  async attachments(promotionId, params, options) {
32
33
  const _promotionId = promotionId.id || promotionId;
33
34
  return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
@@ -54,5 +55,4 @@ class Promotions extends ApiResource {
54
55
  return Promotions.TYPE;
55
56
  }
56
57
  }
57
- Promotions.TYPE = 'promotions';
58
58
  export default Promotions;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class RecurringOrderCopies extends ApiResource {
3
+ static TYPE = 'recurring_order_copies';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
5
6
  }
@@ -35,5 +36,4 @@ class RecurringOrderCopies extends ApiResource {
35
36
  return RecurringOrderCopies.TYPE;
36
37
  }
37
38
  }
38
- RecurringOrderCopies.TYPE = 'recurring_order_copies';
39
39
  export default RecurringOrderCopies;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Refunds extends ApiResource {
3
+ static TYPE = 'refunds';
3
4
  async order(refundId, params, options) {
4
5
  const _refundId = refundId.id || refundId;
5
6
  return this.resources.fetch({ type: 'orders' }, `refunds/${_refundId}/order`, params, options);
@@ -30,5 +31,4 @@ class Refunds extends ApiResource {
30
31
  return Refunds.TYPE;
31
32
  }
32
33
  }
33
- Refunds.TYPE = 'refunds';
34
34
  export default Refunds;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ReservedStocks extends ApiResource {
3
+ static TYPE = 'reserved_stocks';
3
4
  async stock_item(reservedStockId, params, options) {
4
5
  const _reservedStockId = reservedStockId.id || reservedStockId;
5
6
  return this.resources.fetch({ type: 'stock_items' }, `reserved_stocks/${_reservedStockId}/stock_item`, params, options);
@@ -22,5 +23,4 @@ class ReservedStocks extends ApiResource {
22
23
  return ReservedStocks.TYPE;
23
24
  }
24
25
  }
25
- ReservedStocks.TYPE = 'reserved_stocks';
26
26
  export default ReservedStocks;
@@ -0,0 +1,22 @@
1
+ import { ApiResource } from '../resource';
2
+ import type { Resource, ResourceId, ResourceRel } from '../resource';
3
+ import type { Order } from './orders';
4
+ type ResourceErrorType = 'resource_errors';
5
+ type ResourceErrorRel = ResourceRel & {
6
+ type: ResourceErrorType;
7
+ };
8
+ interface ResourceError extends Resource {
9
+ readonly type: ResourceErrorType;
10
+ name: string;
11
+ code: string;
12
+ message: string;
13
+ resource?: Order | null;
14
+ }
15
+ declare class ResourceErrors extends ApiResource<ResourceError> {
16
+ static readonly TYPE: ResourceErrorType;
17
+ isResourceError(resource: any): resource is ResourceError;
18
+ relationship(id: string | ResourceId | null): ResourceErrorRel;
19
+ type(): ResourceErrorType;
20
+ }
21
+ export default ResourceErrors;
22
+ export type { ResourceError, ResourceErrorType };
@@ -0,0 +1,14 @@
1
+ import { ApiResource } from '../resource';
2
+ class ResourceErrors extends ApiResource {
3
+ static TYPE = 'resource_errors';
4
+ isResourceError(resource) {
5
+ return resource.type && (resource.type === ResourceErrors.TYPE);
6
+ }
7
+ relationship(id) {
8
+ return ((id === null) || (typeof id === 'string')) ? { id, type: ResourceErrors.TYPE } : { id: id.id, type: ResourceErrors.TYPE };
9
+ }
10
+ type() {
11
+ return ResourceErrors.TYPE;
12
+ }
13
+ }
14
+ export default ResourceErrors;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ReturnLineItems extends ApiResource {
3
+ static TYPE = 'return_line_items';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: ReturnLineItems.TYPE }, params, options);
5
6
  }
@@ -30,5 +31,4 @@ class ReturnLineItems extends ApiResource {
30
31
  return ReturnLineItems.TYPE;
31
32
  }
32
33
  }
33
- ReturnLineItems.TYPE = 'return_line_items';
34
34
  export default ReturnLineItems;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Returns extends ApiResource {
3
+ static TYPE = 'returns';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: Returns.TYPE }, params, options);
5
6
  }
@@ -86,5 +87,4 @@ class Returns extends ApiResource {
86
87
  return Returns.TYPE;
87
88
  }
88
89
  }
89
- Returns.TYPE = 'returns';
90
90
  export default Returns;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SatispayGateways extends ApiResource {
3
+ static TYPE = 'satispay_gateways';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SatispayGateways.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class SatispayGateways extends ApiResource {
31
32
  return SatispayGateways.TYPE;
32
33
  }
33
34
  }
34
- SatispayGateways.TYPE = 'satispay_gateways';
35
35
  export default SatispayGateways;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SatispayPayments extends ApiResource {
3
+ static TYPE = 'satispay_payments';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SatispayPayments.TYPE }, params, options);
5
6
  }
@@ -34,5 +35,4 @@ class SatispayPayments extends ApiResource {
34
35
  return SatispayPayments.TYPE;
35
36
  }
36
37
  }
37
- SatispayPayments.TYPE = 'satispay_payments';
38
38
  export default SatispayPayments;
@@ -70,10 +70,6 @@ interface Shipment extends Resource {
70
70
  shipping_address?: Address | null;
71
71
  shipping_method?: ShippingMethod | null;
72
72
  delivery_lead_time?: DeliveryLeadTime | null;
73
- /**
74
- * @deprecated This field should not be used as it may be removed in the future without notice
75
- */
76
- shipment_line_items?: object[];
77
73
  stock_line_items?: StockLineItem[] | null;
78
74
  stock_transfers?: StockTransfer[] | null;
79
75
  available_shipping_methods?: ShippingMethod[] | null;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Shipments extends ApiResource {
3
+ static TYPE = 'shipments';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: Shipments.TYPE }, params, options);
5
6
  }
@@ -120,5 +121,4 @@ class Shipments extends ApiResource {
120
121
  return Shipments.TYPE;
121
122
  }
122
123
  }
123
- Shipments.TYPE = 'shipments';
124
124
  export default Shipments;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ShippingCategories extends ApiResource {
3
+ static TYPE = 'shipping_categories';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: ShippingCategories.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class ShippingCategories extends ApiResource {
31
32
  return ShippingCategories.TYPE;
32
33
  }
33
34
  }
34
- ShippingCategories.TYPE = 'shipping_categories';
35
35
  export default ShippingCategories;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ShippingMethodTiers extends ApiResource {
3
+ static TYPE = 'shipping_method_tiers';
3
4
  async shipping_method(shippingMethodTierId, params, options) {
4
5
  const _shippingMethodTierId = shippingMethodTierId.id || shippingMethodTierId;
5
6
  return this.resources.fetch({ type: 'shipping_methods' }, `shipping_method_tiers/${_shippingMethodTierId}/shipping_method`, params, options);
@@ -22,5 +23,4 @@ class ShippingMethodTiers extends ApiResource {
22
23
  return ShippingMethodTiers.TYPE;
23
24
  }
24
25
  }
25
- ShippingMethodTiers.TYPE = 'shipping_method_tiers';
26
26
  export default ShippingMethodTiers;
@@ -35,7 +35,6 @@ interface ShippingMethod extends Resource {
35
35
  scheme?: string | null;
36
36
  currency_code?: string | null;
37
37
  external_prices_url?: string | null;
38
- disabled_at?: string | null;
39
38
  price_amount_cents: number;
40
39
  price_amount_float?: number | null;
41
40
  formatted_price_amount?: string | null;
@@ -49,6 +48,9 @@ interface ShippingMethod extends Resource {
49
48
  min_weight?: number | null;
50
49
  max_weight?: number | null;
51
50
  unit_of_weight?: string | null;
51
+ disabled_at?: string | null;
52
+ circuit_state?: string | null;
53
+ circuit_failure_count?: number | null;
52
54
  market?: Market | null;
53
55
  shipping_zone?: ShippingZone | null;
54
56
  shipping_category?: ShippingCategory | null;
@@ -64,14 +66,14 @@ interface ShippingMethodCreate extends ResourceCreate {
64
66
  scheme?: string | null;
65
67
  currency_code?: string | null;
66
68
  external_prices_url?: string | null;
67
- _disable?: boolean | null;
68
- _enable?: boolean | null;
69
69
  price_amount_cents: number;
70
70
  free_over_amount_cents?: number | null;
71
71
  use_subtotal?: boolean | null;
72
72
  min_weight?: number | null;
73
73
  max_weight?: number | null;
74
74
  unit_of_weight?: string | null;
75
+ _disable?: boolean | null;
76
+ _enable?: boolean | null;
75
77
  market?: MarketRel | null;
76
78
  shipping_zone?: ShippingZoneRel | null;
77
79
  shipping_category?: ShippingCategoryRel | null;
@@ -83,14 +85,15 @@ interface ShippingMethodUpdate extends ResourceUpdate {
83
85
  scheme?: string | null;
84
86
  currency_code?: string | null;
85
87
  external_prices_url?: string | null;
86
- _disable?: boolean | null;
87
- _enable?: boolean | null;
88
88
  price_amount_cents?: number | null;
89
89
  free_over_amount_cents?: number | null;
90
90
  use_subtotal?: boolean | null;
91
91
  min_weight?: number | null;
92
92
  max_weight?: number | null;
93
93
  unit_of_weight?: string | null;
94
+ _disable?: boolean | null;
95
+ _enable?: boolean | null;
96
+ _reset_circuit?: boolean | null;
94
97
  market?: MarketRel | null;
95
98
  shipping_zone?: ShippingZoneRel | null;
96
99
  shipping_category?: ShippingCategoryRel | null;
@@ -113,6 +116,7 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
113
116
  versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
114
117
  _disable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
115
118
  _enable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
119
+ _reset_circuit(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
116
120
  isShippingMethod(resource: any): resource is ShippingMethod;
117
121
  relationship(id: string | ResourceId | null): ShippingMethodRel;
118
122
  type(): ShippingMethodType;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ShippingMethods extends ApiResource {
3
+ static TYPE = 'shipping_methods';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: ShippingMethods.TYPE }, params, options);
5
6
  }
@@ -51,6 +52,9 @@ class ShippingMethods extends ApiResource {
51
52
  async _enable(id, params, options) {
52
53
  return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _enable: true }, params, options);
53
54
  }
55
+ async _reset_circuit(id, params, options) {
56
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _reset_circuit: true }, params, options);
57
+ }
54
58
  isShippingMethod(resource) {
55
59
  return resource.type && (resource.type === ShippingMethods.TYPE);
56
60
  }
@@ -61,5 +65,4 @@ class ShippingMethods extends ApiResource {
61
65
  return ShippingMethods.TYPE;
62
66
  }
63
67
  }
64
- ShippingMethods.TYPE = 'shipping_methods';
65
68
  export default ShippingMethods;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ShippingWeightTiers extends ApiResource {
3
+ static TYPE = 'shipping_weight_tiers';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: ShippingWeightTiers.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class ShippingWeightTiers extends ApiResource {
31
32
  return ShippingWeightTiers.TYPE;
32
33
  }
33
34
  }
34
- ShippingWeightTiers.TYPE = 'shipping_weight_tiers';
35
35
  export default ShippingWeightTiers;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class ShippingZones extends ApiResource {
3
+ static TYPE = 'shipping_zones';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: ShippingZones.TYPE }, params, options);
5
6
  }
@@ -27,5 +28,4 @@ class ShippingZones extends ApiResource {
27
28
  return ShippingZones.TYPE;
28
29
  }
29
30
  }
30
- ShippingZones.TYPE = 'shipping_zones';
31
31
  export default ShippingZones;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SkuListItems extends ApiResource {
3
+ static TYPE = 'sku_list_items';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SkuListItems.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class SkuListItems extends ApiResource {
31
32
  return SkuListItems.TYPE;
32
33
  }
33
34
  }
34
- SkuListItems.TYPE = 'sku_list_items';
35
35
  export default SkuListItems;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SkuListPromotionRules extends ApiResource {
3
+ static TYPE = 'sku_list_promotion_rules';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SkuListPromotionRules.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class SkuListPromotionRules extends ApiResource {
31
32
  return SkuListPromotionRules.TYPE;
32
33
  }
33
34
  }
34
- SkuListPromotionRules.TYPE = 'sku_list_promotion_rules';
35
35
  export default SkuListPromotionRules;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SkuLists extends ApiResource {
3
+ static TYPE = 'sku_lists';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SkuLists.TYPE }, params, options);
5
6
  }
@@ -43,5 +44,4 @@ class SkuLists extends ApiResource {
43
44
  return SkuLists.TYPE;
44
45
  }
45
46
  }
46
- SkuLists.TYPE = 'sku_lists';
47
47
  export default SkuLists;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SkuOptions extends ApiResource {
3
+ static TYPE = 'sku_options';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SkuOptions.TYPE }, params, options);
5
6
  }
@@ -39,5 +40,4 @@ class SkuOptions extends ApiResource {
39
40
  return SkuOptions.TYPE;
40
41
  }
41
42
  }
42
- SkuOptions.TYPE = 'sku_options';
43
43
  export default SkuOptions;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Skus extends ApiResource {
3
+ static TYPE = 'skus';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: Skus.TYPE }, params, options);
5
6
  }
@@ -59,5 +60,4 @@ class Skus extends ApiResource {
59
60
  return Skus.TYPE;
60
61
  }
61
62
  }
62
- Skus.TYPE = 'skus';
63
63
  export default Skus;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StockItems extends ApiResource {
3
+ static TYPE = 'stock_items';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StockItems.TYPE }, params, options);
5
6
  }
@@ -43,5 +44,4 @@ class StockItems extends ApiResource {
43
44
  return StockItems.TYPE;
44
45
  }
45
46
  }
46
- StockItems.TYPE = 'stock_items';
47
47
  export default StockItems;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StockLineItems extends ApiResource {
3
+ static TYPE = 'stock_line_items';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StockLineItems.TYPE }, params, options);
5
6
  }
@@ -48,5 +49,4 @@ class StockLineItems extends ApiResource {
48
49
  return StockLineItems.TYPE;
49
50
  }
50
51
  }
51
- StockLineItems.TYPE = 'stock_line_items';
52
52
  export default StockLineItems;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StockLocations extends ApiResource {
3
+ static TYPE = 'stock_locations';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StockLocations.TYPE }, params, options);
5
6
  }
@@ -47,5 +48,4 @@ class StockLocations extends ApiResource {
47
48
  return StockLocations.TYPE;
48
49
  }
49
50
  }
50
- StockLocations.TYPE = 'stock_locations';
51
51
  export default StockLocations;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StockReservations extends ApiResource {
3
+ static TYPE = 'stock_reservations';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StockReservations.TYPE }, params, options);
5
6
  }
@@ -42,5 +43,4 @@ class StockReservations extends ApiResource {
42
43
  return StockReservations.TYPE;
43
44
  }
44
45
  }
45
- StockReservations.TYPE = 'stock_reservations';
46
46
  export default StockReservations;
@@ -25,7 +25,7 @@ type LineItemRel = ResourceRel & {
25
25
  };
26
26
  interface StockTransfer extends Resource {
27
27
  readonly type: StockTransferType;
28
- number?: number | null;
28
+ number?: string | null;
29
29
  sku_code?: string | null;
30
30
  status: 'draft' | 'upcoming' | 'on_hold' | 'picking' | 'in_transit' | 'completed' | 'cancelled';
31
31
  quantity: number;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StockTransfers extends ApiResource {
3
+ static TYPE = 'stock_transfers';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StockTransfers.TYPE }, params, options);
5
6
  }
@@ -65,5 +66,4 @@ class StockTransfers extends ApiResource {
65
66
  return StockTransfers.TYPE;
66
67
  }
67
68
  }
68
- StockTransfers.TYPE = 'stock_transfers';
69
69
  export default StockTransfers;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StripeGateways extends ApiResource {
3
+ static TYPE = 'stripe_gateways';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StripeGateways.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class StripeGateways extends ApiResource {
31
32
  return StripeGateways.TYPE;
32
33
  }
33
34
  }
34
- StripeGateways.TYPE = 'stripe_gateways';
35
35
  export default StripeGateways;
@@ -13,7 +13,8 @@ type OrderRel = ResourceRel & {
13
13
  };
14
14
  interface StripePayment extends Resource {
15
15
  readonly type: StripePaymentType;
16
- client_secret: string;
16
+ stripe_id?: string | null;
17
+ client_secret?: string | null;
17
18
  publishable_key?: string | null;
18
19
  options?: Record<string, any> | null;
19
20
  payment_method?: Record<string, any> | null;
@@ -29,6 +30,8 @@ interface StripePayment extends Resource {
29
30
  versions?: Version[] | null;
30
31
  }
31
32
  interface StripePaymentCreate extends ResourceCreate {
33
+ stripe_id?: string | null;
34
+ client_secret?: string | null;
32
35
  options?: Record<string, any> | null;
33
36
  return_url?: string | null;
34
37
  receipt_email?: string | null;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class StripePayments extends ApiResource {
3
+ static TYPE = 'stripe_payments';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: StripePayments.TYPE }, params, options);
5
6
  }
@@ -37,5 +38,4 @@ class StripePayments extends ApiResource {
37
38
  return StripePayments.TYPE;
38
39
  }
39
40
  }
40
- StripePayments.TYPE = 'stripe_payments';
41
41
  export default StripePayments;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class SubscriptionModels extends ApiResource {
3
+ static TYPE = 'subscription_models';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: SubscriptionModels.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class SubscriptionModels extends ApiResource {
31
32
  return SubscriptionModels.TYPE;
32
33
  }
33
34
  }
34
- SubscriptionModels.TYPE = 'subscription_models';
35
35
  export default SubscriptionModels;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Tags extends ApiResource {
3
+ static TYPE = 'tags';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: Tags.TYPE }, params, options);
5
6
  }
@@ -19,5 +20,4 @@ class Tags extends ApiResource {
19
20
  return Tags.TYPE;
20
21
  }
21
22
  }
22
- Tags.TYPE = 'tags';
23
23
  export default Tags;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class TaxCalculators extends ApiResource {
3
+ static TYPE = 'tax_calculators';
3
4
  async markets(taxCalculatorId, params, options) {
4
5
  const _taxCalculatorId = taxCalculatorId.id || taxCalculatorId;
5
6
  return this.resources.fetch({ type: 'markets' }, `tax_calculators/${_taxCalculatorId}/markets`, params, options);
@@ -22,5 +23,4 @@ class TaxCalculators extends ApiResource {
22
23
  return TaxCalculators.TYPE;
23
24
  }
24
25
  }
25
- TaxCalculators.TYPE = 'tax_calculators';
26
26
  export default TaxCalculators;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class TaxCategories extends ApiResource {
3
+ static TYPE = 'tax_categories';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: TaxCategories.TYPE }, params, options);
5
6
  }
@@ -31,5 +32,4 @@ class TaxCategories extends ApiResource {
31
32
  return TaxCategories.TYPE;
32
33
  }
33
34
  }
34
- TaxCategories.TYPE = 'tax_categories';
35
35
  export default TaxCategories;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class TaxRules extends ApiResource {
3
+ static TYPE = 'tax_rules';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: TaxRules.TYPE }, params, options);
5
6
  }
@@ -27,5 +28,4 @@ class TaxRules extends ApiResource {
27
28
  return TaxRules.TYPE;
28
29
  }
29
30
  }
30
- TaxRules.TYPE = 'tax_rules';
31
31
  export default TaxRules;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class TaxjarAccounts extends ApiResource {
3
+ static TYPE = 'taxjar_accounts';
3
4
  async create(resource, params, options) {
4
5
  return this.resources.create({ ...resource, type: TaxjarAccounts.TYPE }, params, options);
5
6
  }
@@ -35,5 +36,4 @@ class TaxjarAccounts extends ApiResource {
35
36
  return TaxjarAccounts.TYPE;
36
37
  }
37
38
  }
38
- TaxjarAccounts.TYPE = 'taxjar_accounts';
39
39
  export default TaxjarAccounts;
@@ -1,5 +1,6 @@
1
1
  import { ApiResource } from '../resource';
2
2
  class Transactions extends ApiResource {
3
+ static TYPE = 'transactions';
3
4
  async order(transactionId, params, options) {
4
5
  const _transactionId = transactionId.id || transactionId;
5
6
  return this.resources.fetch({ type: 'orders' }, `transactions/${_transactionId}/order`, params, options);
@@ -26,5 +27,4 @@ class Transactions extends ApiResource {
26
27
  return Transactions.TYPE;
27
28
  }
28
29
  }
29
- Transactions.TYPE = 'transactions';
30
30
  export default Transactions;