@voucherify/sdk 1.2.0 → 2.0.1
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/CHANGELOG.md +50 -0
- package/README.md +129 -129
- package/dist/AsyncActions.d.ts +2 -2
- package/dist/Balance.d.ts +1 -1
- package/dist/Campaigns.d.ts +9 -9
- package/dist/ClientSide.d.ts +8 -8
- package/dist/Consents.d.ts +1 -1
- package/dist/Customers.d.ts +6 -6
- package/dist/Distributions.d.ts +2 -2
- package/dist/Events.d.ts +3 -0
- package/dist/Exports.d.ts +3 -3
- package/dist/Loyalties.d.ts +19 -19
- package/dist/Orders.d.ts +4 -4
- package/dist/Products.d.ts +14 -14
- package/dist/PromotionTiers.d.ts +6 -6
- package/dist/Promotions.d.ts +2 -2
- package/dist/Redemptions.d.ts +5 -5
- package/dist/Rewards.d.ts +8 -8
- package/dist/Segments.d.ts +4 -4
- package/dist/ValidationRules.d.ts +8 -8
- package/dist/Validations.d.ts +1 -1
- package/dist/VoucherifyClientSide.d.ts +2 -2
- package/dist/VoucherifyServerSide.d.ts +3 -3
- package/dist/Vouchers.d.ts +14 -13
- package/dist/helpers.d.ts +0 -1
- package/dist/types/Campaigns.d.ts +3 -0
- package/dist/types/Products.d.ts +7 -9
- package/dist/types/Vouchers.d.ts +12 -15
- package/dist/voucherifysdk.esm.js +136 -160
- package/dist/voucherifysdk.esm.js.map +1 -1
- package/dist/voucherifysdk.umd.development.js +136 -160
- package/dist/voucherifysdk.umd.development.js.map +1 -1
- package/dist/voucherifysdk.umd.production.min.js +1 -1
- package/dist/voucherifysdk.umd.production.min.js.map +1 -1
- package/package.json +2 -2
|
@@ -72,10 +72,7 @@
|
|
|
72
72
|
const response = await this.request.get(path, {
|
|
73
73
|
params,
|
|
74
74
|
paramsSerializer: function (params) {
|
|
75
|
-
return Qs.stringify(params
|
|
76
|
-
arrayFormat: 'brackets',
|
|
77
|
-
encode: false
|
|
78
|
-
});
|
|
75
|
+
return Qs.stringify(params);
|
|
79
76
|
}
|
|
80
77
|
});
|
|
81
78
|
return response.data;
|
|
@@ -137,34 +134,6 @@
|
|
|
137
134
|
if (condition) return;
|
|
138
135
|
throw new Error(message);
|
|
139
136
|
}
|
|
140
|
-
function toQueryParams(obj) {
|
|
141
|
-
const entries = [];
|
|
142
|
-
|
|
143
|
-
function mapToEntries(prefix, record) {
|
|
144
|
-
Object.entries(record).map(([key, val]) => {
|
|
145
|
-
if (val == null) return void 0;
|
|
146
|
-
|
|
147
|
-
switch (typeof val) {
|
|
148
|
-
case 'string':
|
|
149
|
-
case 'number':
|
|
150
|
-
case 'boolean':
|
|
151
|
-
case 'bigint':
|
|
152
|
-
if (prefix) return entries.push([`${prefix}[${key}]`, encode(val.toString())]);
|
|
153
|
-
return entries.push([key, encode(val.toString())]);
|
|
154
|
-
|
|
155
|
-
case 'object':
|
|
156
|
-
if (prefix) return mapToEntries(`${prefix}[${key}]`, val);
|
|
157
|
-
return mapToEntries(key, val);
|
|
158
|
-
|
|
159
|
-
default:
|
|
160
|
-
return void 0;
|
|
161
|
-
}
|
|
162
|
-
});
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
mapToEntries(null, obj);
|
|
166
|
-
return Object.fromEntries(entries);
|
|
167
|
-
}
|
|
168
137
|
/**
|
|
169
138
|
* Return an object containing all properties of `obj` excluding the ones in `keys` array
|
|
170
139
|
* e.g:
|
|
@@ -185,7 +154,7 @@
|
|
|
185
154
|
this.client = client;
|
|
186
155
|
}
|
|
187
156
|
/**
|
|
188
|
-
* @see https://docs.voucherify.io/reference
|
|
157
|
+
* @see https://docs.voucherify.io/reference/get-async-actions-1
|
|
189
158
|
*/
|
|
190
159
|
|
|
191
160
|
|
|
@@ -193,7 +162,7 @@
|
|
|
193
162
|
return this.client.get(`/async-actions/${encode(asyncActionId)}`);
|
|
194
163
|
}
|
|
195
164
|
/**
|
|
196
|
-
* @see https://docs.voucherify.io/reference
|
|
165
|
+
* @see https://docs.voucherify.io/reference/list-async-actions
|
|
197
166
|
*/
|
|
198
167
|
|
|
199
168
|
|
|
@@ -223,7 +192,7 @@
|
|
|
223
192
|
this.qualifications = new CampaignsQualifications(this.client);
|
|
224
193
|
}
|
|
225
194
|
/**
|
|
226
|
-
* @see https://docs.voucherify.io/reference
|
|
195
|
+
* @see https://docs.voucherify.io/reference/create-campaign
|
|
227
196
|
*/
|
|
228
197
|
|
|
229
198
|
|
|
@@ -231,7 +200,7 @@
|
|
|
231
200
|
return this.client.post('/campaigns', campaign);
|
|
232
201
|
}
|
|
233
202
|
/**
|
|
234
|
-
* @see https://docs.voucherify.io/reference
|
|
203
|
+
* @see https://docs.voucherify.io/reference/update-campaign
|
|
235
204
|
*/
|
|
236
205
|
|
|
237
206
|
|
|
@@ -239,7 +208,7 @@
|
|
|
239
208
|
return this.client.put(`/campaigns/${encode(nameOrId)}`, campaign);
|
|
240
209
|
}
|
|
241
210
|
/**
|
|
242
|
-
* @see https://docs.voucherify.io/reference
|
|
211
|
+
* @see https://docs.voucherify.io/reference/get-campaign
|
|
243
212
|
*/
|
|
244
213
|
|
|
245
214
|
|
|
@@ -247,7 +216,7 @@
|
|
|
247
216
|
return this.client.get(`/campaigns/${encode(name)}`);
|
|
248
217
|
}
|
|
249
218
|
/**
|
|
250
|
-
* @see https://docs.voucherify.io/reference
|
|
219
|
+
* @see https://docs.voucherify.io/reference/delete-campaign
|
|
251
220
|
*/
|
|
252
221
|
|
|
253
222
|
|
|
@@ -255,7 +224,7 @@
|
|
|
255
224
|
return this.client.delete(`/campaigns/${encode(name)}`, params);
|
|
256
225
|
}
|
|
257
226
|
/**
|
|
258
|
-
* @see https://docs.voucherify.io/reference
|
|
227
|
+
* @see https://docs.voucherify.io/reference/add-voucher-to-campaign
|
|
259
228
|
*/
|
|
260
229
|
|
|
261
230
|
|
|
@@ -263,7 +232,7 @@
|
|
|
263
232
|
return this.client.post(`/campaigns/${encode(name)}/vouchers`, body, params);
|
|
264
233
|
}
|
|
265
234
|
/**
|
|
266
|
-
* @see https://docs.voucherify.io/reference
|
|
235
|
+
* @see https://docs.voucherify.io/reference/add-voucher-with-certain-code-to-campaign
|
|
267
236
|
*/
|
|
268
237
|
|
|
269
238
|
|
|
@@ -271,7 +240,7 @@
|
|
|
271
240
|
return this.client.post(`/campaigns/${encode(name)}/vouchers/${encode(code)}`, body);
|
|
272
241
|
}
|
|
273
242
|
/**
|
|
274
|
-
* @see https://docs.voucherify.io/reference
|
|
243
|
+
* @see https://docs.voucherify.io/reference/import-vouchers
|
|
275
244
|
*/
|
|
276
245
|
|
|
277
246
|
|
|
@@ -279,7 +248,7 @@
|
|
|
279
248
|
return this.client.post(`/campaigns/${encode(campaignName)}/import`, vouchers);
|
|
280
249
|
}
|
|
281
250
|
/**
|
|
282
|
-
* @see https://docs.voucherify.io/
|
|
251
|
+
* @see https://docs.voucherify.io/reference/list-campaigns
|
|
283
252
|
*/
|
|
284
253
|
|
|
285
254
|
|
|
@@ -295,7 +264,7 @@
|
|
|
295
264
|
this.client = client;
|
|
296
265
|
}
|
|
297
266
|
/**
|
|
298
|
-
* @see https://docs.voucherify.io/reference
|
|
267
|
+
* @see https://docs.voucherify.io/reference/list-publications
|
|
299
268
|
*/
|
|
300
269
|
|
|
301
270
|
|
|
@@ -303,7 +272,7 @@
|
|
|
303
272
|
return this.client.get('/publications', params);
|
|
304
273
|
}
|
|
305
274
|
/**
|
|
306
|
-
* @see https://docs.voucherify.io/reference
|
|
275
|
+
* @see https://docs.voucherify.io/reference/create-publication
|
|
307
276
|
*/
|
|
308
277
|
|
|
309
278
|
|
|
@@ -331,7 +300,7 @@
|
|
|
331
300
|
this.client = client;
|
|
332
301
|
}
|
|
333
302
|
/**
|
|
334
|
-
* @see https://docs.voucherify.io/reference
|
|
303
|
+
* @see https://docs.voucherify.io/reference/create-export
|
|
335
304
|
*/
|
|
336
305
|
|
|
337
306
|
|
|
@@ -339,7 +308,7 @@
|
|
|
339
308
|
return this.client.post('/exports', exportResource);
|
|
340
309
|
}
|
|
341
310
|
/**
|
|
342
|
-
* @see https://docs.voucherify.io/reference
|
|
311
|
+
* @see https://docs.voucherify.io/reference/get-export
|
|
343
312
|
*/
|
|
344
313
|
|
|
345
314
|
|
|
@@ -347,7 +316,7 @@
|
|
|
347
316
|
return this.client.get(`/exports/${encode(exportResourceId)}`);
|
|
348
317
|
}
|
|
349
318
|
/**
|
|
350
|
-
* @see https://docs.voucherify.io/reference
|
|
319
|
+
* @see https://docs.voucherify.io/reference/delete-export
|
|
351
320
|
*/
|
|
352
321
|
|
|
353
322
|
|
|
@@ -362,6 +331,10 @@
|
|
|
362
331
|
this.client = void 0;
|
|
363
332
|
this.client = client;
|
|
364
333
|
}
|
|
334
|
+
/**
|
|
335
|
+
* @see https://docs.voucherify.io/reference/track-custom-event-client-side
|
|
336
|
+
*/
|
|
337
|
+
|
|
365
338
|
|
|
366
339
|
create(eventName, params) {
|
|
367
340
|
params = { ...params,
|
|
@@ -380,7 +353,7 @@
|
|
|
380
353
|
/**
|
|
381
354
|
* Add Gift Voucher Balance
|
|
382
355
|
* This method gives a possibility to add balance to an existing gift voucher.
|
|
383
|
-
* @see https://docs.voucherify.io/reference
|
|
356
|
+
* @see https://docs.voucherify.io/reference/add-gift-voucher-balance
|
|
384
357
|
*/
|
|
385
358
|
|
|
386
359
|
|
|
@@ -398,7 +371,8 @@
|
|
|
398
371
|
/**
|
|
399
372
|
* The method can be used for sending a request to display all vouchers qualified to the given customer and context (e.g., order, loyalty reward). A checking logic won't run among coupons from bulk unique codes campaigns. For campaigns with multiple unique codes, you should run a dedicated function for searching for qualified campaigns.
|
|
400
373
|
* As a sample use case, you can imagine a requirement of displaying below cart the coupons eligible to a customer. The customer can take and apply the proposed voucher.
|
|
401
|
-
*
|
|
374
|
+
*
|
|
375
|
+
* @see https://docs.voucherify.io/reference/push-qualification-request
|
|
402
376
|
*/
|
|
403
377
|
|
|
404
378
|
|
|
@@ -418,7 +392,7 @@
|
|
|
418
392
|
this.qualifications = new VouchersQualification(this.client);
|
|
419
393
|
}
|
|
420
394
|
/**
|
|
421
|
-
* @see https://docs.voucherify.io/reference
|
|
395
|
+
* @see https://docs.voucherify.io/reference/create-voucher
|
|
422
396
|
*/
|
|
423
397
|
|
|
424
398
|
|
|
@@ -426,7 +400,7 @@
|
|
|
426
400
|
return this.client.post(`/vouchers/${encode(voucher.code)}`, voucher);
|
|
427
401
|
}
|
|
428
402
|
/**
|
|
429
|
-
* @see https://docs.voucherify.io/reference
|
|
403
|
+
* @see https://docs.voucherify.io/reference/vouchers-get
|
|
430
404
|
*/
|
|
431
405
|
|
|
432
406
|
|
|
@@ -434,7 +408,7 @@
|
|
|
434
408
|
return this.client.get(`/vouchers/${encode(code)}`);
|
|
435
409
|
}
|
|
436
410
|
/**
|
|
437
|
-
* @see https://docs.voucherify.io/reference
|
|
411
|
+
* @see https://docs.voucherify.io/reference/update-voucher
|
|
438
412
|
*/
|
|
439
413
|
|
|
440
414
|
|
|
@@ -442,7 +416,7 @@
|
|
|
442
416
|
return this.client.put(`/vouchers/${encode(voucher.code)}`, voucher);
|
|
443
417
|
}
|
|
444
418
|
/**
|
|
445
|
-
* @see https://docs.voucherify.io/reference
|
|
419
|
+
* @see https://docs.voucherify.io/reference/delete-voucher
|
|
446
420
|
*/
|
|
447
421
|
|
|
448
422
|
|
|
@@ -450,7 +424,7 @@
|
|
|
450
424
|
return this.client.delete(`/vouchers/${encode(code)}`, params);
|
|
451
425
|
}
|
|
452
426
|
/**
|
|
453
|
-
* @see https://docs.voucherify.io/reference
|
|
427
|
+
* @see https://docs.voucherify.io/reference/list-vouchers
|
|
454
428
|
*/
|
|
455
429
|
|
|
456
430
|
|
|
@@ -458,7 +432,7 @@
|
|
|
458
432
|
return this.client.get('/vouchers', params);
|
|
459
433
|
}
|
|
460
434
|
/**
|
|
461
|
-
* @see https://docs.voucherify.io/reference
|
|
435
|
+
* @see https://docs.voucherify.io/reference/enable-voucher
|
|
462
436
|
*/
|
|
463
437
|
|
|
464
438
|
|
|
@@ -466,7 +440,7 @@
|
|
|
466
440
|
return this.client.post(`/vouchers/${encode(code)}/enable`, {});
|
|
467
441
|
}
|
|
468
442
|
/**
|
|
469
|
-
* @see https://docs.voucherify.io/reference
|
|
443
|
+
* @see https://docs.voucherify.io/reference/disable-voucher
|
|
470
444
|
*/
|
|
471
445
|
|
|
472
446
|
|
|
@@ -474,7 +448,7 @@
|
|
|
474
448
|
return this.client.post(`/vouchers/${encode(code)}/disable`, {});
|
|
475
449
|
}
|
|
476
450
|
/**
|
|
477
|
-
* @see https://docs.voucherify.io/reference
|
|
451
|
+
* @see https://docs.voucherify.io/reference/import-vouchers-1
|
|
478
452
|
*/
|
|
479
453
|
|
|
480
454
|
|
|
@@ -482,23 +456,23 @@
|
|
|
482
456
|
return this.client.post('/vouchers/import', vouchers);
|
|
483
457
|
}
|
|
484
458
|
/**
|
|
485
|
-
* @see https://docs.voucherify.io/reference
|
|
459
|
+
* @see https://docs.voucherify.io/reference/aaupdate-vouchers-metadata-in-bulk
|
|
486
460
|
*/
|
|
487
461
|
|
|
488
462
|
|
|
489
463
|
bulkUpdateMetadata(params) {
|
|
490
|
-
return this.client.post('/vouchers/metadata', params);
|
|
464
|
+
return this.client.post('/vouchers/metadata/async', params);
|
|
491
465
|
}
|
|
492
466
|
/**
|
|
493
|
-
* @see https://docs.voucherify.io/reference
|
|
467
|
+
* @see https://docs.voucherify.io/reference/aa-update-vouchers-in-bulk
|
|
494
468
|
*/
|
|
495
469
|
|
|
496
470
|
|
|
497
471
|
bulkUpdate(vouchers) {
|
|
498
|
-
return this.client.post('/vouchers/bulk', vouchers);
|
|
472
|
+
return this.client.post('/vouchers/bulk/async', vouchers);
|
|
499
473
|
}
|
|
500
474
|
/**
|
|
501
|
-
* @see https://docs.voucherify.io/reference
|
|
475
|
+
* @see https://docs.voucherify.io/reference/release-validation-session
|
|
502
476
|
*/
|
|
503
477
|
|
|
504
478
|
|
|
@@ -516,7 +490,7 @@
|
|
|
516
490
|
this.promotions = promotions;
|
|
517
491
|
}
|
|
518
492
|
/**
|
|
519
|
-
* @see https://docs.voucherify.io/reference
|
|
493
|
+
* @see https://docs.voucherify.io/reference/validate-voucher
|
|
520
494
|
*/
|
|
521
495
|
|
|
522
496
|
|
|
@@ -540,7 +514,7 @@
|
|
|
540
514
|
this.client = client;
|
|
541
515
|
}
|
|
542
516
|
/**
|
|
543
|
-
* @see https://docs.voucherify.io/reference
|
|
517
|
+
* @see https://docs.voucherify.io/reference/redeem-voucher
|
|
544
518
|
*/
|
|
545
519
|
|
|
546
520
|
|
|
@@ -548,7 +522,7 @@
|
|
|
548
522
|
return this.client.post(`/vouchers/${encode(code)}/redemption`, body);
|
|
549
523
|
}
|
|
550
524
|
/**
|
|
551
|
-
* @see https://docs.voucherify.io/reference
|
|
525
|
+
* @see https://docs.voucherify.io/reference/get-redemption
|
|
552
526
|
*/
|
|
553
527
|
|
|
554
528
|
|
|
@@ -556,7 +530,7 @@
|
|
|
556
530
|
return this.client.get(`/redemptions/${encode(redemptionId)}`);
|
|
557
531
|
}
|
|
558
532
|
/**
|
|
559
|
-
* @see https://docs.voucherify.io/reference
|
|
533
|
+
* @see https://docs.voucherify.io/reference/list-redemptions
|
|
560
534
|
*/
|
|
561
535
|
|
|
562
536
|
|
|
@@ -564,7 +538,7 @@
|
|
|
564
538
|
return this.client.get('/redemptions', params);
|
|
565
539
|
}
|
|
566
540
|
/**
|
|
567
|
-
* @see https://docs.voucherify.io/reference
|
|
541
|
+
* @see https://docs.voucherify.io/reference/vouchers-redemptions
|
|
568
542
|
*/
|
|
569
543
|
|
|
570
544
|
|
|
@@ -572,7 +546,7 @@
|
|
|
572
546
|
return this.client.get(`/vouchers/${encode(code)}/redemption`);
|
|
573
547
|
}
|
|
574
548
|
/**
|
|
575
|
-
* @see https://docs.voucherify.io/reference
|
|
549
|
+
* @see https://docs.voucherify.io/reference/rollback-redemption
|
|
576
550
|
*/
|
|
577
551
|
|
|
578
552
|
|
|
@@ -608,7 +582,7 @@
|
|
|
608
582
|
this.client = client;
|
|
609
583
|
}
|
|
610
584
|
/**
|
|
611
|
-
* @see
|
|
585
|
+
* @see https://docs.voucherify.io/reference/list-promotion-tiers
|
|
612
586
|
*/
|
|
613
587
|
|
|
614
588
|
|
|
@@ -616,7 +590,7 @@
|
|
|
616
590
|
return this.client.get('/promotions/tiers', params);
|
|
617
591
|
}
|
|
618
592
|
/**
|
|
619
|
-
* @see
|
|
593
|
+
* @see https://docs.voucherify.io/reference/get-promotions
|
|
620
594
|
*/
|
|
621
595
|
|
|
622
596
|
|
|
@@ -624,7 +598,7 @@
|
|
|
624
598
|
return this.client.get(`/promotions/${encode(promotionId)}/tiers`);
|
|
625
599
|
}
|
|
626
600
|
/**
|
|
627
|
-
* @see
|
|
601
|
+
* @see https://docs.voucherify.io/reference/add-promotion-tier-to-campaign
|
|
628
602
|
*/
|
|
629
603
|
|
|
630
604
|
|
|
@@ -632,7 +606,7 @@
|
|
|
632
606
|
return this.client.post(`/promotions/${encode(promotionId)}/tiers`, params);
|
|
633
607
|
}
|
|
634
608
|
/**
|
|
635
|
-
* @see
|
|
609
|
+
* @see https://docs.voucherify.io/reference/redeem-promotion
|
|
636
610
|
*/
|
|
637
611
|
|
|
638
612
|
|
|
@@ -640,7 +614,7 @@
|
|
|
640
614
|
return this.client.post(`/promotions/tiers/${encode(promotionsTierId)}/redemption`, params);
|
|
641
615
|
}
|
|
642
616
|
/**
|
|
643
|
-
* @see
|
|
617
|
+
* @see https://docs.voucherify.io/reference/update-promotion
|
|
644
618
|
*/
|
|
645
619
|
|
|
646
620
|
|
|
@@ -648,7 +622,7 @@
|
|
|
648
622
|
return this.client.put(`/promotions/tiers/${encode(params.id)}`, params);
|
|
649
623
|
}
|
|
650
624
|
/**
|
|
651
|
-
* @see
|
|
625
|
+
* @see https://docs.voucherify.io/reference/delete-promotion
|
|
652
626
|
*/
|
|
653
627
|
|
|
654
628
|
|
|
@@ -666,7 +640,7 @@
|
|
|
666
640
|
this.tiers = tiers;
|
|
667
641
|
}
|
|
668
642
|
/**
|
|
669
|
-
* @see
|
|
643
|
+
* @see https://docs.voucherify.io/reference/create-promotion-campaign
|
|
670
644
|
*/
|
|
671
645
|
|
|
672
646
|
|
|
@@ -674,7 +648,7 @@
|
|
|
674
648
|
return this.client.post('/campaigns', promotionCampaign);
|
|
675
649
|
}
|
|
676
650
|
/**
|
|
677
|
-
* @see
|
|
651
|
+
* @see https://docs.voucherify.io/reference/validate-promotions-1
|
|
678
652
|
*/
|
|
679
653
|
|
|
680
654
|
|
|
@@ -690,7 +664,7 @@
|
|
|
690
664
|
this.client = client;
|
|
691
665
|
}
|
|
692
666
|
/**
|
|
693
|
-
* @see https://docs.voucherify.io/reference
|
|
667
|
+
* @see https://docs.voucherify.io/reference/create-customer
|
|
694
668
|
*/
|
|
695
669
|
|
|
696
670
|
|
|
@@ -698,7 +672,7 @@
|
|
|
698
672
|
return this.client.post('/customers', customer);
|
|
699
673
|
}
|
|
700
674
|
/**
|
|
701
|
-
* @see https://docs.voucherify.io/reference
|
|
675
|
+
* @see https://docs.voucherify.io/reference/read-customer
|
|
702
676
|
*/
|
|
703
677
|
|
|
704
678
|
|
|
@@ -706,7 +680,7 @@
|
|
|
706
680
|
return this.client.get(`/customers/${encode(customerId)}`);
|
|
707
681
|
}
|
|
708
682
|
/**
|
|
709
|
-
* @see https://docs.voucherify.io/reference
|
|
683
|
+
* @see https://docs.voucherify.io/reference/list-customers
|
|
710
684
|
*/
|
|
711
685
|
|
|
712
686
|
|
|
@@ -754,7 +728,7 @@
|
|
|
754
728
|
}
|
|
755
729
|
}
|
|
756
730
|
/**
|
|
757
|
-
* @see https://docs.voucherify.io/reference
|
|
731
|
+
* @see https://docs.voucherify.io/reference/update-customer
|
|
758
732
|
*/
|
|
759
733
|
|
|
760
734
|
|
|
@@ -764,7 +738,7 @@
|
|
|
764
738
|
return this.client.put(`/customers/${encode(id)}`, customerWithoutId);
|
|
765
739
|
}
|
|
766
740
|
/**
|
|
767
|
-
* @see https://docs.voucherify.io/reference
|
|
741
|
+
* @see https://docs.voucherify.io/reference/delete-customer
|
|
768
742
|
*/
|
|
769
743
|
|
|
770
744
|
|
|
@@ -772,7 +746,7 @@
|
|
|
772
746
|
return this.client.delete(`/customers/${encode(customerId)}`);
|
|
773
747
|
}
|
|
774
748
|
/**
|
|
775
|
-
* @see https://docs.voucherify.io/reference
|
|
749
|
+
* @see https://docs.voucherify.io/reference/update-customers-consents
|
|
776
750
|
*/
|
|
777
751
|
|
|
778
752
|
|
|
@@ -788,7 +762,7 @@
|
|
|
788
762
|
this.client = client;
|
|
789
763
|
}
|
|
790
764
|
/**
|
|
791
|
-
* @see https://docs.voucherify.io/reference
|
|
765
|
+
* @see https://docs.voucherify.io/reference/get-consents
|
|
792
766
|
*/
|
|
793
767
|
|
|
794
768
|
|
|
@@ -804,7 +778,7 @@
|
|
|
804
778
|
this.client = client;
|
|
805
779
|
}
|
|
806
780
|
/**
|
|
807
|
-
* @see https://docs.voucherify.io/reference
|
|
781
|
+
* @see https://docs.voucherify.io/reference/create-order
|
|
808
782
|
*/
|
|
809
783
|
|
|
810
784
|
|
|
@@ -812,7 +786,7 @@
|
|
|
812
786
|
return this.client.post('/orders', order);
|
|
813
787
|
}
|
|
814
788
|
/**
|
|
815
|
-
* @see https://docs.voucherify.io/reference
|
|
789
|
+
* @see https://docs.voucherify.io/reference/get-order
|
|
816
790
|
*/
|
|
817
791
|
|
|
818
792
|
|
|
@@ -820,7 +794,7 @@
|
|
|
820
794
|
return this.client.get(`/orders/${encode(orderId)}`);
|
|
821
795
|
}
|
|
822
796
|
/**
|
|
823
|
-
* @see https://docs.voucherify.io/reference
|
|
797
|
+
* @see https://docs.voucherify.io/reference/update-order
|
|
824
798
|
*/
|
|
825
799
|
|
|
826
800
|
|
|
@@ -828,7 +802,7 @@
|
|
|
828
802
|
return this.client.put(`/orders/${encode(order.id || order.source_id)}`, omit(order, ['id']));
|
|
829
803
|
}
|
|
830
804
|
/**
|
|
831
|
-
* @see https://docs.voucherify.io/reference
|
|
805
|
+
* @see https://docs.voucherify.io/reference/list-orders
|
|
832
806
|
*/
|
|
833
807
|
|
|
834
808
|
|
|
@@ -844,7 +818,7 @@
|
|
|
844
818
|
this.client = client;
|
|
845
819
|
}
|
|
846
820
|
/**
|
|
847
|
-
* @see https://docs.voucherify.io/reference
|
|
821
|
+
* @see https://docs.voucherify.io/reference/create-product
|
|
848
822
|
*/
|
|
849
823
|
|
|
850
824
|
|
|
@@ -852,7 +826,7 @@
|
|
|
852
826
|
return this.client.post('/products', product);
|
|
853
827
|
}
|
|
854
828
|
/**
|
|
855
|
-
* @see https://docs.voucherify.io/reference
|
|
829
|
+
* @see https://docs.voucherify.io/reference/get-product
|
|
856
830
|
*/
|
|
857
831
|
|
|
858
832
|
|
|
@@ -860,7 +834,7 @@
|
|
|
860
834
|
return this.client.get(`/products/${encode(productId)}`);
|
|
861
835
|
}
|
|
862
836
|
/**
|
|
863
|
-
* @see https://docs.voucherify.io/reference
|
|
837
|
+
* @see https://docs.voucherify.io/reference/update-product
|
|
864
838
|
*/
|
|
865
839
|
|
|
866
840
|
|
|
@@ -868,23 +842,23 @@
|
|
|
868
842
|
return this.client.put(`/products/${encode(product.id || product.source_id)}`, omit(product, ['id']));
|
|
869
843
|
}
|
|
870
844
|
/**
|
|
871
|
-
* @see https://docs.voucherify.io/reference
|
|
845
|
+
* @see https://docs.voucherify.io/reference/async-update-products-metadata-in-bulk
|
|
872
846
|
*/
|
|
873
847
|
|
|
874
848
|
|
|
875
|
-
|
|
876
|
-
return this.client.post('/products/metadata', products);
|
|
849
|
+
bulkUpdateMetadata(products) {
|
|
850
|
+
return this.client.post('/products/metadata/async', products);
|
|
877
851
|
}
|
|
878
852
|
/**
|
|
879
|
-
* @see https://docs.voucherify.io/reference
|
|
853
|
+
* @see https://docs.voucherify.io/reference/post-products-in-bulk
|
|
880
854
|
*/
|
|
881
855
|
|
|
882
856
|
|
|
883
857
|
bulkUpdate(products) {
|
|
884
|
-
return this.client.post('/products/bulk', products);
|
|
858
|
+
return this.client.post('/products/bulk/async', products);
|
|
885
859
|
}
|
|
886
860
|
/**
|
|
887
|
-
* @see https://docs.voucherify.io/reference
|
|
861
|
+
* @see https://docs.voucherify.io/reference/delete-product
|
|
888
862
|
*/
|
|
889
863
|
|
|
890
864
|
|
|
@@ -892,7 +866,7 @@
|
|
|
892
866
|
return this.client.delete(`/products/${encode(productId)}`, params);
|
|
893
867
|
}
|
|
894
868
|
/**
|
|
895
|
-
* @see https://docs.voucherify.io/reference
|
|
869
|
+
* @see https://docs.voucherify.io/reference/list-products
|
|
896
870
|
*/
|
|
897
871
|
|
|
898
872
|
|
|
@@ -900,7 +874,7 @@
|
|
|
900
874
|
return this.client.get('/products', params);
|
|
901
875
|
}
|
|
902
876
|
/**
|
|
903
|
-
* @see https://docs.voucherify.io/reference
|
|
877
|
+
* @see https://docs.voucherify.io/reference/create-sku
|
|
904
878
|
*/
|
|
905
879
|
|
|
906
880
|
|
|
@@ -908,15 +882,15 @@
|
|
|
908
882
|
return this.client.post(`/products/${encode(productId)}/skus`, sku);
|
|
909
883
|
}
|
|
910
884
|
/**
|
|
911
|
-
* @see https://docs.voucherify.io/reference
|
|
885
|
+
* @see https://docs.voucherify.io/reference/get-sku-v20210726
|
|
912
886
|
*/
|
|
913
887
|
|
|
914
888
|
|
|
915
|
-
getSku(
|
|
916
|
-
return this.client.get(`/
|
|
889
|
+
getSku(skuId) {
|
|
890
|
+
return this.client.get(`/skus/${encode(skuId)}`);
|
|
917
891
|
}
|
|
918
892
|
/**
|
|
919
|
-
* @see https://docs.voucherify.io/reference
|
|
893
|
+
* @see https://docs.voucherify.io/reference/update-sku
|
|
920
894
|
*/
|
|
921
895
|
|
|
922
896
|
|
|
@@ -924,7 +898,7 @@
|
|
|
924
898
|
return this.client.put(`/products/${encode(productId)}/skus/${encode(sku.id || sku.source_id)}`, omit(sku, ['id']));
|
|
925
899
|
}
|
|
926
900
|
/**
|
|
927
|
-
* @see https://docs.voucherify.io/reference
|
|
901
|
+
* @see https://docs.voucherify.io/reference/delete-sku
|
|
928
902
|
*/
|
|
929
903
|
|
|
930
904
|
|
|
@@ -932,7 +906,7 @@
|
|
|
932
906
|
return this.client.delete(`/products/${encode(productId)}/skus/${encode(skuId)}`, params);
|
|
933
907
|
}
|
|
934
908
|
/**
|
|
935
|
-
* @see https://docs.voucherify.io/reference
|
|
909
|
+
* @see https://docs.voucherify.io/reference/list-skus
|
|
936
910
|
*/
|
|
937
911
|
|
|
938
912
|
|
|
@@ -948,7 +922,7 @@
|
|
|
948
922
|
this.client = client;
|
|
949
923
|
}
|
|
950
924
|
/**
|
|
951
|
-
* @see https://docs.voucherify.io/reference
|
|
925
|
+
* @see https://docs.voucherify.io/reference/list-rewards
|
|
952
926
|
*/
|
|
953
927
|
|
|
954
928
|
|
|
@@ -956,7 +930,7 @@
|
|
|
956
930
|
return this.client.get('/rewards', params);
|
|
957
931
|
}
|
|
958
932
|
/**
|
|
959
|
-
* @see https://docs.voucherify.io/reference
|
|
933
|
+
* @see https://docs.voucherify.io/reference/create-reward
|
|
960
934
|
*/
|
|
961
935
|
|
|
962
936
|
|
|
@@ -964,7 +938,7 @@
|
|
|
964
938
|
return this.client.post('/rewards', reward);
|
|
965
939
|
}
|
|
966
940
|
/**
|
|
967
|
-
* @see https://docs.voucherify.io/reference
|
|
941
|
+
* @see https://docs.voucherify.io/reference/get-reward
|
|
968
942
|
*/
|
|
969
943
|
|
|
970
944
|
|
|
@@ -972,7 +946,7 @@
|
|
|
972
946
|
return this.client.get(`/rewards/${encode(rewardId)}`);
|
|
973
947
|
}
|
|
974
948
|
/**
|
|
975
|
-
* @see https://docs.voucherify.io/reference
|
|
949
|
+
* @see https://docs.voucherify.io/reference/update-reward
|
|
976
950
|
*/
|
|
977
951
|
|
|
978
952
|
|
|
@@ -980,7 +954,7 @@
|
|
|
980
954
|
return this.client.put(`/rewards/${encode(reward.id)}`, omit(reward, ['id']));
|
|
981
955
|
}
|
|
982
956
|
/**
|
|
983
|
-
* @see https://docs.voucherify.io/reference
|
|
957
|
+
* @see https://docs.voucherify.io/reference/delete-reward
|
|
984
958
|
*/
|
|
985
959
|
|
|
986
960
|
|
|
@@ -988,7 +962,7 @@
|
|
|
988
962
|
return this.client.delete(`/rewards/${encode(rewardId)}`);
|
|
989
963
|
}
|
|
990
964
|
/**
|
|
991
|
-
* @see https://docs.voucherify.io/reference
|
|
965
|
+
* @see https://docs.voucherify.io/reference/list-reward-assignments
|
|
992
966
|
*/
|
|
993
967
|
|
|
994
968
|
|
|
@@ -996,7 +970,7 @@
|
|
|
996
970
|
return this.client.get(`/rewards/${encode(rewardId)}/assignments`, params);
|
|
997
971
|
}
|
|
998
972
|
/**
|
|
999
|
-
* @see https://docs.voucherify.io/reference
|
|
973
|
+
* @see https://docs.voucherify.io/reference/create-reward-assignment
|
|
1000
974
|
*/
|
|
1001
975
|
|
|
1002
976
|
|
|
@@ -1004,7 +978,7 @@
|
|
|
1004
978
|
return this.client.post(`/rewards/${encode(rewardId)}/assignments`, assignment);
|
|
1005
979
|
}
|
|
1006
980
|
/**
|
|
1007
|
-
* @see https://docs.voucherify.io/reference
|
|
981
|
+
* @see https://docs.voucherify.io/reference/update-reward-assignment
|
|
1008
982
|
*/
|
|
1009
983
|
|
|
1010
984
|
|
|
@@ -1024,7 +998,7 @@
|
|
|
1024
998
|
this.client = client;
|
|
1025
999
|
}
|
|
1026
1000
|
/**
|
|
1027
|
-
* @see https://docs.voucherify.io/reference
|
|
1001
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-programs
|
|
1028
1002
|
*/
|
|
1029
1003
|
|
|
1030
1004
|
|
|
@@ -1032,7 +1006,7 @@
|
|
|
1032
1006
|
return this.client.get('/loyalties', params);
|
|
1033
1007
|
}
|
|
1034
1008
|
/**
|
|
1035
|
-
* @see https://docs.voucherify.io/reference
|
|
1009
|
+
* @see https://docs.voucherify.io/reference/create-loyalty-program
|
|
1036
1010
|
*/
|
|
1037
1011
|
|
|
1038
1012
|
|
|
@@ -1040,7 +1014,7 @@
|
|
|
1040
1014
|
return this.client.post('/loyalties', campaign);
|
|
1041
1015
|
}
|
|
1042
1016
|
/**
|
|
1043
|
-
* @see https://docs.voucherify.io/reference
|
|
1017
|
+
* @see https://docs.voucherify.io/reference/get-loyalty-program
|
|
1044
1018
|
*/
|
|
1045
1019
|
|
|
1046
1020
|
|
|
@@ -1048,7 +1022,7 @@
|
|
|
1048
1022
|
return this.client.get(`/loyalties/${encode(campaignId)}`);
|
|
1049
1023
|
}
|
|
1050
1024
|
/**
|
|
1051
|
-
* @see https://docs.voucherify.io/reference
|
|
1025
|
+
* @see https://docs.voucherify.io/reference/update-loyalty-program
|
|
1052
1026
|
*/
|
|
1053
1027
|
|
|
1054
1028
|
|
|
@@ -1056,7 +1030,7 @@
|
|
|
1056
1030
|
return this.client.put(`/loyalties/${encode(campaign.id)}`, omit(campaign, ['id']));
|
|
1057
1031
|
}
|
|
1058
1032
|
/**
|
|
1059
|
-
* @see https://docs.voucherify.io/reference
|
|
1033
|
+
* @see https://docs.voucherify.io/reference/delete-loyalty-program
|
|
1060
1034
|
*/
|
|
1061
1035
|
|
|
1062
1036
|
|
|
@@ -1064,7 +1038,7 @@
|
|
|
1064
1038
|
return this.client.delete(`/loyalties/${encode(campaignId)}`, params);
|
|
1065
1039
|
}
|
|
1066
1040
|
/**
|
|
1067
|
-
* @see https://docs.voucherify.io/reference
|
|
1041
|
+
* @see https://docs.voucherify.io/reference/list-reward-assignments-1
|
|
1068
1042
|
*/
|
|
1069
1043
|
|
|
1070
1044
|
|
|
@@ -1072,7 +1046,7 @@
|
|
|
1072
1046
|
return this.client.get(`/loyalties/${encode(campaignId)}/rewards`, params);
|
|
1073
1047
|
}
|
|
1074
1048
|
/**
|
|
1075
|
-
* @see https://docs.voucherify.io/reference
|
|
1049
|
+
* @see https://docs.voucherify.io/reference/create-reward-assignment-1
|
|
1076
1050
|
*/
|
|
1077
1051
|
|
|
1078
1052
|
|
|
@@ -1080,7 +1054,7 @@
|
|
|
1080
1054
|
return this.client.post(`/loyalties/${encode(campaignId)}/rewards`, assignment);
|
|
1081
1055
|
}
|
|
1082
1056
|
/**
|
|
1083
|
-
* @see https://docs.voucherify.io/reference
|
|
1057
|
+
* @see https://docs.voucherify.io/reference/update-reward-assignment-1
|
|
1084
1058
|
*/
|
|
1085
1059
|
|
|
1086
1060
|
|
|
@@ -1088,7 +1062,7 @@
|
|
|
1088
1062
|
return this.client.put(`/loyalties/${encode(campaignId)}/rewards/${assignment.id}`, omit(assignment, ['id']));
|
|
1089
1063
|
}
|
|
1090
1064
|
/**
|
|
1091
|
-
* @see https://docs.voucherify.io/reference
|
|
1065
|
+
* @see https://docs.voucherify.io/reference/delete-reward-assignment-1
|
|
1092
1066
|
*/
|
|
1093
1067
|
|
|
1094
1068
|
|
|
@@ -1096,7 +1070,7 @@
|
|
|
1096
1070
|
return this.client.delete(`/loyalties/${encode(campaignId)}/rewards/${assignmentId}`);
|
|
1097
1071
|
}
|
|
1098
1072
|
/**
|
|
1099
|
-
* @see https://docs.voucherify.io/reference
|
|
1073
|
+
* @see https://docs.voucherify.io/reference/list-earning-rules
|
|
1100
1074
|
*/
|
|
1101
1075
|
|
|
1102
1076
|
|
|
@@ -1104,7 +1078,7 @@
|
|
|
1104
1078
|
return this.client.get(`/loyalties/${encode(campaignId)}/earning-rules`, params);
|
|
1105
1079
|
}
|
|
1106
1080
|
/**
|
|
1107
|
-
* @see https://docs.voucherify.io/reference
|
|
1081
|
+
* @see https://docs.voucherify.io/reference/create-earning-rule
|
|
1108
1082
|
*/
|
|
1109
1083
|
|
|
1110
1084
|
|
|
@@ -1112,7 +1086,7 @@
|
|
|
1112
1086
|
return this.client.post(`/loyalties/${encode(campaignId)}/earning-rules`, earningRules);
|
|
1113
1087
|
}
|
|
1114
1088
|
/**
|
|
1115
|
-
* @see https://docs.voucherify.io/reference
|
|
1089
|
+
* @see https://docs.voucherify.io/reference/update-earning-rule
|
|
1116
1090
|
*/
|
|
1117
1091
|
|
|
1118
1092
|
|
|
@@ -1120,7 +1094,7 @@
|
|
|
1120
1094
|
return this.client.put(`/loyalties/${encode(campaignId)}/earning-rules/${earningRule.id}`, omit(earningRule, ['id']));
|
|
1121
1095
|
}
|
|
1122
1096
|
/**
|
|
1123
|
-
* @see https://docs.voucherify.io/reference
|
|
1097
|
+
* @see https://docs.voucherify.io/reference/delete-earning-rule
|
|
1124
1098
|
*/
|
|
1125
1099
|
|
|
1126
1100
|
|
|
@@ -1128,7 +1102,7 @@
|
|
|
1128
1102
|
return this.client.delete(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}`);
|
|
1129
1103
|
}
|
|
1130
1104
|
/**
|
|
1131
|
-
* @see https://docs.voucherify.io/reference
|
|
1105
|
+
* @see https://docs.voucherify.io/reference/list-members
|
|
1132
1106
|
*/
|
|
1133
1107
|
|
|
1134
1108
|
|
|
@@ -1136,7 +1110,7 @@
|
|
|
1136
1110
|
return this.client.get(`/loyalties/${encode(campaignId)}/members`, params);
|
|
1137
1111
|
}
|
|
1138
1112
|
/**
|
|
1139
|
-
* @see https://docs.voucherify.io/reference
|
|
1113
|
+
* @see https://docs.voucherify.io/reference/create-member
|
|
1140
1114
|
*/
|
|
1141
1115
|
|
|
1142
1116
|
|
|
@@ -1144,7 +1118,7 @@
|
|
|
1144
1118
|
return this.client.post(`/loyalties/${encode(campaignId)}/members`, member);
|
|
1145
1119
|
}
|
|
1146
1120
|
/**
|
|
1147
|
-
* @see https://docs.voucherify.io/reference
|
|
1121
|
+
* @see https://docs.voucherify.io/reference/get-member
|
|
1148
1122
|
*/
|
|
1149
1123
|
|
|
1150
1124
|
|
|
@@ -1152,7 +1126,7 @@
|
|
|
1152
1126
|
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}`);
|
|
1153
1127
|
}
|
|
1154
1128
|
/**
|
|
1155
|
-
* @see https://docs.voucherify.io/reference
|
|
1129
|
+
* @see https://docs.voucherify.io/reference/get-member-activities
|
|
1156
1130
|
*/
|
|
1157
1131
|
|
|
1158
1132
|
|
|
@@ -1160,7 +1134,7 @@
|
|
|
1160
1134
|
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/activities`);
|
|
1161
1135
|
}
|
|
1162
1136
|
/**
|
|
1163
|
-
* @see https://docs.voucherify.io/reference
|
|
1137
|
+
* @see https://docs.voucherify.io/reference/add-loyalty-card-balance
|
|
1164
1138
|
*/
|
|
1165
1139
|
|
|
1166
1140
|
|
|
@@ -1168,7 +1142,7 @@
|
|
|
1168
1142
|
return this.client.post(`/loyalties/${encode(campaignId)}/members/${memberId}/balance`, balance);
|
|
1169
1143
|
}
|
|
1170
1144
|
/**
|
|
1171
|
-
* @see https://docs.voucherify.io/reference
|
|
1145
|
+
* @see https://docs.voucherify.io/reference/redeem-loyalty-card
|
|
1172
1146
|
*/
|
|
1173
1147
|
|
|
1174
1148
|
|
|
@@ -1184,7 +1158,7 @@
|
|
|
1184
1158
|
this.client = client;
|
|
1185
1159
|
}
|
|
1186
1160
|
/**
|
|
1187
|
-
* @see https://docs.voucherify.io/reference
|
|
1161
|
+
* @see https://docs.voucherify.io/reference/create-validation-rules
|
|
1188
1162
|
*/
|
|
1189
1163
|
|
|
1190
1164
|
|
|
@@ -1192,7 +1166,7 @@
|
|
|
1192
1166
|
return this.client.post('/validation-rules', validationRule);
|
|
1193
1167
|
}
|
|
1194
1168
|
/**
|
|
1195
|
-
* @see https://docs.voucherify.io/reference
|
|
1169
|
+
* @see https://docs.voucherify.io/reference/get-validation-rules
|
|
1196
1170
|
*/
|
|
1197
1171
|
|
|
1198
1172
|
|
|
@@ -1200,7 +1174,7 @@
|
|
|
1200
1174
|
return this.client.get(`/validation-rules/${encode(validationRuleId)}`);
|
|
1201
1175
|
}
|
|
1202
1176
|
/**
|
|
1203
|
-
* @see https://docs.voucherify.io/reference
|
|
1177
|
+
* @see https://docs.voucherify.io/reference/update-validation-rules
|
|
1204
1178
|
*/
|
|
1205
1179
|
|
|
1206
1180
|
|
|
@@ -1208,7 +1182,7 @@
|
|
|
1208
1182
|
return this.client.put(`/validation-rules/${encode(validationRule.id)}`, omit(validationRule, ['id']));
|
|
1209
1183
|
}
|
|
1210
1184
|
/**
|
|
1211
|
-
* @see https://docs.voucherify.io/reference
|
|
1185
|
+
* @see https://docs.voucherify.io/reference/delete-validation-rules
|
|
1212
1186
|
*/
|
|
1213
1187
|
|
|
1214
1188
|
|
|
@@ -1216,7 +1190,7 @@
|
|
|
1216
1190
|
return this.client.delete(`/validation-rules/${encode(validationRuleId)}`);
|
|
1217
1191
|
}
|
|
1218
1192
|
/**
|
|
1219
|
-
* @see https://docs.voucherify.io/reference
|
|
1193
|
+
* @see https://docs.voucherify.io/reference/create-validation-rules-assignment
|
|
1220
1194
|
*/
|
|
1221
1195
|
|
|
1222
1196
|
|
|
@@ -1224,7 +1198,7 @@
|
|
|
1224
1198
|
return this.client.post(`/validation-rules/${encode(validationRuleId)}/assignments`, assignment);
|
|
1225
1199
|
}
|
|
1226
1200
|
/**
|
|
1227
|
-
* @see https://docs.voucherify.io/reference
|
|
1201
|
+
* @see https://docs.voucherify.io/reference/delete-validation-rules-assignment
|
|
1228
1202
|
*/
|
|
1229
1203
|
|
|
1230
1204
|
|
|
@@ -1236,7 +1210,7 @@
|
|
|
1236
1210
|
return this.client.post(`/validation-rules/${encode(validationRuleId)}/validation`, params);
|
|
1237
1211
|
}
|
|
1238
1212
|
/**
|
|
1239
|
-
* @see https://docs.voucherify.io/reference
|
|
1213
|
+
* @see https://docs.voucherify.io/reference/list-validation-rules
|
|
1240
1214
|
*/
|
|
1241
1215
|
|
|
1242
1216
|
|
|
@@ -1244,7 +1218,7 @@
|
|
|
1244
1218
|
return this.client.get('/validation-rules', params);
|
|
1245
1219
|
}
|
|
1246
1220
|
/**
|
|
1247
|
-
* @see https://docs.voucherify.io/reference
|
|
1221
|
+
* @see https://docs.voucherify.io/reference/list-validation-rule-assignments
|
|
1248
1222
|
*/
|
|
1249
1223
|
|
|
1250
1224
|
|
|
@@ -1260,7 +1234,7 @@
|
|
|
1260
1234
|
this.client = client;
|
|
1261
1235
|
}
|
|
1262
1236
|
/**
|
|
1263
|
-
* @see https://docs.voucherify.io/reference
|
|
1237
|
+
* @see https://docs.voucherify.io/reference/create-segment
|
|
1264
1238
|
*/
|
|
1265
1239
|
|
|
1266
1240
|
|
|
@@ -1268,7 +1242,7 @@
|
|
|
1268
1242
|
return this.client.post('/segments', segment);
|
|
1269
1243
|
}
|
|
1270
1244
|
/**
|
|
1271
|
-
* @see https://docs.voucherify.io/reference
|
|
1245
|
+
* @see https://docs.voucherify.io/reference/get-segment
|
|
1272
1246
|
*/
|
|
1273
1247
|
|
|
1274
1248
|
|
|
@@ -1276,7 +1250,7 @@
|
|
|
1276
1250
|
return this.client.get(`/segments/${encode(segmentId)}`);
|
|
1277
1251
|
}
|
|
1278
1252
|
/**
|
|
1279
|
-
* @see https://docs.voucherify.io/reference
|
|
1253
|
+
* @see https://docs.voucherify.io/reference/delete-segment
|
|
1280
1254
|
*/
|
|
1281
1255
|
|
|
1282
1256
|
|
|
@@ -1284,7 +1258,7 @@
|
|
|
1284
1258
|
return this.client.delete(`/segments/${encode(segmentId)}`);
|
|
1285
1259
|
}
|
|
1286
1260
|
/**
|
|
1287
|
-
* @see https://docs.voucherify.io/reference
|
|
1261
|
+
* @see https://docs.voucherify.io/reference/list-segments
|
|
1288
1262
|
*/
|
|
1289
1263
|
|
|
1290
1264
|
|
|
@@ -1322,7 +1296,7 @@
|
|
|
1322
1296
|
let headers = {
|
|
1323
1297
|
'X-App-Id': options.applicationId,
|
|
1324
1298
|
'X-App-Token': options.secretKey,
|
|
1325
|
-
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"
|
|
1299
|
+
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.1"}`,
|
|
1326
1300
|
'Content-Type': 'application/json'
|
|
1327
1301
|
};
|
|
1328
1302
|
|
|
@@ -1400,7 +1374,7 @@
|
|
|
1400
1374
|
this.trackingId = identity;
|
|
1401
1375
|
}
|
|
1402
1376
|
/**
|
|
1403
|
-
* @see https://docs.voucherify.io/reference
|
|
1377
|
+
* @see https://docs.voucherify.io/reference/vouchers-validate
|
|
1404
1378
|
*/
|
|
1405
1379
|
|
|
1406
1380
|
|
|
@@ -1421,7 +1395,11 @@
|
|
|
1421
1395
|
metadata: params.orderMetadata
|
|
1422
1396
|
};
|
|
1423
1397
|
query.customer = params.customer;
|
|
1424
|
-
query.tracking_id = this.trackingId;
|
|
1398
|
+
query.tracking_id = params.tracking_id || this.trackingId;
|
|
1399
|
+
query.session_type = params.session_type;
|
|
1400
|
+
query.session_key = params.session_key;
|
|
1401
|
+
query.session_ttl = params.session_ttl;
|
|
1402
|
+
query.session_ttl_unit = params.session_ttl_unit;
|
|
1425
1403
|
}
|
|
1426
1404
|
|
|
1427
1405
|
if (!!query.code) {
|
|
@@ -1433,12 +1411,11 @@
|
|
|
1433
1411
|
|
|
1434
1412
|
assert(isOptionalObject(query == null ? void 0 : (_query$customer2 = query.customer) == null ? void 0 : _query$customer2.metadata), 'client.validate: expected "params.customer.metadata" to be an object'); // prettier-ignore
|
|
1435
1413
|
|
|
1436
|
-
const queryParams = toQueryParams(query);
|
|
1437
1414
|
const path = query.code ? '/validate' : '/promotions/validation';
|
|
1438
|
-
return this.client.get(path,
|
|
1415
|
+
return this.client.get(path, query);
|
|
1439
1416
|
}
|
|
1440
1417
|
/**
|
|
1441
|
-
* @see https://docs.voucherify.io/reference
|
|
1418
|
+
* @see https://docs.voucherify.io/reference/redeem-voucher-client-side
|
|
1442
1419
|
*/
|
|
1443
1420
|
|
|
1444
1421
|
|
|
@@ -1454,7 +1431,7 @@
|
|
|
1454
1431
|
});
|
|
1455
1432
|
}
|
|
1456
1433
|
/**
|
|
1457
|
-
* @see https://docs.voucherify.io/reference
|
|
1434
|
+
* @see https://docs.voucherify.io/reference/create-publication
|
|
1458
1435
|
*/
|
|
1459
1436
|
|
|
1460
1437
|
|
|
@@ -1472,7 +1449,7 @@
|
|
|
1472
1449
|
return this.client.post('/publish', preparedPayload, queryParams);
|
|
1473
1450
|
}
|
|
1474
1451
|
/**
|
|
1475
|
-
* @see https://docs.voucherify.io/reference
|
|
1452
|
+
* @see https://docs.voucherify.io/reference/track-custom-event-client-side
|
|
1476
1453
|
*/
|
|
1477
1454
|
|
|
1478
1455
|
|
|
@@ -1485,15 +1462,15 @@
|
|
|
1485
1462
|
event: event_name,
|
|
1486
1463
|
metadata: metadata != null ? metadata : {},
|
|
1487
1464
|
customer: customer,
|
|
1488
|
-
referral: referral != null ? referral :
|
|
1489
|
-
loyalty: loyalty != null ? loyalty :
|
|
1465
|
+
referral: referral != null ? referral : undefined,
|
|
1466
|
+
loyalty: loyalty != null ? loyalty : undefined
|
|
1490
1467
|
};
|
|
1491
1468
|
payload.customer.source_id = (_customer$source_id = customer.source_id) != null ? _customer$source_id : this.trackingId;
|
|
1492
1469
|
assert(isString((_payload$customer4 = payload.customer) == null ? void 0 : _payload$customer4.source_id), 'client.track - expected payload to contain customer source id or to have tracking id set up by Voucherify client');
|
|
1493
1470
|
return this.client.post('/events', payload);
|
|
1494
1471
|
}
|
|
1495
1472
|
/**
|
|
1496
|
-
* @see https://docs.voucherify.io/reference
|
|
1473
|
+
* @see https://docs.voucherify.io/reference/list-vouchers
|
|
1497
1474
|
*/
|
|
1498
1475
|
|
|
1499
1476
|
|
|
@@ -1506,11 +1483,10 @@
|
|
|
1506
1483
|
query.customer = params.customer;
|
|
1507
1484
|
query.created_at = params.created_at;
|
|
1508
1485
|
query.updated_at = params.updated_at;
|
|
1509
|
-
|
|
1510
|
-
return this.client.get('/vouchers', queryParams);
|
|
1486
|
+
return this.client.get('/vouchers', query);
|
|
1511
1487
|
}
|
|
1512
1488
|
/**
|
|
1513
|
-
* @see https://docs.voucherify.io/reference
|
|
1489
|
+
* @see https://docs.voucherify.io/reference/create-customer
|
|
1514
1490
|
*/
|
|
1515
1491
|
|
|
1516
1492
|
|
|
@@ -1520,7 +1496,7 @@
|
|
|
1520
1496
|
} : {});
|
|
1521
1497
|
}
|
|
1522
1498
|
/**
|
|
1523
|
-
* @see https://docs.voucherify.io/reference
|
|
1499
|
+
* @see https://docs.voucherify.io/reference/get-consent-client-side
|
|
1524
1500
|
*/
|
|
1525
1501
|
|
|
1526
1502
|
|
|
@@ -1528,7 +1504,7 @@
|
|
|
1528
1504
|
return this.client.get('/consents');
|
|
1529
1505
|
}
|
|
1530
1506
|
/**
|
|
1531
|
-
* @see https://docs.voucherify.io/reference
|
|
1507
|
+
* @see https://docs.voucherify.io/reference/update-customers-consents-client
|
|
1532
1508
|
*/
|
|
1533
1509
|
|
|
1534
1510
|
|
|
@@ -1549,7 +1525,7 @@
|
|
|
1549
1525
|
let headers = {
|
|
1550
1526
|
'X-Client-Application-Id': options.clientApplicationId,
|
|
1551
1527
|
'X-Client-Token': options.clientSecretKey,
|
|
1552
|
-
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"
|
|
1528
|
+
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.1"}`
|
|
1553
1529
|
};
|
|
1554
1530
|
|
|
1555
1531
|
if (environment().startsWith('Node')) {
|