@voucherify/sdk 2.9.2 → 2.9.4

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 (75) hide show
  1. package/dist/ApiLimitsHandler.d.ts +13 -10
  2. package/dist/AsyncActions.d.ts +17 -15
  3. package/dist/Balance.d.ts +15 -12
  4. package/dist/Campaigns.d.ts +66 -58
  5. package/dist/Categories.d.ts +29 -26
  6. package/dist/ClientSide.d.ts +77 -53
  7. package/dist/Consents.d.ts +13 -10
  8. package/dist/Customers.d.ts +75 -72
  9. package/dist/Distributions.d.ts +29 -22
  10. package/dist/Events.d.ts +15 -10
  11. package/dist/Exports.d.ts +25 -22
  12. package/dist/Loyalties.d.ts +171 -159
  13. package/dist/MetadataSchemas.d.ts +17 -14
  14. package/dist/Orders.d.ts +32 -27
  15. package/dist/ProductCollections.d.ts +30 -26
  16. package/dist/Products.d.ts +66 -63
  17. package/dist/PromotionTiers.d.ts +43 -34
  18. package/dist/Promotions.d.ts +30 -18
  19. package/dist/PromotionsStacks.d.ts +34 -30
  20. package/dist/Qualifications.d.ts +24 -10
  21. package/dist/Redemptions.d.ts +53 -35
  22. package/dist/RequestController.d.ts +31 -29
  23. package/dist/Rewards.d.ts +46 -43
  24. package/dist/Segments.d.ts +25 -22
  25. package/dist/ValidationRules.d.ts +47 -43
  26. package/dist/Validations.d.ts +39 -17
  27. package/dist/VoucherifyClientSide.d.ts +112 -86
  28. package/dist/VoucherifyError.d.ts +23 -20
  29. package/dist/VoucherifyServerSide.d.ts +170 -131
  30. package/dist/Vouchers.d.ts +84 -78
  31. package/dist/helpers.d.ts +20 -18
  32. package/dist/index.d.ts +63 -25
  33. package/dist/types/ApplicableTo.d.ts +32 -30
  34. package/dist/types/AsyncActions.d.ts +23 -21
  35. package/dist/types/Balance.d.ts +18 -16
  36. package/dist/types/Campaigns.d.ts +124 -120
  37. package/dist/types/Categories.d.ts +40 -38
  38. package/dist/types/ClientSide.d.ts +145 -134
  39. package/dist/types/Consents.d.ts +34 -33
  40. package/dist/types/Customers.d.ts +363 -361
  41. package/dist/types/DiscountVoucher.d.ts +94 -93
  42. package/dist/types/Distributions.d.ts +148 -144
  43. package/dist/types/Events.d.ts +21 -17
  44. package/dist/types/Exports.d.ts +151 -149
  45. package/dist/types/Gift.d.ts +5 -3
  46. package/dist/types/Loyalties.d.ts +1061 -1057
  47. package/dist/types/MetadataSchemas.d.ts +34 -33
  48. package/dist/types/Orders.d.ts +199 -195
  49. package/dist/types/ProductCollections.d.ts +99 -96
  50. package/dist/types/Products.d.ts +108 -106
  51. package/dist/types/PromotionTiers.d.ts +131 -127
  52. package/dist/types/Promotions.d.ts +113 -108
  53. package/dist/types/PromotionsStacks.d.ts +74 -71
  54. package/dist/types/Qualifications.d.ts +92 -86
  55. package/dist/types/Redemptions.d.ts +215 -205
  56. package/dist/types/Rewards.d.ts +220 -219
  57. package/dist/types/Segments.d.ts +34 -32
  58. package/dist/types/Stackable.d.ts +106 -101
  59. package/dist/types/UtilityTypes.d.ts +5 -3
  60. package/dist/types/ValidateSession.d.ts +19 -17
  61. package/dist/types/ValidationError.d.ts +9 -7
  62. package/dist/types/ValidationRules.d.ts +96 -93
  63. package/dist/types/Validations.d.ts +109 -98
  64. package/dist/types/Vouchers.d.ts +452 -364
  65. package/dist/types/index.d.ts +27 -25
  66. package/dist/voucherifysdk.cjs +2023 -0
  67. package/dist/voucherifysdk.cjs.map +1 -0
  68. package/dist/voucherifysdk.esm.js +981 -1256
  69. package/dist/voucherifysdk.esm.js.map +1 -1
  70. package/package.json +13 -9
  71. package/CHANGELOG.md +0 -663
  72. package/dist/voucherifysdk.umd.development.js +0 -2270
  73. package/dist/voucherifysdk.umd.development.js.map +0 -1
  74. package/dist/voucherifysdk.umd.production.min.js +0 -2
  75. package/dist/voucherifysdk.umd.production.min.js.map +0 -1
@@ -1,33 +1,34 @@
1
- interface MetadataSchemaProperty {
2
- type: string;
3
- array: boolean;
4
- deleted?: boolean;
5
- optional: boolean;
6
- objectType?: string;
7
- eq?: (string | number)[];
8
- ne?: (string | number)[];
9
- lt?: number;
10
- lte?: number;
11
- gt?: number;
12
- gte?: number;
13
- minLength?: number;
14
- maxLength?: number;
15
- exactLength?: number;
16
- }
17
- export interface MetadataSchema {
18
- id: string;
19
- related_object: string;
20
- properties: Record<string, MetadataSchemaProperty>;
21
- allow_defined_only?: boolean;
22
- created_at: string;
23
- updated_at?: string;
24
- object: 'metadata_schema';
25
- }
26
- export interface MetadataSchemasListResponse {
27
- object: 'list';
28
- total: number;
29
- data_ref: 'schemas';
30
- schemas: MetadataSchema[];
31
- }
32
- export declare type MetadataSchemasGetResponse = MetadataSchema;
33
- export {};
1
+ interface MetadataSchemaProperty {
2
+ type: string;
3
+ array: boolean;
4
+ deleted?: boolean;
5
+ optional: boolean;
6
+ objectType?: string;
7
+ eq?: (string | number)[];
8
+ ne?: (string | number)[];
9
+ lt?: number;
10
+ lte?: number;
11
+ gt?: number;
12
+ gte?: number;
13
+ minLength?: number;
14
+ maxLength?: number;
15
+ exactLength?: number;
16
+ }
17
+ interface MetadataSchema {
18
+ id: string;
19
+ related_object: string;
20
+ properties: Record<string, MetadataSchemaProperty>;
21
+ allow_defined_only?: boolean;
22
+ created_at: string;
23
+ updated_at?: string;
24
+ object: 'metadata_schema';
25
+ }
26
+ interface MetadataSchemasListResponse {
27
+ object: 'list';
28
+ total: number;
29
+ data_ref: 'schemas';
30
+ schemas: MetadataSchema[];
31
+ }
32
+ type MetadataSchemasGetResponse = MetadataSchema;
33
+
34
+ export type { MetadataSchema, MetadataSchemasGetResponse, MetadataSchemasListResponse };
@@ -1,195 +1,199 @@
1
- import { Customer, CustomerId, CustomerRequest, CustomerWithSummaryLoyaltyReferrals, Referrer, ReferrerId, ReferrerWithSummaryLoyaltyReferrals } from './Customers';
2
- export interface OrdersItem {
3
- sku_id?: string;
4
- product_id?: string;
5
- related_object?: 'product' | 'sku';
6
- source_id?: string;
7
- discount_quantity?: number;
8
- initial_quantity?: number;
9
- quantity?: number;
10
- price?: number;
11
- amount?: number;
12
- discount_amount?: number;
13
- initial_amount?: number;
14
- applied_discount_amount?: number;
15
- subtotal_amount?: number;
16
- product?: {
17
- id?: string;
18
- source_id?: string;
19
- override?: boolean;
20
- name?: string;
21
- metadata?: Record<string, any>;
22
- price?: number;
23
- };
24
- sku?: {
25
- id?: string;
26
- source_id?: string;
27
- override?: boolean;
28
- sku?: string;
29
- price?: number;
30
- };
31
- object?: 'order_item';
32
- metadata?: Record<string, any>;
33
- }
34
- export interface OrdersCreate {
35
- source_id?: string;
36
- status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
37
- customer?: CustomerRequest;
38
- amount?: number;
39
- discount_amount?: number;
40
- items?: OrdersItem[];
41
- metadata?: Record<string, any>;
42
- }
43
- export interface OrdersCreateResponse {
44
- id: string;
45
- source_id?: string;
46
- created_at: string;
47
- updated_at?: string;
48
- status?: 'CREATED' | 'PAID' | 'PROCESSING' | 'CANCELED' | 'FULFILLED';
49
- amount?: number;
50
- initial_amount?: number;
51
- discount_amount?: number;
52
- items_discount_amount?: number;
53
- total_discount_amount?: number;
54
- applied_discount_amount?: number;
55
- items_applied_discount_amount?: number;
56
- total_amount?: number;
57
- total_applied_discount_amount?: number;
58
- items?: OrdersItem[];
59
- metadata?: Record<string, any>;
60
- customer?: CustomerRequest;
61
- object: 'order';
62
- }
63
- export declare type OrdersGetResponse = OrdersCreateResponse;
64
- export interface OrdersUpdate {
65
- id: string;
66
- source_id?: string;
67
- status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
68
- items?: OrdersItem[];
69
- amount?: number;
70
- discount_amount?: number;
71
- metadata?: Record<string, any>;
72
- customer?: {
73
- id: string;
74
- };
75
- }
76
- export declare type OrdersUpdateResponse = OrdersGetResponse;
77
- export interface OrdersListParams {
78
- limit?: number;
79
- page?: number;
80
- }
81
- export interface OrdersListResponse {
82
- object: 'list';
83
- total: number;
84
- data_ref: 'orders';
85
- orders: OrdersGetResponse[];
86
- }
87
- export declare type Order = {
88
- id?: string;
89
- source_id?: string;
90
- status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
91
- amount?: number;
92
- discount_amount?: number;
93
- initial_amount?: number;
94
- items?: OrderItem[];
95
- customer?: Customer;
96
- customer_id?: string;
97
- referrer?: Referrer;
98
- referrer_id?: string;
99
- metadata?: Record<string, any>;
100
- };
101
- export declare type OrderItem = {
102
- sku_id?: string;
103
- product_id?: string;
104
- related_object?: 'product' | 'sku';
105
- source_id?: string;
106
- quantity?: number;
107
- discount_quantity?: number;
108
- initial_quantity?: number;
109
- amount?: number;
110
- discount_amount?: number;
111
- initial_amount?: number;
112
- price?: number;
113
- product?: {
114
- id?: string;
115
- source_id?: string;
116
- override?: boolean;
117
- name?: string;
118
- metadata?: Record<string, any>;
119
- price?: number;
120
- };
121
- sku?: {
122
- id?: string;
123
- source_id?: string;
124
- override?: boolean;
125
- sku?: string;
126
- price?: number;
127
- };
128
- metadata?: Record<string, any>;
129
- };
130
- export declare type OrderCalculated = {
131
- id?: string;
132
- source_id?: string | null;
133
- created_at?: string;
134
- updated_at?: string | null;
135
- status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
136
- amount?: number;
137
- initial_amount?: number;
138
- discount_amount?: number;
139
- items_discount_amount?: number;
140
- total_discount_amount?: number;
141
- total_amount?: number;
142
- applied_discount_amount?: number;
143
- items_applied_discount_amount?: number;
144
- total_applied_discount_amount?: number;
145
- items?: OrderItemCalculated[];
146
- metadata?: Record<string, unknown>;
147
- customer?: CustomerId | CustomerWithSummaryLoyaltyReferrals;
148
- customer_id: string | null;
149
- referrer?: ReferrerId | ReferrerWithSummaryLoyaltyReferrals;
150
- referrer_id: string | null;
151
- object: 'order';
152
- redemptions?: Record<string, OrderRedemptions>;
153
- };
154
- export declare type OrderRedemptions = {
155
- date?: string;
156
- rollback_id?: string;
157
- rollback_date?: string;
158
- related_object_type?: string;
159
- related_object_id?: string;
160
- related_object_parent_id?: string;
161
- stacked?: string[];
162
- rollback_stacked?: string[];
163
- };
164
- export declare type OrderItemCalculated = {
165
- sku_id?: string;
166
- product_id?: string;
167
- related_object?: 'product' | 'sku';
168
- source_id?: string;
169
- quantity?: number;
170
- discount_quantity?: number;
171
- initial_quantity?: number;
172
- amount?: number;
173
- discount_amount?: number;
174
- initial_amount?: number;
175
- total_applied_discount_amount?: number;
176
- price?: number;
177
- subtotal_amount?: number;
178
- product?: {
179
- id?: string;
180
- source_id?: string;
181
- override?: boolean;
182
- name?: string;
183
- metadata?: Record<string, any>;
184
- price?: number;
185
- };
186
- sku?: {
187
- id?: string;
188
- source_id?: string;
189
- override?: boolean;
190
- sku?: string;
191
- price?: number;
192
- };
193
- object: 'order_item';
194
- metadata?: Record<string, any>;
195
- };
1
+ import { CustomerRequest, Customer, Referrer, CustomerId, CustomerWithSummaryLoyaltyReferrals, ReferrerId, ReferrerWithSummaryLoyaltyReferrals } from './Customers.js';
2
+ import './DiscountVoucher.js';
3
+
4
+ interface OrdersItem {
5
+ sku_id?: string;
6
+ product_id?: string;
7
+ related_object?: 'product' | 'sku';
8
+ source_id?: string;
9
+ discount_quantity?: number;
10
+ initial_quantity?: number;
11
+ quantity?: number;
12
+ price?: number;
13
+ amount?: number;
14
+ discount_amount?: number;
15
+ initial_amount?: number;
16
+ applied_discount_amount?: number;
17
+ subtotal_amount?: number;
18
+ product?: {
19
+ id?: string;
20
+ source_id?: string;
21
+ override?: boolean;
22
+ name?: string;
23
+ metadata?: Record<string, any>;
24
+ price?: number;
25
+ };
26
+ sku?: {
27
+ id?: string;
28
+ source_id?: string;
29
+ override?: boolean;
30
+ sku?: string;
31
+ price?: number;
32
+ };
33
+ object?: 'order_item';
34
+ metadata?: Record<string, any>;
35
+ }
36
+ interface OrdersCreate {
37
+ source_id?: string;
38
+ status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
39
+ customer?: CustomerRequest;
40
+ amount?: number;
41
+ discount_amount?: number;
42
+ items?: OrdersItem[];
43
+ metadata?: Record<string, any>;
44
+ }
45
+ interface OrdersCreateResponse {
46
+ id: string;
47
+ source_id?: string;
48
+ created_at: string;
49
+ updated_at?: string;
50
+ status?: 'CREATED' | 'PAID' | 'PROCESSING' | 'CANCELED' | 'FULFILLED';
51
+ amount?: number;
52
+ initial_amount?: number;
53
+ discount_amount?: number;
54
+ items_discount_amount?: number;
55
+ total_discount_amount?: number;
56
+ applied_discount_amount?: number;
57
+ items_applied_discount_amount?: number;
58
+ total_amount?: number;
59
+ total_applied_discount_amount?: number;
60
+ items?: OrdersItem[];
61
+ metadata?: Record<string, any>;
62
+ customer?: CustomerRequest;
63
+ object: 'order';
64
+ }
65
+ type OrdersGetResponse = OrdersCreateResponse;
66
+ interface OrdersUpdate {
67
+ id: string;
68
+ source_id?: string;
69
+ status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
70
+ items?: OrdersItem[];
71
+ amount?: number;
72
+ discount_amount?: number;
73
+ metadata?: Record<string, any>;
74
+ customer?: {
75
+ id: string;
76
+ };
77
+ }
78
+ type OrdersUpdateResponse = OrdersGetResponse;
79
+ interface OrdersListParams {
80
+ limit?: number;
81
+ page?: number;
82
+ }
83
+ interface OrdersListResponse {
84
+ object: 'list';
85
+ total: number;
86
+ data_ref: 'orders';
87
+ orders: OrdersGetResponse[];
88
+ }
89
+ type Order = {
90
+ id?: string;
91
+ source_id?: string;
92
+ status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
93
+ amount?: number;
94
+ discount_amount?: number;
95
+ initial_amount?: number;
96
+ items?: OrderItem[];
97
+ customer?: Customer;
98
+ customer_id?: string;
99
+ referrer?: Referrer;
100
+ referrer_id?: string;
101
+ metadata?: Record<string, any>;
102
+ };
103
+ type OrderItem = {
104
+ sku_id?: string;
105
+ product_id?: string;
106
+ related_object?: 'product' | 'sku';
107
+ source_id?: string;
108
+ quantity?: number;
109
+ discount_quantity?: number;
110
+ initial_quantity?: number;
111
+ amount?: number;
112
+ discount_amount?: number;
113
+ initial_amount?: number;
114
+ price?: number;
115
+ product?: {
116
+ id?: string;
117
+ source_id?: string;
118
+ override?: boolean;
119
+ name?: string;
120
+ metadata?: Record<string, any>;
121
+ price?: number;
122
+ };
123
+ sku?: {
124
+ id?: string;
125
+ source_id?: string;
126
+ override?: boolean;
127
+ sku?: string;
128
+ price?: number;
129
+ };
130
+ metadata?: Record<string, any>;
131
+ };
132
+ type OrderCalculated = {
133
+ id?: string;
134
+ source_id?: string | null;
135
+ created_at?: string;
136
+ updated_at?: string | null;
137
+ status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
138
+ amount?: number;
139
+ initial_amount?: number;
140
+ discount_amount?: number;
141
+ items_discount_amount?: number;
142
+ total_discount_amount?: number;
143
+ total_amount?: number;
144
+ applied_discount_amount?: number;
145
+ items_applied_discount_amount?: number;
146
+ total_applied_discount_amount?: number;
147
+ items?: OrderItemCalculated[];
148
+ metadata?: Record<string, unknown>;
149
+ customer?: CustomerId | CustomerWithSummaryLoyaltyReferrals;
150
+ customer_id: string | null;
151
+ referrer?: ReferrerId | ReferrerWithSummaryLoyaltyReferrals;
152
+ referrer_id: string | null;
153
+ object: 'order';
154
+ redemptions?: Record<string, OrderRedemptions>;
155
+ };
156
+ type OrderRedemptions = {
157
+ date?: string;
158
+ rollback_id?: string;
159
+ rollback_date?: string;
160
+ related_object_type?: string;
161
+ related_object_id?: string;
162
+ related_object_parent_id?: string;
163
+ stacked?: string[];
164
+ rollback_stacked?: string[];
165
+ };
166
+ type OrderItemCalculated = {
167
+ sku_id?: string;
168
+ product_id?: string;
169
+ related_object?: 'product' | 'sku';
170
+ source_id?: string;
171
+ quantity?: number;
172
+ discount_quantity?: number;
173
+ initial_quantity?: number;
174
+ amount?: number;
175
+ discount_amount?: number;
176
+ initial_amount?: number;
177
+ total_applied_discount_amount?: number;
178
+ price?: number;
179
+ subtotal_amount?: number;
180
+ product?: {
181
+ id?: string;
182
+ source_id?: string;
183
+ override?: boolean;
184
+ name?: string;
185
+ metadata?: Record<string, any>;
186
+ price?: number;
187
+ };
188
+ sku?: {
189
+ id?: string;
190
+ source_id?: string;
191
+ override?: boolean;
192
+ sku?: string;
193
+ price?: number;
194
+ };
195
+ object: 'order_item';
196
+ metadata?: Record<string, any>;
197
+ };
198
+
199
+ export type { Order, OrderCalculated, OrderItem, OrderItemCalculated, OrderRedemptions, OrdersCreate, OrdersCreateResponse, OrdersGetResponse, OrdersItem, OrdersListParams, OrdersListResponse, OrdersUpdate, OrdersUpdateResponse };