@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
package/dist/types/Rewards.d.ts
CHANGED
|
@@ -1,219 +1,220 @@
|
|
|
1
|
-
|
|
2
|
-
page?: number;
|
|
3
|
-
limit?: number;
|
|
4
|
-
}
|
|
5
|
-
|
|
6
|
-
id: string;
|
|
7
|
-
name?: string;
|
|
8
|
-
stock?: number;
|
|
9
|
-
redeemed?: number;
|
|
10
|
-
attributes?: {
|
|
11
|
-
image_url?: string;
|
|
12
|
-
description?: string;
|
|
13
|
-
};
|
|
14
|
-
created_at: string;
|
|
15
|
-
updated_at?: string;
|
|
16
|
-
object: 'reward';
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
object: 'list';
|
|
22
|
-
total: number;
|
|
23
|
-
data_ref: 'data';
|
|
24
|
-
data: RewardsCreateResponse[];
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
name: string;
|
|
28
|
-
stock?: number;
|
|
29
|
-
attributes?: {
|
|
30
|
-
image_url?: string;
|
|
31
|
-
description?: string;
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
|
-
interface RewardsTypeMaterial {
|
|
35
|
-
type?: 'MATERIAL';
|
|
36
|
-
parameters: {
|
|
37
|
-
product?: {
|
|
38
|
-
id?: string;
|
|
39
|
-
sku?: string;
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
}
|
|
43
|
-
interface RewardsTypeCampaign {
|
|
44
|
-
type?: 'CAMPAIGN';
|
|
45
|
-
parameters: {
|
|
46
|
-
campaign?: {
|
|
47
|
-
id: string;
|
|
48
|
-
balance?: number;
|
|
49
|
-
};
|
|
50
|
-
};
|
|
51
|
-
}
|
|
52
|
-
interface RewardsTypeCampaignResponse {
|
|
53
|
-
type?: 'CAMPAIGN';
|
|
54
|
-
parameters: {
|
|
55
|
-
campaign?: {
|
|
56
|
-
id: string;
|
|
57
|
-
balance?: number;
|
|
58
|
-
type?: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
|
|
59
|
-
};
|
|
60
|
-
};
|
|
61
|
-
}
|
|
62
|
-
interface RewardsTypeCoin {
|
|
63
|
-
type?: 'COIN';
|
|
64
|
-
parameters: {
|
|
65
|
-
coin?: {
|
|
66
|
-
exchange_ratio?: number;
|
|
67
|
-
};
|
|
68
|
-
};
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
id: string;
|
|
75
|
-
};
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
id: string;
|
|
79
|
-
reward_id: string;
|
|
80
|
-
related_object_id?: string;
|
|
81
|
-
related_object_type?: string;
|
|
82
|
-
parameters?: {
|
|
83
|
-
loyalty?: {
|
|
84
|
-
points: number;
|
|
85
|
-
};
|
|
86
|
-
};
|
|
87
|
-
created_at: string;
|
|
88
|
-
updated_at?: string;
|
|
89
|
-
object: 'reward_assignment';
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
limit?: number;
|
|
93
|
-
page?: number;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
total: number;
|
|
97
|
-
data: RewardsAssignmentObject[];
|
|
98
|
-
object: 'list';
|
|
99
|
-
data_ref: 'data';
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
campaign?: string;
|
|
103
|
-
parameters?: {
|
|
104
|
-
loyalty?: {
|
|
105
|
-
points: number;
|
|
106
|
-
};
|
|
107
|
-
};
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
id: string;
|
|
112
|
-
};
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
points?: number;
|
|
116
|
-
assignment_id?: string;
|
|
117
|
-
id?: string;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
id: string;
|
|
121
|
-
name?: string;
|
|
122
|
-
stock?: string;
|
|
123
|
-
redeemed?: string;
|
|
124
|
-
attributes?: {
|
|
125
|
-
image_url?: string;
|
|
126
|
-
description?: string;
|
|
127
|
-
};
|
|
128
|
-
created_at: string;
|
|
129
|
-
updated_at?: string;
|
|
130
|
-
object: 'reward';
|
|
131
|
-
} & RewardType;
|
|
132
|
-
|
|
133
|
-
type: 'CAMPAIGN';
|
|
134
|
-
parameters: {
|
|
135
|
-
campaign: {
|
|
136
|
-
id: string;
|
|
137
|
-
balance?: number;
|
|
138
|
-
type: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
|
|
139
|
-
};
|
|
140
|
-
};
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
type: 'COIN';
|
|
144
|
-
parameters: {
|
|
145
|
-
coin: {
|
|
146
|
-
exchange_ratio: number;
|
|
147
|
-
points_ratio?: number;
|
|
148
|
-
};
|
|
149
|
-
};
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
type: 'MATERIAL';
|
|
153
|
-
parameters: {
|
|
154
|
-
product: {
|
|
155
|
-
id: string;
|
|
156
|
-
sku: string | null;
|
|
157
|
-
};
|
|
158
|
-
};
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
id: string;
|
|
164
|
-
reward_id: string;
|
|
165
|
-
related_object_id: string;
|
|
166
|
-
related_object_type: 'campaign';
|
|
167
|
-
created_at: string;
|
|
168
|
-
updated_at: string | null;
|
|
169
|
-
object: 'reward-assignment';
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
id: string;
|
|
173
|
-
reward_id: string;
|
|
174
|
-
related_object_id: string;
|
|
175
|
-
related_object_type: 'campaign';
|
|
176
|
-
created_at: string;
|
|
177
|
-
updated_at: string | null;
|
|
178
|
-
object: 'reward-assignment';
|
|
179
|
-
parameters: {
|
|
180
|
-
loyalty: {
|
|
181
|
-
points?: number;
|
|
182
|
-
};
|
|
183
|
-
};
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
limit?: number;
|
|
188
|
-
page?: number;
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
object: 'list';
|
|
192
|
-
data_ref: 'data';
|
|
193
|
-
data: RewardAssignment[];
|
|
194
|
-
total: number;
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
campaign: string;
|
|
199
|
-
validation_rules?: string[];
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
campaign: string;
|
|
203
|
-
parameters: {
|
|
204
|
-
loyalty: {
|
|
205
|
-
points?: number;
|
|
206
|
-
};
|
|
207
|
-
};
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
parameters?: {
|
|
212
|
-
loyalty?: {
|
|
213
|
-
points?: number;
|
|
214
|
-
};
|
|
215
|
-
};
|
|
216
|
-
id: string;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
|
|
1
|
+
interface RewardsListParams {
|
|
2
|
+
page?: number;
|
|
3
|
+
limit?: number;
|
|
4
|
+
}
|
|
5
|
+
interface RewardsResponse {
|
|
6
|
+
id: string;
|
|
7
|
+
name?: string;
|
|
8
|
+
stock?: number;
|
|
9
|
+
redeemed?: number;
|
|
10
|
+
attributes?: {
|
|
11
|
+
image_url?: string;
|
|
12
|
+
description?: string;
|
|
13
|
+
};
|
|
14
|
+
created_at: string;
|
|
15
|
+
updated_at?: string;
|
|
16
|
+
object: 'reward';
|
|
17
|
+
}
|
|
18
|
+
type RewardsCreateResponse = RewardsResponse & RewardsTypeResponse;
|
|
19
|
+
type RewardsGetResponse = RewardsResponse & RewardsTypeResponse;
|
|
20
|
+
interface RewardsListResponse {
|
|
21
|
+
object: 'list';
|
|
22
|
+
total: number;
|
|
23
|
+
data_ref: 'data';
|
|
24
|
+
data: RewardsCreateResponse[];
|
|
25
|
+
}
|
|
26
|
+
interface Rewards {
|
|
27
|
+
name: string;
|
|
28
|
+
stock?: number;
|
|
29
|
+
attributes?: {
|
|
30
|
+
image_url?: string;
|
|
31
|
+
description?: string;
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
interface RewardsTypeMaterial {
|
|
35
|
+
type?: 'MATERIAL';
|
|
36
|
+
parameters: {
|
|
37
|
+
product?: {
|
|
38
|
+
id?: string;
|
|
39
|
+
sku?: string;
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
interface RewardsTypeCampaign {
|
|
44
|
+
type?: 'CAMPAIGN';
|
|
45
|
+
parameters: {
|
|
46
|
+
campaign?: {
|
|
47
|
+
id: string;
|
|
48
|
+
balance?: number;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
interface RewardsTypeCampaignResponse {
|
|
53
|
+
type?: 'CAMPAIGN';
|
|
54
|
+
parameters: {
|
|
55
|
+
campaign?: {
|
|
56
|
+
id: string;
|
|
57
|
+
balance?: number;
|
|
58
|
+
type?: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
interface RewardsTypeCoin {
|
|
63
|
+
type?: 'COIN';
|
|
64
|
+
parameters: {
|
|
65
|
+
coin?: {
|
|
66
|
+
exchange_ratio?: number;
|
|
67
|
+
};
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
type RewardsType = RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial;
|
|
71
|
+
type RewardsTypeResponse = Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>;
|
|
72
|
+
type RewardsCreate = Rewards & RewardsType;
|
|
73
|
+
type RewardsUpdate = Omit<RewardsCreate, 'type'> & {
|
|
74
|
+
id: string;
|
|
75
|
+
};
|
|
76
|
+
type RewardsUpdateResponse = RewardsCreateResponse;
|
|
77
|
+
interface RewardsAssignmentObject {
|
|
78
|
+
id: string;
|
|
79
|
+
reward_id: string;
|
|
80
|
+
related_object_id?: string;
|
|
81
|
+
related_object_type?: string;
|
|
82
|
+
parameters?: {
|
|
83
|
+
loyalty?: {
|
|
84
|
+
points: number;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
created_at: string;
|
|
88
|
+
updated_at?: string;
|
|
89
|
+
object: 'reward_assignment';
|
|
90
|
+
}
|
|
91
|
+
interface RewardsListAssignmentsParams {
|
|
92
|
+
limit?: number;
|
|
93
|
+
page?: number;
|
|
94
|
+
}
|
|
95
|
+
interface RewardsListAssignmentsResponse {
|
|
96
|
+
total: number;
|
|
97
|
+
data: RewardsAssignmentObject[];
|
|
98
|
+
object: 'list';
|
|
99
|
+
data_ref: 'data';
|
|
100
|
+
}
|
|
101
|
+
interface RewardsCreateAssignment {
|
|
102
|
+
campaign?: string;
|
|
103
|
+
parameters?: {
|
|
104
|
+
loyalty?: {
|
|
105
|
+
points: number;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
type RewardsCreateAssignmentResponse = RewardsAssignmentObject;
|
|
110
|
+
type RewardsUpdateAssignment = RewardsCreateAssignment & {
|
|
111
|
+
id: string;
|
|
112
|
+
};
|
|
113
|
+
type RewardsUpdateAssignmentResponse = RewardsAssignmentObject;
|
|
114
|
+
interface RewardRedemptionParams {
|
|
115
|
+
points?: number;
|
|
116
|
+
assignment_id?: string;
|
|
117
|
+
id?: string;
|
|
118
|
+
}
|
|
119
|
+
type Reward = {
|
|
120
|
+
id: string;
|
|
121
|
+
name?: string;
|
|
122
|
+
stock?: string;
|
|
123
|
+
redeemed?: string;
|
|
124
|
+
attributes?: {
|
|
125
|
+
image_url?: string;
|
|
126
|
+
description?: string;
|
|
127
|
+
};
|
|
128
|
+
created_at: string;
|
|
129
|
+
updated_at?: string;
|
|
130
|
+
object: 'reward';
|
|
131
|
+
} & RewardType;
|
|
132
|
+
interface RewardTypeCampaign {
|
|
133
|
+
type: 'CAMPAIGN';
|
|
134
|
+
parameters: {
|
|
135
|
+
campaign: {
|
|
136
|
+
id: string;
|
|
137
|
+
balance?: number;
|
|
138
|
+
type: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
interface RewardTypeCoin {
|
|
143
|
+
type: 'COIN';
|
|
144
|
+
parameters: {
|
|
145
|
+
coin: {
|
|
146
|
+
exchange_ratio: number;
|
|
147
|
+
points_ratio?: number;
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
interface RewardTypeMaterial {
|
|
152
|
+
type: 'MATERIAL';
|
|
153
|
+
parameters: {
|
|
154
|
+
product: {
|
|
155
|
+
id: string;
|
|
156
|
+
sku: string | null;
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
}
|
|
160
|
+
type RewardType = RewardTypeCampaign | RewardTypeCoin | RewardTypeMaterial;
|
|
161
|
+
type RewardAssignment = RewardsAssignmentCoinReward | RewardsAssignmentCampaignOrMaterialReward;
|
|
162
|
+
interface RewardsAssignmentCoinReward {
|
|
163
|
+
id: string;
|
|
164
|
+
reward_id: string;
|
|
165
|
+
related_object_id: string;
|
|
166
|
+
related_object_type: 'campaign';
|
|
167
|
+
created_at: string;
|
|
168
|
+
updated_at: string | null;
|
|
169
|
+
object: 'reward-assignment';
|
|
170
|
+
}
|
|
171
|
+
interface RewardsAssignmentCampaignOrMaterialReward {
|
|
172
|
+
id: string;
|
|
173
|
+
reward_id: string;
|
|
174
|
+
related_object_id: string;
|
|
175
|
+
related_object_type: 'campaign';
|
|
176
|
+
created_at: string;
|
|
177
|
+
updated_at: string | null;
|
|
178
|
+
object: 'reward-assignment';
|
|
179
|
+
parameters: {
|
|
180
|
+
loyalty: {
|
|
181
|
+
points?: number;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
}
|
|
185
|
+
type RewardsGetAssignmentResponseBody = RewardAssignment;
|
|
186
|
+
interface RewardsListAssignmentsRequestQuery {
|
|
187
|
+
limit?: number;
|
|
188
|
+
page?: number;
|
|
189
|
+
}
|
|
190
|
+
interface RewardsListAssignmentsResponseBody {
|
|
191
|
+
object: 'list';
|
|
192
|
+
data_ref: 'data';
|
|
193
|
+
data: RewardAssignment[];
|
|
194
|
+
total: number;
|
|
195
|
+
}
|
|
196
|
+
type RewardsCreateAssignmentRequestBody = RewardsCreateAssignmentCoinRewardRequestBody | RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody;
|
|
197
|
+
interface RewardsCreateAssignmentCoinRewardRequestBody {
|
|
198
|
+
campaign: string;
|
|
199
|
+
validation_rules?: string[];
|
|
200
|
+
}
|
|
201
|
+
interface RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody {
|
|
202
|
+
campaign: string;
|
|
203
|
+
parameters: {
|
|
204
|
+
loyalty: {
|
|
205
|
+
points?: number;
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
}
|
|
209
|
+
type RewardsCreateAssignmentResponseBody = RewardAssignment;
|
|
210
|
+
interface RewardsUpdateAssignmentRequestBody {
|
|
211
|
+
parameters?: {
|
|
212
|
+
loyalty?: {
|
|
213
|
+
points?: number;
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
id: string;
|
|
217
|
+
}
|
|
218
|
+
type RewardsUpdateAssignmentResponseBody = RewardAssignment;
|
|
219
|
+
|
|
220
|
+
export type { Reward, RewardAssignment, RewardRedemptionParams, RewardType, RewardTypeCampaign, RewardTypeCoin, RewardTypeMaterial, Rewards, RewardsAssignmentCampaignOrMaterialReward, RewardsAssignmentCoinReward, RewardsAssignmentObject, RewardsCreate, RewardsCreateAssignment, RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody, RewardsCreateAssignmentCoinRewardRequestBody, RewardsCreateAssignmentRequestBody, RewardsCreateAssignmentResponse, RewardsCreateAssignmentResponseBody, RewardsCreateResponse, RewardsGetAssignmentResponseBody, RewardsGetResponse, RewardsListAssignmentsParams, RewardsListAssignmentsRequestQuery, RewardsListAssignmentsResponse, RewardsListAssignmentsResponseBody, RewardsListParams, RewardsListResponse, RewardsResponse, RewardsType, RewardsTypeResponse, RewardsUpdate, RewardsUpdateAssignment, RewardsUpdateAssignmentRequestBody, RewardsUpdateAssignmentResponse, RewardsUpdateAssignmentResponseBody, RewardsUpdateResponse };
|
package/dist/types/Segments.d.ts
CHANGED
|
@@ -1,32 +1,34 @@
|
|
|
1
|
-
|
|
2
|
-
name: string;
|
|
3
|
-
type: 'static' | 'auto-update';
|
|
4
|
-
filter?: {
|
|
5
|
-
junction?: 'AND' | 'OR';
|
|
6
|
-
[filter_conditions: string]: any;
|
|
7
|
-
};
|
|
8
|
-
customers?: string[];
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
id: string;
|
|
12
|
-
name: string;
|
|
13
|
-
created_at: string;
|
|
14
|
-
metadata?: Record<string, any>;
|
|
15
|
-
filter?: {
|
|
16
|
-
junction?: 'AND' | 'OR';
|
|
17
|
-
[filter_conditions: string]: any;
|
|
18
|
-
};
|
|
19
|
-
type?: string;
|
|
20
|
-
object: 'segment';
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
object: 'list';
|
|
25
|
-
total: number;
|
|
26
|
-
data_ref: 'data';
|
|
27
|
-
data: {
|
|
28
|
-
id: string;
|
|
29
|
-
name: string;
|
|
30
|
-
object: 'segment';
|
|
31
|
-
}[];
|
|
32
|
-
}
|
|
1
|
+
interface SegmentsCreate {
|
|
2
|
+
name: string;
|
|
3
|
+
type: 'static' | 'auto-update';
|
|
4
|
+
filter?: {
|
|
5
|
+
junction?: 'AND' | 'OR';
|
|
6
|
+
[filter_conditions: string]: any;
|
|
7
|
+
};
|
|
8
|
+
customers?: string[];
|
|
9
|
+
}
|
|
10
|
+
interface SegmentsCreateResponse {
|
|
11
|
+
id: string;
|
|
12
|
+
name: string;
|
|
13
|
+
created_at: string;
|
|
14
|
+
metadata?: Record<string, any>;
|
|
15
|
+
filter?: {
|
|
16
|
+
junction?: 'AND' | 'OR';
|
|
17
|
+
[filter_conditions: string]: any;
|
|
18
|
+
};
|
|
19
|
+
type?: string;
|
|
20
|
+
object: 'segment';
|
|
21
|
+
}
|
|
22
|
+
type SegmentsGetResponse = SegmentsCreateResponse;
|
|
23
|
+
interface SegmentsListResponse {
|
|
24
|
+
object: 'list';
|
|
25
|
+
total: number;
|
|
26
|
+
data_ref: 'data';
|
|
27
|
+
data: {
|
|
28
|
+
id: string;
|
|
29
|
+
name: string;
|
|
30
|
+
object: 'segment';
|
|
31
|
+
}[];
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export type { SegmentsCreate, SegmentsCreateResponse, SegmentsGetResponse, SegmentsListResponse };
|