@commercelayer/sdk 5.14.0 → 5.16.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 (69) hide show
  1. package/lib/cjs/api.d.ts +10 -7
  2. package/lib/cjs/api.js +12 -3
  3. package/lib/cjs/commercelayer.d.ts +5 -2
  4. package/lib/cjs/commercelayer.js +4 -1
  5. package/lib/cjs/model.d.ts +3 -0
  6. package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +137 -0
  7. package/lib/cjs/resources/buy_x_pay_y_promotions.js +75 -0
  8. package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -3
  9. package/lib/cjs/resources/coupons.d.ts +3 -0
  10. package/lib/cjs/resources/custom_promotion_rules.d.ts +62 -0
  11. package/lib/cjs/resources/custom_promotion_rules.js +29 -0
  12. package/lib/cjs/resources/external_promotions.d.ts +20 -1
  13. package/lib/cjs/resources/external_promotions.js +10 -0
  14. package/lib/cjs/resources/fixed_amount_promotions.d.ts +20 -1
  15. package/lib/cjs/resources/fixed_amount_promotions.js +10 -0
  16. package/lib/cjs/resources/fixed_price_promotions.d.ts +11 -0
  17. package/lib/cjs/resources/fixed_price_promotions.js +6 -0
  18. package/lib/cjs/resources/free_gift_promotions.d.ts +11 -0
  19. package/lib/cjs/resources/free_gift_promotions.js +6 -0
  20. package/lib/cjs/resources/free_shipping_promotions.d.ts +11 -0
  21. package/lib/cjs/resources/free_shipping_promotions.js +6 -0
  22. package/lib/cjs/resources/line_items.d.ts +1 -0
  23. package/lib/cjs/resources/order_amount_promotion_rules.d.ts +7 -3
  24. package/lib/cjs/resources/orders.d.ts +24 -0
  25. package/lib/cjs/resources/orders.js +20 -0
  26. package/lib/cjs/resources/payment_methods.d.ts +3 -3
  27. package/lib/cjs/resources/payment_options.d.ts +44 -0
  28. package/lib/cjs/resources/payment_options.js +33 -0
  29. package/lib/cjs/resources/percentage_discount_promotions.d.ts +11 -0
  30. package/lib/cjs/resources/percentage_discount_promotions.js +6 -0
  31. package/lib/cjs/resources/promotion_rules.d.ts +2 -1
  32. package/lib/cjs/resources/promotions.d.ts +3 -0
  33. package/lib/cjs/resources/sku_list_promotion_rules.d.ts +7 -3
  34. package/lib/esm/api.d.ts +10 -7
  35. package/lib/esm/api.js +6 -0
  36. package/lib/esm/commercelayer.d.ts +5 -2
  37. package/lib/esm/commercelayer.js +4 -1
  38. package/lib/esm/model.d.ts +3 -0
  39. package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +137 -0
  40. package/lib/esm/resources/buy_x_pay_y_promotions.js +73 -0
  41. package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -3
  42. package/lib/esm/resources/coupons.d.ts +3 -0
  43. package/lib/esm/resources/custom_promotion_rules.d.ts +62 -0
  44. package/lib/esm/resources/custom_promotion_rules.js +27 -0
  45. package/lib/esm/resources/external_promotions.d.ts +20 -1
  46. package/lib/esm/resources/external_promotions.js +10 -0
  47. package/lib/esm/resources/fixed_amount_promotions.d.ts +20 -1
  48. package/lib/esm/resources/fixed_amount_promotions.js +10 -0
  49. package/lib/esm/resources/fixed_price_promotions.d.ts +11 -0
  50. package/lib/esm/resources/fixed_price_promotions.js +6 -0
  51. package/lib/esm/resources/free_gift_promotions.d.ts +11 -0
  52. package/lib/esm/resources/free_gift_promotions.js +6 -0
  53. package/lib/esm/resources/free_shipping_promotions.d.ts +11 -0
  54. package/lib/esm/resources/free_shipping_promotions.js +6 -0
  55. package/lib/esm/resources/line_items.d.ts +1 -0
  56. package/lib/esm/resources/order_amount_promotion_rules.d.ts +7 -3
  57. package/lib/esm/resources/orders.d.ts +24 -0
  58. package/lib/esm/resources/orders.js +20 -0
  59. package/lib/esm/resources/payment_methods.d.ts +3 -3
  60. package/lib/esm/resources/payment_options.d.ts +44 -0
  61. package/lib/esm/resources/payment_options.js +31 -0
  62. package/lib/esm/resources/percentage_discount_promotions.d.ts +11 -0
  63. package/lib/esm/resources/percentage_discount_promotions.js +6 -0
  64. package/lib/esm/resources/promotion_rules.d.ts +2 -1
  65. package/lib/esm/resources/promotions.d.ts +3 -0
  66. package/lib/esm/resources/sku_list_promotion_rules.d.ts +7 -3
  67. package/lib/tsconfig.esm.tsbuildinfo +1 -1
  68. package/lib/tsconfig.tsbuildinfo +1 -1
  69. package/package.json +11 -11
@@ -0,0 +1,62 @@
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 { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
5
+ import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
6
+ import type { BuyXPayYPromotion, BuyXPayYPromotionType } from './buy_x_pay_y_promotions';
7
+ import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
8
+ import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
9
+ import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
10
+ import type { FixedAmountPromotion, FixedAmountPromotionType } from './fixed_amount_promotions';
11
+ import type { Version } from './versions';
12
+ type CustomPromotionRuleType = 'custom_promotion_rules';
13
+ type CustomPromotionRuleRel = ResourceRel & {
14
+ type: CustomPromotionRuleType;
15
+ };
16
+ type PercentageDiscountPromotionRel = ResourceRel & {
17
+ type: PercentageDiscountPromotionType;
18
+ };
19
+ type FreeShippingPromotionRel = ResourceRel & {
20
+ type: FreeShippingPromotionType;
21
+ };
22
+ type BuyXPayYPromotionRel = ResourceRel & {
23
+ type: BuyXPayYPromotionType;
24
+ };
25
+ type FreeGiftPromotionRel = ResourceRel & {
26
+ type: FreeGiftPromotionType;
27
+ };
28
+ type FixedPricePromotionRel = ResourceRel & {
29
+ type: FixedPricePromotionType;
30
+ };
31
+ type ExternalPromotionRel = ResourceRel & {
32
+ type: ExternalPromotionType;
33
+ };
34
+ type FixedAmountPromotionRel = ResourceRel & {
35
+ type: FixedAmountPromotionType;
36
+ };
37
+ interface CustomPromotionRule extends Resource {
38
+ readonly type: CustomPromotionRuleType;
39
+ filters?: Record<string, any> | null;
40
+ promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
41
+ versions?: Version[] | null;
42
+ }
43
+ interface CustomPromotionRuleCreate extends ResourceCreate {
44
+ filters?: Record<string, any> | null;
45
+ promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
46
+ }
47
+ interface CustomPromotionRuleUpdate extends ResourceUpdate {
48
+ filters?: Record<string, any> | null;
49
+ promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
50
+ }
51
+ declare class CustomPromotionRules extends ApiResource<CustomPromotionRule> {
52
+ static readonly TYPE: CustomPromotionRuleType;
53
+ create(resource: CustomPromotionRuleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
54
+ update(resource: CustomPromotionRuleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
55
+ delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
56
+ versions(customPromotionRuleId: string | CustomPromotionRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
57
+ isCustomPromotionRule(resource: any): resource is CustomPromotionRule;
58
+ relationship(id: string | ResourceId | null): CustomPromotionRuleRel;
59
+ type(): CustomPromotionRuleType;
60
+ }
61
+ export default CustomPromotionRules;
62
+ export type { CustomPromotionRule, CustomPromotionRuleCreate, CustomPromotionRuleUpdate, CustomPromotionRuleType };
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const resource_1 = require("../resource");
4
+ class CustomPromotionRules extends resource_1.ApiResource {
5
+ async create(resource, params, options) {
6
+ return this.resources.create({ ...resource, type: CustomPromotionRules.TYPE }, params, options);
7
+ }
8
+ async update(resource, params, options) {
9
+ return this.resources.update({ ...resource, type: CustomPromotionRules.TYPE }, params, options);
10
+ }
11
+ async delete(id, options) {
12
+ await this.resources.delete((typeof id === 'string') ? { id, type: CustomPromotionRules.TYPE } : id, options);
13
+ }
14
+ async versions(customPromotionRuleId, params, options) {
15
+ const _customPromotionRuleId = customPromotionRuleId.id || customPromotionRuleId;
16
+ return this.resources.fetch({ type: 'versions' }, `custom_promotion_rules/${_customPromotionRuleId}/versions`, params, options);
17
+ }
18
+ isCustomPromotionRule(resource) {
19
+ return resource.type && (resource.type === CustomPromotionRules.TYPE);
20
+ }
21
+ relationship(id) {
22
+ return ((id === null) || (typeof id === 'string')) ? { id, type: CustomPromotionRules.TYPE } : { id: id.id, type: CustomPromotionRules.TYPE };
23
+ }
24
+ type() {
25
+ return CustomPromotionRules.TYPE;
26
+ }
27
+ }
28
+ CustomPromotionRules.TYPE = 'custom_promotion_rules';
29
+ exports.default = CustomPromotionRules;
@@ -7,11 +7,12 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
7
7
  import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
8
8
  import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
9
9
  import type { Coupon, CouponType } from './coupons';
10
- import type { SkuList } from './sku_lists';
10
+ import type { SkuList, SkuListType } from './sku_lists';
11
11
  import type { Attachment } from './attachments';
12
12
  import type { Event } from './events';
13
13
  import type { Tag, TagType } from './tags';
14
14
  import type { Version } from './versions';
15
+ import type { Sku } from './skus';
15
16
  type ExternalPromotionType = 'external_promotions';
16
17
  type ExternalPromotionRel = ResourceRel & {
17
18
  type: ExternalPromotionType;
@@ -34,6 +35,9 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
34
35
  type CouponRel = ResourceRel & {
35
36
  type: CouponType;
36
37
  };
38
+ type SkuListRel = ResourceRel & {
39
+ type: SkuListType;
40
+ };
37
41
  type TagRel = ResourceRel & {
38
42
  type: TagType;
39
43
  };
@@ -41,11 +45,14 @@ interface ExternalPromotion extends Resource {
41
45
  readonly type: ExternalPromotionType;
42
46
  name: string;
43
47
  currency_code?: string | null;
48
+ exclusive?: boolean | null;
49
+ priority?: number | null;
44
50
  starts_at: string;
45
51
  expires_at: string;
46
52
  total_usage_limit: number;
47
53
  total_usage_count?: number | null;
48
54
  active?: boolean | null;
55
+ disabled_at?: string | null;
49
56
  promotion_url: string;
50
57
  shared_secret: string;
51
58
  market?: Market | null;
@@ -59,10 +66,13 @@ interface ExternalPromotion extends Resource {
59
66
  events?: Event[] | null;
60
67
  tags?: Tag[] | null;
61
68
  versions?: Version[] | null;
69
+ skus?: Sku[] | null;
62
70
  }
63
71
  interface ExternalPromotionCreate extends ResourceCreate {
64
72
  name: string;
65
73
  currency_code?: string | null;
74
+ exclusive?: boolean | null;
75
+ priority?: number | null;
66
76
  starts_at: string;
67
77
  expires_at: string;
68
78
  total_usage_limit: number;
@@ -73,14 +83,19 @@ interface ExternalPromotionCreate extends ResourceCreate {
73
83
  sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
74
84
  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
75
85
  coupons?: CouponRel[] | null;
86
+ sku_list?: SkuListRel | null;
76
87
  tags?: TagRel[] | null;
77
88
  }
78
89
  interface ExternalPromotionUpdate extends ResourceUpdate {
79
90
  name?: string | null;
80
91
  currency_code?: string | null;
92
+ exclusive?: boolean | null;
93
+ priority?: number | null;
81
94
  starts_at?: string | null;
82
95
  expires_at?: string | null;
83
96
  total_usage_limit?: number | null;
97
+ _disable?: boolean | null;
98
+ _enable?: boolean | null;
84
99
  promotion_url?: string | null;
85
100
  market?: MarketRel | null;
86
101
  promotion_rules?: PromotionRuleRel[] | null;
@@ -88,6 +103,7 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
88
103
  sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
89
104
  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
90
105
  coupons?: CouponRel[] | null;
106
+ sku_list?: SkuListRel | null;
91
107
  tags?: TagRel[] | null;
92
108
  }
93
109
  declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
@@ -105,6 +121,9 @@ declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
105
121
  events(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
106
122
  tags(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
107
123
  versions(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
124
+ skus(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
125
+ _disable(id: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
126
+ _enable(id: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
108
127
  isExternalPromotion(resource: any): resource is ExternalPromotion;
109
128
  relationship(id: string | ResourceId | null): ExternalPromotionRel;
110
129
  type(): ExternalPromotionType;
@@ -51,6 +51,16 @@ class ExternalPromotions extends resource_1.ApiResource {
51
51
  const _externalPromotionId = externalPromotionId.id || externalPromotionId;
52
52
  return this.resources.fetch({ type: 'versions' }, `external_promotions/${_externalPromotionId}/versions`, params, options);
53
53
  }
54
+ async skus(externalPromotionId, params, options) {
55
+ const _externalPromotionId = externalPromotionId.id || externalPromotionId;
56
+ return this.resources.fetch({ type: 'skus' }, `external_promotions/${_externalPromotionId}/skus`, params, options);
57
+ }
58
+ async _disable(id, params, options) {
59
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ExternalPromotions.TYPE, _disable: true }, params, options);
60
+ }
61
+ async _enable(id, params, options) {
62
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ExternalPromotions.TYPE, _enable: true }, params, options);
63
+ }
54
64
  isExternalPromotion(resource) {
55
65
  return resource.type && (resource.type === ExternalPromotions.TYPE);
56
66
  }
@@ -7,11 +7,12 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
7
7
  import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
8
8
  import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
9
9
  import type { Coupon, CouponType } from './coupons';
10
- import type { SkuList } from './sku_lists';
10
+ import type { SkuList, SkuListType } from './sku_lists';
11
11
  import type { Attachment } from './attachments';
12
12
  import type { Event } from './events';
13
13
  import type { Tag, TagType } from './tags';
14
14
  import type { Version } from './versions';
15
+ import type { Sku } from './skus';
15
16
  type FixedAmountPromotionType = 'fixed_amount_promotions';
16
17
  type FixedAmountPromotionRel = ResourceRel & {
17
18
  type: FixedAmountPromotionType;
@@ -34,6 +35,9 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
34
35
  type CouponRel = ResourceRel & {
35
36
  type: CouponType;
36
37
  };
38
+ type SkuListRel = ResourceRel & {
39
+ type: SkuListType;
40
+ };
37
41
  type TagRel = ResourceRel & {
38
42
  type: TagType;
39
43
  };
@@ -41,11 +45,14 @@ interface FixedAmountPromotion extends Resource {
41
45
  readonly type: FixedAmountPromotionType;
42
46
  name: string;
43
47
  currency_code?: string | null;
48
+ exclusive?: boolean | null;
49
+ priority?: number | null;
44
50
  starts_at: string;
45
51
  expires_at: string;
46
52
  total_usage_limit: number;
47
53
  total_usage_count?: number | null;
48
54
  active?: boolean | null;
55
+ disabled_at?: string | null;
49
56
  fixed_amount_cents: number;
50
57
  fixed_amount_float?: number | null;
51
58
  formatted_fixed_amount?: string | null;
@@ -60,10 +67,13 @@ interface FixedAmountPromotion extends Resource {
60
67
  events?: Event[] | null;
61
68
  tags?: Tag[] | null;
62
69
  versions?: Version[] | null;
70
+ skus?: Sku[] | null;
63
71
  }
64
72
  interface FixedAmountPromotionCreate extends ResourceCreate {
65
73
  name: string;
66
74
  currency_code?: string | null;
75
+ exclusive?: boolean | null;
76
+ priority?: number | null;
67
77
  starts_at: string;
68
78
  expires_at: string;
69
79
  total_usage_limit: number;
@@ -74,14 +84,19 @@ interface FixedAmountPromotionCreate extends ResourceCreate {
74
84
  sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
75
85
  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
76
86
  coupons?: CouponRel[] | null;
87
+ sku_list?: SkuListRel | null;
77
88
  tags?: TagRel[] | null;
78
89
  }
79
90
  interface FixedAmountPromotionUpdate extends ResourceUpdate {
80
91
  name?: string | null;
81
92
  currency_code?: string | null;
93
+ exclusive?: boolean | null;
94
+ priority?: number | null;
82
95
  starts_at?: string | null;
83
96
  expires_at?: string | null;
84
97
  total_usage_limit?: number | null;
98
+ _disable?: boolean | null;
99
+ _enable?: boolean | null;
85
100
  fixed_amount_cents?: number | null;
86
101
  market?: MarketRel | null;
87
102
  promotion_rules?: PromotionRuleRel[] | null;
@@ -89,6 +104,7 @@ interface FixedAmountPromotionUpdate extends ResourceUpdate {
89
104
  sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
90
105
  coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
91
106
  coupons?: CouponRel[] | null;
107
+ sku_list?: SkuListRel | null;
92
108
  tags?: TagRel[] | null;
93
109
  }
94
110
  declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
@@ -106,6 +122,9 @@ declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
106
122
  events(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
107
123
  tags(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
108
124
  versions(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
125
+ skus(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
126
+ _disable(id: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
127
+ _enable(id: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
109
128
  isFixedAmountPromotion(resource: any): resource is FixedAmountPromotion;
110
129
  relationship(id: string | ResourceId | null): FixedAmountPromotionRel;
111
130
  type(): FixedAmountPromotionType;
@@ -51,6 +51,16 @@ class FixedAmountPromotions extends resource_1.ApiResource {
51
51
  const _fixedAmountPromotionId = fixedAmountPromotionId.id || fixedAmountPromotionId;
52
52
  return this.resources.fetch({ type: 'versions' }, `fixed_amount_promotions/${_fixedAmountPromotionId}/versions`, params, options);
53
53
  }
54
+ async skus(fixedAmountPromotionId, params, options) {
55
+ const _fixedAmountPromotionId = fixedAmountPromotionId.id || fixedAmountPromotionId;
56
+ return this.resources.fetch({ type: 'skus' }, `fixed_amount_promotions/${_fixedAmountPromotionId}/skus`, params, options);
57
+ }
58
+ async _disable(id, params, options) {
59
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FixedAmountPromotions.TYPE, _disable: true }, params, options);
60
+ }
61
+ async _enable(id, params, options) {
62
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FixedAmountPromotions.TYPE, _enable: true }, params, options);
63
+ }
54
64
  isFixedAmountPromotion(resource) {
55
65
  return resource.type && (resource.type === FixedAmountPromotions.TYPE);
56
66
  }
@@ -45,11 +45,14 @@ interface FixedPricePromotion extends Resource {
45
45
  readonly type: FixedPricePromotionType;
46
46
  name: string;
47
47
  currency_code?: string | null;
48
+ exclusive?: boolean | null;
49
+ priority?: number | null;
48
50
  starts_at: string;
49
51
  expires_at: string;
50
52
  total_usage_limit: number;
51
53
  total_usage_count?: number | null;
52
54
  active?: boolean | null;
55
+ disabled_at?: string | null;
53
56
  fixed_amount_cents: number;
54
57
  fixed_amount_float?: number | null;
55
58
  formatted_fixed_amount?: string | null;
@@ -69,6 +72,8 @@ interface FixedPricePromotion extends Resource {
69
72
  interface FixedPricePromotionCreate extends ResourceCreate {
70
73
  name: string;
71
74
  currency_code?: string | null;
75
+ exclusive?: boolean | null;
76
+ priority?: number | null;
72
77
  starts_at: string;
73
78
  expires_at: string;
74
79
  total_usage_limit: number;
@@ -85,9 +90,13 @@ interface FixedPricePromotionCreate extends ResourceCreate {
85
90
  interface FixedPricePromotionUpdate extends ResourceUpdate {
86
91
  name?: string | null;
87
92
  currency_code?: string | null;
93
+ exclusive?: boolean | null;
94
+ priority?: number | null;
88
95
  starts_at?: string | null;
89
96
  expires_at?: string | null;
90
97
  total_usage_limit?: number | null;
98
+ _disable?: boolean | null;
99
+ _enable?: boolean | null;
91
100
  fixed_amount_cents?: number | null;
92
101
  market?: MarketRel | null;
93
102
  promotion_rules?: PromotionRuleRel[] | null;
@@ -114,6 +123,8 @@ declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
114
123
  tags(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
115
124
  versions(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
116
125
  skus(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
126
+ _disable(id: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedPricePromotion>;
127
+ _enable(id: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedPricePromotion>;
117
128
  isFixedPricePromotion(resource: any): resource is FixedPricePromotion;
118
129
  relationship(id: string | ResourceId | null): FixedPricePromotionRel;
119
130
  type(): FixedPricePromotionType;
@@ -55,6 +55,12 @@ class FixedPricePromotions extends resource_1.ApiResource {
55
55
  const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
56
56
  return this.resources.fetch({ type: 'skus' }, `fixed_price_promotions/${_fixedPricePromotionId}/skus`, params, options);
57
57
  }
58
+ async _disable(id, params, options) {
59
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FixedPricePromotions.TYPE, _disable: true }, params, options);
60
+ }
61
+ async _enable(id, params, options) {
62
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FixedPricePromotions.TYPE, _enable: true }, params, options);
63
+ }
58
64
  isFixedPricePromotion(resource) {
59
65
  return resource.type && (resource.type === FixedPricePromotions.TYPE);
60
66
  }
@@ -45,11 +45,14 @@ interface FreeGiftPromotion extends Resource {
45
45
  readonly type: FreeGiftPromotionType;
46
46
  name: string;
47
47
  currency_code?: string | null;
48
+ exclusive?: boolean | null;
49
+ priority?: number | null;
48
50
  starts_at: string;
49
51
  expires_at: string;
50
52
  total_usage_limit: number;
51
53
  total_usage_count?: number | null;
52
54
  active?: boolean | null;
55
+ disabled_at?: string | null;
53
56
  max_quantity?: number | null;
54
57
  market?: Market | null;
55
58
  promotion_rules?: PromotionRule[] | null;
@@ -67,6 +70,8 @@ interface FreeGiftPromotion extends Resource {
67
70
  interface FreeGiftPromotionCreate extends ResourceCreate {
68
71
  name: string;
69
72
  currency_code?: string | null;
73
+ exclusive?: boolean | null;
74
+ priority?: number | null;
70
75
  starts_at: string;
71
76
  expires_at: string;
72
77
  total_usage_limit: number;
@@ -83,9 +88,13 @@ interface FreeGiftPromotionCreate extends ResourceCreate {
83
88
  interface FreeGiftPromotionUpdate extends ResourceUpdate {
84
89
  name?: string | null;
85
90
  currency_code?: string | null;
91
+ exclusive?: boolean | null;
92
+ priority?: number | null;
86
93
  starts_at?: string | null;
87
94
  expires_at?: string | null;
88
95
  total_usage_limit?: number | null;
96
+ _disable?: boolean | null;
97
+ _enable?: boolean | null;
89
98
  max_quantity?: number | null;
90
99
  market?: MarketRel | null;
91
100
  promotion_rules?: PromotionRuleRel[] | null;
@@ -112,6 +121,8 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
112
121
  tags(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
113
122
  versions(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
114
123
  skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
124
+ _disable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
125
+ _enable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
115
126
  isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
116
127
  relationship(id: string | ResourceId | null): FreeGiftPromotionRel;
117
128
  type(): FreeGiftPromotionType;
@@ -55,6 +55,12 @@ class FreeGiftPromotions extends resource_1.ApiResource {
55
55
  const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
56
56
  return this.resources.fetch({ type: 'skus' }, `free_gift_promotions/${_freeGiftPromotionId}/skus`, params, options);
57
57
  }
58
+ async _disable(id, params, options) {
59
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeGiftPromotions.TYPE, _disable: true }, params, options);
60
+ }
61
+ async _enable(id, params, options) {
62
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeGiftPromotions.TYPE, _enable: true }, params, options);
63
+ }
58
64
  isFreeGiftPromotion(resource) {
59
65
  return resource.type && (resource.type === FreeGiftPromotions.TYPE);
60
66
  }
@@ -41,11 +41,14 @@ interface FreeShippingPromotion extends Resource {
41
41
  readonly type: FreeShippingPromotionType;
42
42
  name: string;
43
43
  currency_code?: string | null;
44
+ exclusive?: boolean | null;
45
+ priority?: number | null;
44
46
  starts_at: string;
45
47
  expires_at: string;
46
48
  total_usage_limit: number;
47
49
  total_usage_count?: number | null;
48
50
  active?: boolean | null;
51
+ disabled_at?: string | null;
49
52
  market?: Market | null;
50
53
  promotion_rules?: PromotionRule[] | null;
51
54
  order_amount_promotion_rule?: OrderAmountPromotionRule | null;
@@ -61,6 +64,8 @@ interface FreeShippingPromotion extends Resource {
61
64
  interface FreeShippingPromotionCreate extends ResourceCreate {
62
65
  name: string;
63
66
  currency_code?: string | null;
67
+ exclusive?: boolean | null;
68
+ priority?: number | null;
64
69
  starts_at: string;
65
70
  expires_at: string;
66
71
  total_usage_limit: number;
@@ -75,9 +80,13 @@ interface FreeShippingPromotionCreate extends ResourceCreate {
75
80
  interface FreeShippingPromotionUpdate extends ResourceUpdate {
76
81
  name?: string | null;
77
82
  currency_code?: string | null;
83
+ exclusive?: boolean | null;
84
+ priority?: number | null;
78
85
  starts_at?: string | null;
79
86
  expires_at?: string | null;
80
87
  total_usage_limit?: number | null;
88
+ _disable?: boolean | null;
89
+ _enable?: boolean | null;
81
90
  market?: MarketRel | null;
82
91
  promotion_rules?: PromotionRuleRel[] | null;
83
92
  order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
@@ -101,6 +110,8 @@ declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion>
101
110
  events(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
102
111
  tags(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
103
112
  versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
113
+ _disable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
114
+ _enable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
104
115
  isFreeShippingPromotion(resource: any): resource is FreeShippingPromotion;
105
116
  relationship(id: string | ResourceId | null): FreeShippingPromotionRel;
106
117
  type(): FreeShippingPromotionType;
@@ -51,6 +51,12 @@ class FreeShippingPromotions extends resource_1.ApiResource {
51
51
  const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
52
52
  return this.resources.fetch({ type: 'versions' }, `free_shipping_promotions/${_freeShippingPromotionId}/versions`, params, options);
53
53
  }
54
+ async _disable(id, params, options) {
55
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _disable: true }, params, options);
56
+ }
57
+ async _enable(id, params, options) {
58
+ return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _enable: true }, params, options);
59
+ }
54
60
  isFreeShippingPromotion(resource) {
55
61
  return resource.type && (resource.type === FreeShippingPromotions.TYPE);
56
62
  }
@@ -86,6 +86,7 @@ interface LineItem extends Resource {
86
86
  tax_breakdown?: Record<string, any> | null;
87
87
  item_type?: 'skus' | 'bundles' | 'shipments' | 'payment_methods' | 'adjustments' | 'gift_cards' | 'percentage_discount_promotions' | 'free_shipping_promotions' | 'free_gift_promotions' | 'fixed_price_promotions' | 'external_promotions' | 'fixed_amount_promotions' | null;
88
88
  frequency?: string | null;
89
+ coupon_code?: string | null;
89
90
  order?: Order | null;
90
91
  item?: Adjustment | Bundle | ExternalPromotion | FixedAmountPromotion | FreeShippingPromotion | GiftCard | PaymentMethod | PercentageDiscountPromotion | Shipment | Sku | null;
91
92
  sku?: Sku | null;
@@ -3,6 +3,7 @@ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesCon
3
3
  import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
4
  import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
5
5
  import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
6
+ import type { BuyXPayYPromotion, BuyXPayYPromotionType } from './buy_x_pay_y_promotions';
6
7
  import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
7
8
  import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
8
9
  import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
@@ -18,6 +19,9 @@ type PercentageDiscountPromotionRel = ResourceRel & {
18
19
  type FreeShippingPromotionRel = ResourceRel & {
19
20
  type: FreeShippingPromotionType;
20
21
  };
22
+ type BuyXPayYPromotionRel = ResourceRel & {
23
+ type: BuyXPayYPromotionType;
24
+ };
21
25
  type FreeGiftPromotionRel = ResourceRel & {
22
26
  type: FreeGiftPromotionType;
23
27
  };
@@ -36,18 +40,18 @@ interface OrderAmountPromotionRule extends Resource {
36
40
  order_amount_float?: number | null;
37
41
  formatted_order_amount?: string | null;
38
42
  use_subtotal?: boolean | null;
39
- promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
43
+ promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
40
44
  versions?: Version[] | null;
41
45
  }
42
46
  interface OrderAmountPromotionRuleCreate extends ResourceCreate {
43
47
  order_amount_cents?: number | null;
44
48
  use_subtotal?: boolean | null;
45
- promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
49
+ promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
46
50
  }
47
51
  interface OrderAmountPromotionRuleUpdate extends ResourceUpdate {
48
52
  order_amount_cents?: number | null;
49
53
  use_subtotal?: boolean | null;
50
- promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
54
+ promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
51
55
  }
52
56
  declare class OrderAmountPromotionRules extends ApiResource<OrderAmountPromotionRule> {
53
57
  static readonly TYPE: OrderAmountPromotionRuleType;
@@ -19,7 +19,12 @@ import type { SatispayPayment, SatispayPaymentType } from './satispay_payments';
19
19
  import type { StripePayment, StripePaymentType } from './stripe_payments';
20
20
  import type { WireTransfer, WireTransferType } from './wire_transfers';
21
21
  import type { LineItem } from './line_items';
22
+ import type { LineItemOption } from './line_item_options';
23
+ import type { StockReservation } from './stock_reservations';
24
+ import type { StockLineItem } from './stock_line_items';
25
+ import type { StockTransfer } from './stock_transfers';
22
26
  import type { Shipment } from './shipments';
27
+ import type { PaymentOption } from './payment_options';
23
28
  import type { Authorization } from './authorizations';
24
29
  import type { Capture } from './captures';
25
30
  import type { Void } from './voids';
@@ -97,6 +102,9 @@ interface Order extends Resource {
97
102
  tax_included?: boolean | null;
98
103
  tax_rate?: number | null;
99
104
  freight_taxable?: boolean | null;
105
+ payment_method_taxable?: boolean | null;
106
+ adjustment_taxable?: boolean | null;
107
+ gift_card_taxable?: boolean | null;
100
108
  requires_billing_info?: boolean | null;
101
109
  country_code?: string | null;
102
110
  shipping_country_code_lock?: string | null;
@@ -197,7 +205,12 @@ interface Order extends Resource {
197
205
  payment_method?: PaymentMethod | null;
198
206
  payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
199
207
  line_items?: LineItem[] | null;
208
+ line_item_options?: LineItemOption[] | null;
209
+ stock_reservations?: StockReservation[] | null;
210
+ stock_line_items?: StockLineItem[] | null;
211
+ stock_transfers?: StockTransfer[] | null;
200
212
  shipments?: Shipment[] | null;
213
+ payment_options?: PaymentOption[] | null;
201
214
  transactions?: Array<Authorization | Capture | Void | Refund> | null;
202
215
  authorizations?: Authorization[] | null;
203
216
  captures?: Capture[] | null;
@@ -220,6 +233,9 @@ interface OrderCreate extends ResourceCreate {
220
233
  customer_password?: string | null;
221
234
  language_code?: string | null;
222
235
  freight_taxable?: boolean | null;
236
+ payment_method_taxable?: boolean | null;
237
+ adjustment_taxable?: boolean | null;
238
+ gift_card_taxable?: boolean | null;
223
239
  shipping_country_code_lock?: string | null;
224
240
  coupon_code?: string | null;
225
241
  gift_card_code?: string | null;
@@ -242,6 +258,9 @@ interface OrderUpdate extends ResourceUpdate {
242
258
  customer_password?: string | null;
243
259
  language_code?: string | null;
244
260
  freight_taxable?: boolean | null;
261
+ payment_method_taxable?: boolean | null;
262
+ adjustment_taxable?: boolean | null;
263
+ gift_card_taxable?: boolean | null;
245
264
  shipping_country_code_lock?: string | null;
246
265
  coupon_code?: string | null;
247
266
  gift_card_code?: string | null;
@@ -299,7 +318,12 @@ declare class Orders extends ApiResource<Order> {
299
318
  available_free_bundles(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
300
319
  payment_method(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
301
320
  line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
321
+ line_item_options(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItemOption>>;
322
+ stock_reservations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
323
+ stock_line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
324
+ stock_transfers(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
302
325
  shipments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
326
+ payment_options(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentOption>>;
303
327
  authorizations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Authorization>>;
304
328
  captures(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
305
329
  voids(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
@@ -51,10 +51,30 @@ class Orders extends resource_1.ApiResource {
51
51
  const _orderId = orderId.id || orderId;
52
52
  return this.resources.fetch({ type: 'line_items' }, `orders/${_orderId}/line_items`, params, options);
53
53
  }
54
+ async line_item_options(orderId, params, options) {
55
+ const _orderId = orderId.id || orderId;
56
+ return this.resources.fetch({ type: 'line_item_options' }, `orders/${_orderId}/line_item_options`, params, options);
57
+ }
58
+ async stock_reservations(orderId, params, options) {
59
+ const _orderId = orderId.id || orderId;
60
+ return this.resources.fetch({ type: 'stock_reservations' }, `orders/${_orderId}/stock_reservations`, params, options);
61
+ }
62
+ async stock_line_items(orderId, params, options) {
63
+ const _orderId = orderId.id || orderId;
64
+ return this.resources.fetch({ type: 'stock_line_items' }, `orders/${_orderId}/stock_line_items`, params, options);
65
+ }
66
+ async stock_transfers(orderId, params, options) {
67
+ const _orderId = orderId.id || orderId;
68
+ return this.resources.fetch({ type: 'stock_transfers' }, `orders/${_orderId}/stock_transfers`, params, options);
69
+ }
54
70
  async shipments(orderId, params, options) {
55
71
  const _orderId = orderId.id || orderId;
56
72
  return this.resources.fetch({ type: 'shipments' }, `orders/${_orderId}/shipments`, params, options);
57
73
  }
74
+ async payment_options(orderId, params, options) {
75
+ const _orderId = orderId.id || orderId;
76
+ return this.resources.fetch({ type: 'payment_options' }, `orders/${_orderId}/payment_options`, params, options);
77
+ }
58
78
  async authorizations(orderId, params, options) {
59
79
  const _orderId = orderId.id || orderId;
60
80
  return this.resources.fetch({ type: 'authorizations' }, `orders/${_orderId}/authorizations`, params, options);