@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.
- package/dist/ApiLimitsHandler.d.ts +13 -10
- package/dist/AsyncActions.d.ts +17 -15
- package/dist/Balance.d.ts +15 -12
- package/dist/Campaigns.d.ts +66 -58
- package/dist/Categories.d.ts +29 -26
- package/dist/ClientSide.d.ts +77 -53
- package/dist/Consents.d.ts +13 -10
- package/dist/Customers.d.ts +75 -72
- package/dist/Distributions.d.ts +29 -22
- package/dist/Events.d.ts +15 -10
- package/dist/Exports.d.ts +25 -22
- package/dist/Loyalties.d.ts +171 -159
- package/dist/MetadataSchemas.d.ts +17 -14
- package/dist/Orders.d.ts +32 -27
- package/dist/ProductCollections.d.ts +30 -26
- package/dist/Products.d.ts +66 -63
- package/dist/PromotionTiers.d.ts +43 -34
- package/dist/Promotions.d.ts +30 -18
- package/dist/PromotionsStacks.d.ts +34 -30
- package/dist/Qualifications.d.ts +24 -10
- package/dist/Redemptions.d.ts +53 -35
- package/dist/RequestController.d.ts +31 -29
- package/dist/Rewards.d.ts +46 -43
- package/dist/Segments.d.ts +25 -22
- package/dist/ValidationRules.d.ts +47 -43
- package/dist/Validations.d.ts +39 -17
- package/dist/VoucherifyClientSide.d.ts +112 -86
- package/dist/VoucherifyError.d.ts +23 -20
- package/dist/VoucherifyServerSide.d.ts +170 -131
- package/dist/Vouchers.d.ts +84 -78
- package/dist/helpers.d.ts +20 -18
- package/dist/index.d.ts +63 -25
- package/dist/types/ApplicableTo.d.ts +32 -30
- package/dist/types/AsyncActions.d.ts +23 -21
- package/dist/types/Balance.d.ts +18 -16
- package/dist/types/Campaigns.d.ts +124 -120
- package/dist/types/Categories.d.ts +40 -38
- package/dist/types/ClientSide.d.ts +145 -134
- package/dist/types/Consents.d.ts +34 -33
- package/dist/types/Customers.d.ts +363 -361
- package/dist/types/DiscountVoucher.d.ts +94 -93
- package/dist/types/Distributions.d.ts +148 -144
- package/dist/types/Events.d.ts +21 -17
- package/dist/types/Exports.d.ts +151 -149
- package/dist/types/Gift.d.ts +5 -3
- package/dist/types/Loyalties.d.ts +1061 -1057
- package/dist/types/MetadataSchemas.d.ts +34 -33
- package/dist/types/Orders.d.ts +199 -195
- package/dist/types/ProductCollections.d.ts +99 -96
- package/dist/types/Products.d.ts +108 -106
- package/dist/types/PromotionTiers.d.ts +131 -127
- package/dist/types/Promotions.d.ts +113 -108
- package/dist/types/PromotionsStacks.d.ts +74 -71
- package/dist/types/Qualifications.d.ts +92 -86
- package/dist/types/Redemptions.d.ts +215 -205
- package/dist/types/Rewards.d.ts +220 -219
- package/dist/types/Segments.d.ts +34 -32
- package/dist/types/Stackable.d.ts +106 -101
- package/dist/types/UtilityTypes.d.ts +5 -3
- package/dist/types/ValidateSession.d.ts +19 -17
- package/dist/types/ValidationError.d.ts +9 -7
- package/dist/types/ValidationRules.d.ts +96 -93
- package/dist/types/Validations.d.ts +109 -98
- package/dist/types/Vouchers.d.ts +452 -364
- package/dist/types/index.d.ts +27 -25
- package/dist/voucherifysdk.cjs +2023 -0
- package/dist/voucherifysdk.cjs.map +1 -0
- package/dist/voucherifysdk.esm.js +981 -1256
- package/dist/voucherifysdk.esm.js.map +1 -1
- package/package.json +13 -9
- package/CHANGELOG.md +0 -663
- package/dist/voucherifysdk.umd.development.js +0 -2270
- package/dist/voucherifysdk.umd.development.js.map +0 -1
- package/dist/voucherifysdk.umd.production.min.js +0 -2
- 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
|
-
|
|
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
|
-
|
|
27
|
-
object: 'list';
|
|
28
|
-
total: number;
|
|
29
|
-
data_ref: 'schemas';
|
|
30
|
-
schemas: MetadataSchema[];
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
|
|
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 };
|
package/dist/types/Orders.d.ts
CHANGED
|
@@ -1,195 +1,199 @@
|
|
|
1
|
-
import { Customer,
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
};
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
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 };
|