tremendous 3.7.0 → 3.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +29 -0
- package/dist/api.d.ts +1137 -133
- package/dist/api.js +694 -55
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* API Endpoints
|
|
3
|
-
* Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and
|
|
3
|
+
* Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 2
|
|
6
6
|
* Contact: developers@tremendous.com
|
|
@@ -290,6 +290,220 @@ export declare const Channel: {
|
|
|
290
290
|
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
291
291
|
};
|
|
292
292
|
export type Channel = typeof Channel[keyof typeof Channel];
|
|
293
|
+
/**
|
|
294
|
+
*
|
|
295
|
+
* @export
|
|
296
|
+
* @interface ConnectedOrganization
|
|
297
|
+
*/
|
|
298
|
+
export interface ConnectedOrganization {
|
|
299
|
+
/**
|
|
300
|
+
* Tremendous\' identifier for the connected organization.
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof ConnectedOrganization
|
|
303
|
+
*/
|
|
304
|
+
'id': string;
|
|
305
|
+
/**
|
|
306
|
+
* Client ID of the OAuth app that is to be used by the platform once the integration is complete.
|
|
307
|
+
* @type {string}
|
|
308
|
+
* @memberof ConnectedOrganization
|
|
309
|
+
*/
|
|
310
|
+
'client_id': string;
|
|
311
|
+
/**
|
|
312
|
+
* Timestamp of when the connected organization was created.
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof ConnectedOrganization
|
|
315
|
+
*/
|
|
316
|
+
'created_at': string;
|
|
317
|
+
/**
|
|
318
|
+
*
|
|
319
|
+
* @type {ConnectedOrganizationOrganization}
|
|
320
|
+
* @memberof ConnectedOrganization
|
|
321
|
+
*/
|
|
322
|
+
'organization'?: ConnectedOrganizationOrganization | null;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @export
|
|
327
|
+
* @interface ConnectedOrganizationMember
|
|
328
|
+
*/
|
|
329
|
+
export interface ConnectedOrganizationMember {
|
|
330
|
+
/**
|
|
331
|
+
* Tremendous\' identifier for the connected organization member.
|
|
332
|
+
* @type {string}
|
|
333
|
+
* @memberof ConnectedOrganizationMember
|
|
334
|
+
*/
|
|
335
|
+
'id': string;
|
|
336
|
+
/**
|
|
337
|
+
* The name associated with the user in your systems.
|
|
338
|
+
* @type {string}
|
|
339
|
+
* @memberof ConnectedOrganizationMember
|
|
340
|
+
*/
|
|
341
|
+
'external_name'?: string | null;
|
|
342
|
+
/**
|
|
343
|
+
* The email associated with the user in your systems.
|
|
344
|
+
* @type {string}
|
|
345
|
+
* @memberof ConnectedOrganizationMember
|
|
346
|
+
*/
|
|
347
|
+
'external_email'?: string | null;
|
|
348
|
+
/**
|
|
349
|
+
* Timestamp of when the connected organization member was created.
|
|
350
|
+
* @type {string}
|
|
351
|
+
* @memberof ConnectedOrganizationMember
|
|
352
|
+
*/
|
|
353
|
+
'created_at': string;
|
|
354
|
+
/**
|
|
355
|
+
* Tremendous\' identifier for the connected organization.
|
|
356
|
+
* @type {string}
|
|
357
|
+
* @memberof ConnectedOrganizationMember
|
|
358
|
+
*/
|
|
359
|
+
'connected_organization_id': string;
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @type {ConnectedOrganizationMemberMember}
|
|
363
|
+
* @memberof ConnectedOrganizationMember
|
|
364
|
+
*/
|
|
365
|
+
'member'?: ConnectedOrganizationMemberMember | null;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Associated `member`. `null` until the registration flow for the connected organization has been completed.
|
|
369
|
+
* @export
|
|
370
|
+
* @interface ConnectedOrganizationMemberMember
|
|
371
|
+
*/
|
|
372
|
+
export interface ConnectedOrganizationMemberMember {
|
|
373
|
+
/**
|
|
374
|
+
*
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
377
|
+
*/
|
|
378
|
+
'id': string;
|
|
379
|
+
/**
|
|
380
|
+
* Email address of the member
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
383
|
+
*/
|
|
384
|
+
'email': string;
|
|
385
|
+
/**
|
|
386
|
+
* Full name of the member
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
389
|
+
*/
|
|
390
|
+
'name': string | null;
|
|
391
|
+
/**
|
|
392
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
393
|
+
* @type {boolean}
|
|
394
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
395
|
+
*/
|
|
396
|
+
'active'?: boolean;
|
|
397
|
+
/**
|
|
398
|
+
* The role ID associated with the member within the organization.
|
|
399
|
+
* @type {string}
|
|
400
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
401
|
+
*/
|
|
402
|
+
'role'?: string | null;
|
|
403
|
+
/**
|
|
404
|
+
* Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`.
|
|
405
|
+
* @type {string}
|
|
406
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
407
|
+
*/
|
|
408
|
+
'status': ConnectedOrganizationMemberMemberStatusEnum;
|
|
409
|
+
/**
|
|
410
|
+
* Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members).
|
|
411
|
+
* @type {string}
|
|
412
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
413
|
+
*/
|
|
414
|
+
'created_at'?: string;
|
|
415
|
+
/**
|
|
416
|
+
* Timestamp when this member most recently logged into the dashboard of the organization associated with this API key.
|
|
417
|
+
* @type {string}
|
|
418
|
+
* @memberof ConnectedOrganizationMemberMember
|
|
419
|
+
*/
|
|
420
|
+
'last_login_at'?: string | null;
|
|
421
|
+
}
|
|
422
|
+
export declare const ConnectedOrganizationMemberMemberStatusEnum: {
|
|
423
|
+
readonly Registered: "REGISTERED";
|
|
424
|
+
readonly Invited: "INVITED";
|
|
425
|
+
};
|
|
426
|
+
export type ConnectedOrganizationMemberMemberStatusEnum = typeof ConnectedOrganizationMemberMemberStatusEnum[keyof typeof ConnectedOrganizationMemberMemberStatusEnum];
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @export
|
|
430
|
+
* @interface ConnectedOrganizationMemberSession
|
|
431
|
+
*/
|
|
432
|
+
export interface ConnectedOrganizationMemberSession {
|
|
433
|
+
/**
|
|
434
|
+
* Tremendous\' identifier for the connected organization member.
|
|
435
|
+
* @type {string}
|
|
436
|
+
* @memberof ConnectedOrganizationMemberSession
|
|
437
|
+
*/
|
|
438
|
+
'connected_organization_member_id': string;
|
|
439
|
+
/**
|
|
440
|
+
* The URL to start the \"Tremendous for Platforms\" flow.
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof ConnectedOrganizationMemberSession
|
|
443
|
+
*/
|
|
444
|
+
'url': string;
|
|
445
|
+
/**
|
|
446
|
+
* The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous.
|
|
447
|
+
* @type {string}
|
|
448
|
+
* @memberof ConnectedOrganizationMemberSession
|
|
449
|
+
*/
|
|
450
|
+
'return_url': string;
|
|
451
|
+
/**
|
|
452
|
+
* Timestamp of when the session will expire.
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof ConnectedOrganizationMemberSession
|
|
455
|
+
*/
|
|
456
|
+
'expires_at': string;
|
|
457
|
+
/**
|
|
458
|
+
* Timestamp of when the session was created.
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof ConnectedOrganizationMemberSession
|
|
461
|
+
*/
|
|
462
|
+
'created_at': string;
|
|
463
|
+
}
|
|
464
|
+
/**
|
|
465
|
+
* Associated `organization` resource. `null` until the registration flow for the connected organization has been completed.
|
|
466
|
+
* @export
|
|
467
|
+
* @interface ConnectedOrganizationOrganization
|
|
468
|
+
*/
|
|
469
|
+
export interface ConnectedOrganizationOrganization {
|
|
470
|
+
/**
|
|
471
|
+
*
|
|
472
|
+
* @type {string}
|
|
473
|
+
* @memberof ConnectedOrganizationOrganization
|
|
474
|
+
*/
|
|
475
|
+
'id'?: string;
|
|
476
|
+
/**
|
|
477
|
+
* Name of the organization
|
|
478
|
+
* @type {string}
|
|
479
|
+
* @memberof ConnectedOrganizationOrganization
|
|
480
|
+
*/
|
|
481
|
+
'name': string;
|
|
482
|
+
/**
|
|
483
|
+
* URL of the website of that organization
|
|
484
|
+
* @type {string}
|
|
485
|
+
* @memberof ConnectedOrganizationOrganization
|
|
486
|
+
*/
|
|
487
|
+
'website': string;
|
|
488
|
+
/**
|
|
489
|
+
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
490
|
+
* @type {string}
|
|
491
|
+
* @memberof ConnectedOrganizationOrganization
|
|
492
|
+
*/
|
|
493
|
+
'status'?: ConnectedOrganizationOrganizationStatusEnum;
|
|
494
|
+
/**
|
|
495
|
+
* Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations.
|
|
496
|
+
* @type {string}
|
|
497
|
+
* @memberof ConnectedOrganizationOrganization
|
|
498
|
+
*/
|
|
499
|
+
'created_at'?: string;
|
|
500
|
+
}
|
|
501
|
+
export declare const ConnectedOrganizationOrganizationStatusEnum: {
|
|
502
|
+
readonly Pending: "PENDING";
|
|
503
|
+
readonly Approved: "APPROVED";
|
|
504
|
+
readonly Rejected: "REJECTED";
|
|
505
|
+
};
|
|
506
|
+
export type ConnectedOrganizationOrganizationStatusEnum = typeof ConnectedOrganizationOrganizationStatusEnum[keyof typeof ConnectedOrganizationOrganizationStatusEnum];
|
|
293
507
|
/**
|
|
294
508
|
*
|
|
295
509
|
* @export
|
|
@@ -306,13 +520,13 @@ export interface CreateApiKey200Response {
|
|
|
306
520
|
/**
|
|
307
521
|
*
|
|
308
522
|
* @export
|
|
309
|
-
* @interface
|
|
523
|
+
* @interface CreateCampaign200Response
|
|
310
524
|
*/
|
|
311
|
-
export interface
|
|
525
|
+
export interface CreateCampaign200Response {
|
|
312
526
|
/**
|
|
313
527
|
*
|
|
314
528
|
* @type {ListCampaigns200ResponseCampaignsInner}
|
|
315
|
-
* @memberof
|
|
529
|
+
* @memberof CreateCampaign200Response
|
|
316
530
|
*/
|
|
317
531
|
'campaign': ListCampaigns200ResponseCampaignsInner;
|
|
318
532
|
}
|
|
@@ -353,6 +567,121 @@ export interface CreateCampaignRequest {
|
|
|
353
567
|
*/
|
|
354
568
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
355
569
|
}
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @export
|
|
573
|
+
* @interface CreateConnectedOrganization200Response
|
|
574
|
+
*/
|
|
575
|
+
export interface CreateConnectedOrganization200Response {
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInner}
|
|
579
|
+
* @memberof CreateConnectedOrganization200Response
|
|
580
|
+
*/
|
|
581
|
+
'connected_organization': ListConnectedOrganizations200ResponseConnectedOrganizationsInner;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
*
|
|
585
|
+
* @export
|
|
586
|
+
* @interface CreateConnectedOrganizationMember200Response
|
|
587
|
+
*/
|
|
588
|
+
export interface CreateConnectedOrganizationMember200Response {
|
|
589
|
+
/**
|
|
590
|
+
*
|
|
591
|
+
* @type {ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner}
|
|
592
|
+
* @memberof CreateConnectedOrganizationMember200Response
|
|
593
|
+
*/
|
|
594
|
+
'connected_organization_member': ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner;
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
*
|
|
598
|
+
* @export
|
|
599
|
+
* @interface CreateConnectedOrganizationMemberRequest
|
|
600
|
+
*/
|
|
601
|
+
export interface CreateConnectedOrganizationMemberRequest {
|
|
602
|
+
/**
|
|
603
|
+
* The ID of the connected organization.
|
|
604
|
+
* @type {string}
|
|
605
|
+
* @memberof CreateConnectedOrganizationMemberRequest
|
|
606
|
+
*/
|
|
607
|
+
'connected_organization_id': string;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
*
|
|
611
|
+
* @export
|
|
612
|
+
* @interface CreateConnectedOrganizationMemberSession200Response
|
|
613
|
+
*/
|
|
614
|
+
export interface CreateConnectedOrganizationMemberSession200Response {
|
|
615
|
+
/**
|
|
616
|
+
*
|
|
617
|
+
* @type {CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession}
|
|
618
|
+
* @memberof CreateConnectedOrganizationMemberSession200Response
|
|
619
|
+
*/
|
|
620
|
+
'connected_organization_member_session': CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
*
|
|
624
|
+
* @export
|
|
625
|
+
* @interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
626
|
+
*/
|
|
627
|
+
export interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession {
|
|
628
|
+
/**
|
|
629
|
+
* Tremendous\' identifier for the connected organization member.
|
|
630
|
+
* @type {string}
|
|
631
|
+
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
632
|
+
*/
|
|
633
|
+
'connected_organization_member_id': string;
|
|
634
|
+
/**
|
|
635
|
+
* The URL to start the \"Tremendous for Platforms\" flow.
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
638
|
+
*/
|
|
639
|
+
'url': string;
|
|
640
|
+
/**
|
|
641
|
+
* The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous.
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
644
|
+
*/
|
|
645
|
+
'return_url': string;
|
|
646
|
+
/**
|
|
647
|
+
* Timestamp of when the session will expire.
|
|
648
|
+
* @type {string}
|
|
649
|
+
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
650
|
+
*/
|
|
651
|
+
'expires_at': string;
|
|
652
|
+
/**
|
|
653
|
+
* Timestamp of when the session was created.
|
|
654
|
+
* @type {string}
|
|
655
|
+
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
656
|
+
*/
|
|
657
|
+
'created_at': string;
|
|
658
|
+
}
|
|
659
|
+
/**
|
|
660
|
+
*
|
|
661
|
+
* @export
|
|
662
|
+
* @interface CreateConnectedOrganizationMemberSessionRequest
|
|
663
|
+
*/
|
|
664
|
+
export interface CreateConnectedOrganizationMemberSessionRequest {
|
|
665
|
+
/**
|
|
666
|
+
* The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous.
|
|
667
|
+
* @type {string}
|
|
668
|
+
* @memberof CreateConnectedOrganizationMemberSessionRequest
|
|
669
|
+
*/
|
|
670
|
+
'return_url': string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
*
|
|
674
|
+
* @export
|
|
675
|
+
* @interface CreateConnectedOrganizationRequest
|
|
676
|
+
*/
|
|
677
|
+
export interface CreateConnectedOrganizationRequest {
|
|
678
|
+
/**
|
|
679
|
+
* The client ID of the OAuth application.
|
|
680
|
+
* @type {string}
|
|
681
|
+
* @memberof CreateConnectedOrganizationRequest
|
|
682
|
+
*/
|
|
683
|
+
'client_id': string;
|
|
684
|
+
}
|
|
356
685
|
/**
|
|
357
686
|
*
|
|
358
687
|
* @export
|
|
@@ -603,7 +932,7 @@ export interface CreateOrder200ResponseOrderRewardsInnerDelivery {
|
|
|
603
932
|
*/
|
|
604
933
|
'method': CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum;
|
|
605
934
|
/**
|
|
606
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
935
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
607
936
|
* @type {string}
|
|
608
937
|
* @memberof CreateOrder200ResponseOrderRewardsInnerDelivery
|
|
609
938
|
*/
|
|
@@ -933,70 +1262,76 @@ export interface CreateOrganizationRequestCopySettings {
|
|
|
933
1262
|
* @memberof CreateOrganizationRequestCopySettings
|
|
934
1263
|
*/
|
|
935
1264
|
'fraud_prevention'?: boolean;
|
|
1265
|
+
/**
|
|
1266
|
+
* Copy over the tax management settings, including the association with the parent tax entity, from the current organization to the new organization. Defaults to `false`.
|
|
1267
|
+
* @type {boolean}
|
|
1268
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
1269
|
+
*/
|
|
1270
|
+
'tax_management'?: boolean;
|
|
936
1271
|
}
|
|
937
1272
|
/**
|
|
938
1273
|
*
|
|
939
1274
|
* @export
|
|
940
|
-
* @interface
|
|
1275
|
+
* @interface CreateReport200Response
|
|
941
1276
|
*/
|
|
942
|
-
export interface
|
|
1277
|
+
export interface CreateReport200Response {
|
|
943
1278
|
/**
|
|
944
1279
|
*
|
|
945
|
-
* @type {
|
|
946
|
-
* @memberof
|
|
1280
|
+
* @type {CreateReport200ResponseReport}
|
|
1281
|
+
* @memberof CreateReport200Response
|
|
947
1282
|
*/
|
|
948
|
-
'report':
|
|
1283
|
+
'report': CreateReport200ResponseReport;
|
|
949
1284
|
/**
|
|
950
1285
|
* Report status message
|
|
951
1286
|
* @type {string}
|
|
952
|
-
* @memberof
|
|
1287
|
+
* @memberof CreateReport200Response
|
|
953
1288
|
*/
|
|
954
1289
|
'message'?: string;
|
|
955
1290
|
}
|
|
956
1291
|
/**
|
|
957
1292
|
* Reports represent a collection of your Tremendous data that can be filtered and downloaded. The report object that is returned has a unique ID, a status, and an predicted time of report generation completion. When the report generation is complete, it will also contain an expiring url where you can retrieve your report.
|
|
958
1293
|
* @export
|
|
959
|
-
* @interface
|
|
1294
|
+
* @interface CreateReport200ResponseReport
|
|
960
1295
|
*/
|
|
961
|
-
export interface
|
|
1296
|
+
export interface CreateReport200ResponseReport {
|
|
962
1297
|
/**
|
|
963
1298
|
* Tremendous ID of the report, used to retrieve your report
|
|
964
1299
|
* @type {string}
|
|
965
|
-
* @memberof
|
|
1300
|
+
* @memberof CreateReport200ResponseReport
|
|
966
1301
|
*/
|
|
967
1302
|
'id'?: string;
|
|
968
1303
|
/**
|
|
969
1304
|
* Status of this report <table> <thead> <tr> <th>Status</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>CREATED</code></td> <td>Report has been created</td> </tr> <tr> <td><code>PROCESSING</code></td> <td>Report is currently being generated</td> </tr> <tr> <td><code>READY_FOR_DOWNLOAD</code></td> <td>Report generation is complete and ready for download</td> </tr> <tr> <td><code>FAILED</code></td> <td>Report failed to generate</td> </tr> </tbody> </table>
|
|
970
1305
|
* @type {string}
|
|
971
|
-
* @memberof
|
|
1306
|
+
* @memberof CreateReport200ResponseReport
|
|
972
1307
|
*/
|
|
973
|
-
'status'?:
|
|
1308
|
+
'status'?: CreateReport200ResponseReportStatusEnum;
|
|
974
1309
|
/**
|
|
975
1310
|
* Timestamp of when the report was created
|
|
976
1311
|
* @type {string}
|
|
977
|
-
* @memberof
|
|
1312
|
+
* @memberof CreateReport200ResponseReport
|
|
978
1313
|
*/
|
|
979
1314
|
'created_at'?: string;
|
|
980
1315
|
/**
|
|
981
|
-
* Timestamp of when the report is expected to finish generating. If the report
|
|
1316
|
+
* Timestamp of when the report is expected to finish generating. If the report is complete, this will return the time the report completed generating at.
|
|
982
1317
|
* @type {string}
|
|
983
|
-
* @memberof
|
|
1318
|
+
* @memberof CreateReport200ResponseReport
|
|
984
1319
|
*/
|
|
985
1320
|
'expected_completion_at'?: string;
|
|
986
1321
|
/**
|
|
987
1322
|
* URL to download the report. Only returned when the report generation is complete and report is ready for download. URL is valid for 7 days from generation completion
|
|
988
1323
|
* @type {string}
|
|
989
|
-
* @memberof
|
|
1324
|
+
* @memberof CreateReport200ResponseReport
|
|
990
1325
|
*/
|
|
991
1326
|
'url'?: string | null;
|
|
992
1327
|
}
|
|
993
|
-
export declare const
|
|
1328
|
+
export declare const CreateReport200ResponseReportStatusEnum: {
|
|
994
1329
|
readonly Created: "CREATED";
|
|
995
1330
|
readonly Processing: "PROCESSING";
|
|
996
1331
|
readonly ReadyForDownload: "READY_FOR_DOWNLOAD";
|
|
997
1332
|
readonly Failed: "FAILED";
|
|
998
1333
|
};
|
|
999
|
-
export type
|
|
1334
|
+
export type CreateReport200ResponseReportStatusEnum = typeof CreateReport200ResponseReportStatusEnum[keyof typeof CreateReport200ResponseReportStatusEnum];
|
|
1000
1335
|
/**
|
|
1001
1336
|
*
|
|
1002
1337
|
* @export
|
|
@@ -1359,7 +1694,7 @@ export interface DeliveryDetails {
|
|
|
1359
1694
|
*/
|
|
1360
1695
|
'method'?: DeliveryDetailsMethodEnum;
|
|
1361
1696
|
/**
|
|
1362
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
1697
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
1363
1698
|
* @type {string}
|
|
1364
1699
|
* @memberof DeliveryDetails
|
|
1365
1700
|
*/
|
|
@@ -1391,7 +1726,7 @@ export interface DeliveryDetailsWithLink {
|
|
|
1391
1726
|
*/
|
|
1392
1727
|
'method': DeliveryDetailsWithLinkMethodEnum;
|
|
1393
1728
|
/**
|
|
1394
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
1729
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
1395
1730
|
* @type {string}
|
|
1396
1731
|
* @memberof DeliveryDetailsWithLink
|
|
1397
1732
|
*/
|
|
@@ -1416,6 +1751,31 @@ export declare const DeliveryDetailsWithLinkStatusEnum: {
|
|
|
1416
1751
|
readonly Pending: "PENDING";
|
|
1417
1752
|
};
|
|
1418
1753
|
export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum];
|
|
1754
|
+
/**
|
|
1755
|
+
* Customizable reward delivery metadata, taking precedence over the related campaign settings.
|
|
1756
|
+
* @export
|
|
1757
|
+
* @interface DeliveryMetadata
|
|
1758
|
+
*/
|
|
1759
|
+
export interface DeliveryMetadata {
|
|
1760
|
+
/**
|
|
1761
|
+
* The \"sender name\" used in the delivery. If it\'s an email reward, \"via Tremendous\" will be appended to the value. Please note that you cannot customize the sender email.
|
|
1762
|
+
* @type {string}
|
|
1763
|
+
* @memberof DeliveryMetadata
|
|
1764
|
+
*/
|
|
1765
|
+
'sender_name'?: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* The subject line used in the delivery.
|
|
1768
|
+
* @type {string}
|
|
1769
|
+
* @memberof DeliveryMetadata
|
|
1770
|
+
*/
|
|
1771
|
+
'subject_line'?: string;
|
|
1772
|
+
/**
|
|
1773
|
+
* The content of the message of the reward, shown in the email / SMS and on the landing page.
|
|
1774
|
+
* @type {string}
|
|
1775
|
+
* @memberof DeliveryMetadata
|
|
1776
|
+
*/
|
|
1777
|
+
'message'?: string;
|
|
1778
|
+
}
|
|
1419
1779
|
/**
|
|
1420
1780
|
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
1421
1781
|
* @export
|
|
@@ -1428,7 +1788,7 @@ export declare const DeliveryMethod: {
|
|
|
1428
1788
|
};
|
|
1429
1789
|
export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
|
|
1430
1790
|
/**
|
|
1431
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
1791
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
1432
1792
|
* @export
|
|
1433
1793
|
* @enum {string}
|
|
1434
1794
|
*/
|
|
@@ -1673,7 +2033,7 @@ export interface FraudReview {
|
|
|
1673
2033
|
*/
|
|
1674
2034
|
'risk'?: FraudReviewRiskEnum;
|
|
1675
2035
|
/**
|
|
1676
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
2036
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
1677
2037
|
* @type {Array<string>}
|
|
1678
2038
|
* @memberof FraudReview
|
|
1679
2039
|
*/
|
|
@@ -1754,6 +2114,7 @@ export declare const FraudReviewReasonsEnum: {
|
|
|
1754
2114
|
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1755
2115
|
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1756
2116
|
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
2117
|
+
readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
|
|
1757
2118
|
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1758
2119
|
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1759
2120
|
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
@@ -1809,7 +2170,7 @@ export interface FraudReviewListItem {
|
|
|
1809
2170
|
*/
|
|
1810
2171
|
'status'?: FraudReviewListItemStatusEnum;
|
|
1811
2172
|
/**
|
|
1812
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
2173
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
1813
2174
|
* @type {Array<string>}
|
|
1814
2175
|
* @memberof FraudReviewListItem
|
|
1815
2176
|
*/
|
|
@@ -1842,6 +2203,7 @@ export declare const FraudReviewListItemReasonsEnum: {
|
|
|
1842
2203
|
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1843
2204
|
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1844
2205
|
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
2206
|
+
readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
|
|
1845
2207
|
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1846
2208
|
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1847
2209
|
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
@@ -1870,6 +2232,7 @@ export declare const FraudReviewReason: {
|
|
|
1870
2232
|
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1871
2233
|
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1872
2234
|
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
2235
|
+
readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
|
|
1873
2236
|
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1874
2237
|
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1875
2238
|
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
@@ -2144,6 +2507,18 @@ export interface FundingSource {
|
|
|
2144
2507
|
* @memberof FundingSource
|
|
2145
2508
|
*/
|
|
2146
2509
|
'method': FundingSourceMethodEnum;
|
|
2510
|
+
/**
|
|
2511
|
+
* Indicates the level of access granted for using this funding source. Permissions is an array containing the following: * `api_orders` * `dashboard_orders` * `balance_funding`
|
|
2512
|
+
* @type {Array<string>}
|
|
2513
|
+
* @memberof FundingSource
|
|
2514
|
+
*/
|
|
2515
|
+
'usage_permissions'?: Array<FundingSourceUsagePermissionsEnum>;
|
|
2516
|
+
/**
|
|
2517
|
+
* Status of the funding_source
|
|
2518
|
+
* @type {string}
|
|
2519
|
+
* @memberof FundingSource
|
|
2520
|
+
*/
|
|
2521
|
+
'status'?: FundingSourceStatusEnum;
|
|
2147
2522
|
/**
|
|
2148
2523
|
* **Only available when `method` is set to `invoice`.**
|
|
2149
2524
|
* @type {string}
|
|
@@ -2164,6 +2539,19 @@ export declare const FundingSourceMethodEnum: {
|
|
|
2164
2539
|
readonly Invoice: "invoice";
|
|
2165
2540
|
};
|
|
2166
2541
|
export type FundingSourceMethodEnum = typeof FundingSourceMethodEnum[keyof typeof FundingSourceMethodEnum];
|
|
2542
|
+
export declare const FundingSourceUsagePermissionsEnum: {
|
|
2543
|
+
readonly ApiOrders: "api_orders";
|
|
2544
|
+
readonly DashboardOrders: "dashboard_orders";
|
|
2545
|
+
readonly BalanceFunding: "balance_funding";
|
|
2546
|
+
};
|
|
2547
|
+
export type FundingSourceUsagePermissionsEnum = typeof FundingSourceUsagePermissionsEnum[keyof typeof FundingSourceUsagePermissionsEnum];
|
|
2548
|
+
export declare const FundingSourceStatusEnum: {
|
|
2549
|
+
readonly Active: "active";
|
|
2550
|
+
readonly Deleted: "deleted";
|
|
2551
|
+
readonly PendingConfirmation: "pending_confirmation";
|
|
2552
|
+
readonly Failed: "failed";
|
|
2553
|
+
};
|
|
2554
|
+
export type FundingSourceStatusEnum = typeof FundingSourceStatusEnum[keyof typeof FundingSourceStatusEnum];
|
|
2167
2555
|
export declare const FundingSourceTypeEnum: {
|
|
2168
2556
|
readonly Commercial: "COMMERCIAL";
|
|
2169
2557
|
readonly ProForma: "PRO_FORMA";
|
|
@@ -2221,44 +2609,6 @@ export interface GenerateRewardLink403Response {
|
|
|
2221
2609
|
*/
|
|
2222
2610
|
'errors': ListRewards401ResponseErrors;
|
|
2223
2611
|
}
|
|
2224
|
-
/**
|
|
2225
|
-
*
|
|
2226
|
-
* @export
|
|
2227
|
-
* @interface GenerateRewardToken200Response
|
|
2228
|
-
*/
|
|
2229
|
-
export interface GenerateRewardToken200Response {
|
|
2230
|
-
/**
|
|
2231
|
-
*
|
|
2232
|
-
* @type {GenerateRewardToken200ResponseReward}
|
|
2233
|
-
* @memberof GenerateRewardToken200Response
|
|
2234
|
-
*/
|
|
2235
|
-
'reward': GenerateRewardToken200ResponseReward;
|
|
2236
|
-
}
|
|
2237
|
-
/**
|
|
2238
|
-
* The redemption token for a reward.
|
|
2239
|
-
* @export
|
|
2240
|
-
* @interface GenerateRewardToken200ResponseReward
|
|
2241
|
-
*/
|
|
2242
|
-
export interface GenerateRewardToken200ResponseReward {
|
|
2243
|
-
/**
|
|
2244
|
-
* Tremendous ID of the reward
|
|
2245
|
-
* @type {string}
|
|
2246
|
-
* @memberof GenerateRewardToken200ResponseReward
|
|
2247
|
-
*/
|
|
2248
|
-
'id'?: string;
|
|
2249
|
-
/**
|
|
2250
|
-
* The token to redeem the reward.
|
|
2251
|
-
* @type {string}
|
|
2252
|
-
* @memberof GenerateRewardToken200ResponseReward
|
|
2253
|
-
*/
|
|
2254
|
-
'token'?: string;
|
|
2255
|
-
/**
|
|
2256
|
-
* Date the token expires
|
|
2257
|
-
* @type {string}
|
|
2258
|
-
* @memberof GenerateRewardToken200ResponseReward
|
|
2259
|
-
*/
|
|
2260
|
-
'expires_at'?: string;
|
|
2261
|
-
}
|
|
2262
2612
|
/**
|
|
2263
2613
|
*
|
|
2264
2614
|
* @export
|
|
@@ -2291,7 +2641,7 @@ export interface GetFraudReview200ResponseFraudReview {
|
|
|
2291
2641
|
*/
|
|
2292
2642
|
'risk'?: GetFraudReview200ResponseFraudReviewRiskEnum;
|
|
2293
2643
|
/**
|
|
2294
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
2644
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
2295
2645
|
* @type {Array<string>}
|
|
2296
2646
|
* @memberof GetFraudReview200ResponseFraudReview
|
|
2297
2647
|
*/
|
|
@@ -2372,6 +2722,7 @@ export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
|
|
|
2372
2722
|
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
2373
2723
|
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
2374
2724
|
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
2725
|
+
readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
|
|
2375
2726
|
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
2376
2727
|
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
2377
2728
|
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
@@ -2874,7 +3225,7 @@ export interface ListCampaigns200ResponseCampaignsInnerEmailStyle {
|
|
|
2874
3225
|
*/
|
|
2875
3226
|
'logo_image_height_px'?: number | null;
|
|
2876
3227
|
/**
|
|
2877
|
-
* Logo
|
|
3228
|
+
* Logo background color code (hex, rgb, or rgba)
|
|
2878
3229
|
* @type {string}
|
|
2879
3230
|
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
2880
3231
|
*/
|
|
@@ -2917,18 +3268,233 @@ export interface ListCampaigns200ResponseCampaignsInnerWebpageStyle {
|
|
|
2917
3268
|
*/
|
|
2918
3269
|
'logo_image_height_px'?: number | null;
|
|
2919
3270
|
/**
|
|
2920
|
-
* Logo
|
|
3271
|
+
* Logo background color code (hex, rgb, or rgba)
|
|
2921
3272
|
* @type {string}
|
|
2922
3273
|
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
2923
3274
|
*/
|
|
2924
3275
|
'logo_background_color'?: string | null;
|
|
2925
3276
|
/**
|
|
2926
|
-
*
|
|
3277
|
+
* Background color code (hex, rgb, or rgba)
|
|
3278
|
+
* @type {string}
|
|
3279
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
3280
|
+
*/
|
|
3281
|
+
'background_color'?: string | null;
|
|
3282
|
+
}
|
|
3283
|
+
/**
|
|
3284
|
+
*
|
|
3285
|
+
* @export
|
|
3286
|
+
* @interface ListConnectedOrganizationMembers200Response
|
|
3287
|
+
*/
|
|
3288
|
+
export interface ListConnectedOrganizationMembers200Response {
|
|
3289
|
+
/**
|
|
3290
|
+
*
|
|
3291
|
+
* @type {Array<ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner>}
|
|
3292
|
+
* @memberof ListConnectedOrganizationMembers200Response
|
|
3293
|
+
*/
|
|
3294
|
+
'connected_organization_members': Array<ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner>;
|
|
3295
|
+
/**
|
|
3296
|
+
* The total number of connected organizations across all pages
|
|
3297
|
+
* @type {number}
|
|
3298
|
+
* @memberof ListConnectedOrganizationMembers200Response
|
|
3299
|
+
*/
|
|
3300
|
+
'total_count': number;
|
|
3301
|
+
}
|
|
3302
|
+
/**
|
|
3303
|
+
*
|
|
3304
|
+
* @export
|
|
3305
|
+
* @interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3306
|
+
*/
|
|
3307
|
+
export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner {
|
|
3308
|
+
/**
|
|
3309
|
+
* Tremendous\' identifier for the connected organization member.
|
|
3310
|
+
* @type {string}
|
|
3311
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3312
|
+
*/
|
|
3313
|
+
'id': string;
|
|
3314
|
+
/**
|
|
3315
|
+
* The name associated with the user in your systems.
|
|
3316
|
+
* @type {string}
|
|
3317
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3318
|
+
*/
|
|
3319
|
+
'external_name'?: string | null;
|
|
3320
|
+
/**
|
|
3321
|
+
* The email associated with the user in your systems.
|
|
3322
|
+
* @type {string}
|
|
3323
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3324
|
+
*/
|
|
3325
|
+
'external_email'?: string | null;
|
|
3326
|
+
/**
|
|
3327
|
+
* Timestamp of when the connected organization member was created.
|
|
3328
|
+
* @type {string}
|
|
3329
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3330
|
+
*/
|
|
3331
|
+
'created_at': string;
|
|
3332
|
+
/**
|
|
3333
|
+
* Tremendous\' identifier for the connected organization.
|
|
3334
|
+
* @type {string}
|
|
3335
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3336
|
+
*/
|
|
3337
|
+
'connected_organization_id': string;
|
|
3338
|
+
/**
|
|
3339
|
+
*
|
|
3340
|
+
* @type {ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember}
|
|
3341
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner
|
|
3342
|
+
*/
|
|
3343
|
+
'member'?: ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember | null;
|
|
3344
|
+
}
|
|
3345
|
+
/**
|
|
3346
|
+
* Associated `member`. `null` until the registration flow for the connected organization has been completed.
|
|
3347
|
+
* @export
|
|
3348
|
+
* @interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3349
|
+
*/
|
|
3350
|
+
export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember {
|
|
3351
|
+
/**
|
|
3352
|
+
*
|
|
3353
|
+
* @type {string}
|
|
3354
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3355
|
+
*/
|
|
3356
|
+
'id': string;
|
|
3357
|
+
/**
|
|
3358
|
+
* Email address of the member
|
|
3359
|
+
* @type {string}
|
|
3360
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3361
|
+
*/
|
|
3362
|
+
'email': string;
|
|
3363
|
+
/**
|
|
3364
|
+
* Full name of the member
|
|
3365
|
+
* @type {string}
|
|
3366
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3367
|
+
*/
|
|
3368
|
+
'name': string | null;
|
|
3369
|
+
/**
|
|
3370
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
3371
|
+
* @type {boolean}
|
|
3372
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3373
|
+
*/
|
|
3374
|
+
'active'?: boolean;
|
|
3375
|
+
/**
|
|
3376
|
+
* The role ID associated with the member within the organization.
|
|
3377
|
+
* @type {string}
|
|
3378
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3379
|
+
*/
|
|
3380
|
+
'role'?: string | null;
|
|
3381
|
+
/**
|
|
3382
|
+
* Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`.
|
|
3383
|
+
* @type {string}
|
|
3384
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3385
|
+
*/
|
|
3386
|
+
'status': ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum;
|
|
3387
|
+
/**
|
|
3388
|
+
* Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members).
|
|
3389
|
+
* @type {string}
|
|
3390
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3391
|
+
*/
|
|
3392
|
+
'created_at'?: string;
|
|
3393
|
+
/**
|
|
3394
|
+
* Timestamp when this member most recently logged into the dashboard of the organization associated with this API key.
|
|
3395
|
+
* @type {string}
|
|
3396
|
+
* @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember
|
|
3397
|
+
*/
|
|
3398
|
+
'last_login_at'?: string | null;
|
|
3399
|
+
}
|
|
3400
|
+
export declare const ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum: {
|
|
3401
|
+
readonly Registered: "REGISTERED";
|
|
3402
|
+
readonly Invited: "INVITED";
|
|
3403
|
+
};
|
|
3404
|
+
export type ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum[keyof typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum];
|
|
3405
|
+
/**
|
|
3406
|
+
*
|
|
3407
|
+
* @export
|
|
3408
|
+
* @interface ListConnectedOrganizations200Response
|
|
3409
|
+
*/
|
|
3410
|
+
export interface ListConnectedOrganizations200Response {
|
|
3411
|
+
/**
|
|
3412
|
+
*
|
|
3413
|
+
* @type {Array<ListConnectedOrganizations200ResponseConnectedOrganizationsInner>}
|
|
3414
|
+
* @memberof ListConnectedOrganizations200Response
|
|
3415
|
+
*/
|
|
3416
|
+
'connected_organizations': Array<ListConnectedOrganizations200ResponseConnectedOrganizationsInner>;
|
|
3417
|
+
/**
|
|
3418
|
+
* The total number of connected organizations across all pages
|
|
3419
|
+
* @type {number}
|
|
3420
|
+
* @memberof ListConnectedOrganizations200Response
|
|
3421
|
+
*/
|
|
3422
|
+
'total_count': number;
|
|
3423
|
+
}
|
|
3424
|
+
/**
|
|
3425
|
+
*
|
|
3426
|
+
* @export
|
|
3427
|
+
* @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInner
|
|
3428
|
+
*/
|
|
3429
|
+
export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInner {
|
|
3430
|
+
/**
|
|
3431
|
+
* Tremendous\' identifier for the connected organization.
|
|
3432
|
+
* @type {string}
|
|
3433
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
|
|
3434
|
+
*/
|
|
3435
|
+
'id': string;
|
|
3436
|
+
/**
|
|
3437
|
+
* Client ID of the OAuth app that is to be used by the platform once the integration is complete.
|
|
3438
|
+
* @type {string}
|
|
3439
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
|
|
3440
|
+
*/
|
|
3441
|
+
'client_id': string;
|
|
3442
|
+
/**
|
|
3443
|
+
* Timestamp of when the connected organization was created.
|
|
3444
|
+
* @type {string}
|
|
3445
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
|
|
3446
|
+
*/
|
|
3447
|
+
'created_at': string;
|
|
3448
|
+
/**
|
|
3449
|
+
*
|
|
3450
|
+
* @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization}
|
|
3451
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
|
|
3452
|
+
*/
|
|
3453
|
+
'organization'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization | null;
|
|
3454
|
+
}
|
|
3455
|
+
/**
|
|
3456
|
+
* Associated `organization` resource. `null` until the registration flow for the connected organization has been completed.
|
|
3457
|
+
* @export
|
|
3458
|
+
* @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3459
|
+
*/
|
|
3460
|
+
export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization {
|
|
3461
|
+
/**
|
|
3462
|
+
*
|
|
3463
|
+
* @type {string}
|
|
3464
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3465
|
+
*/
|
|
3466
|
+
'id'?: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Name of the organization
|
|
3469
|
+
* @type {string}
|
|
3470
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3471
|
+
*/
|
|
3472
|
+
'name': string;
|
|
3473
|
+
/**
|
|
3474
|
+
* URL of the website of that organization
|
|
3475
|
+
* @type {string}
|
|
3476
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3477
|
+
*/
|
|
3478
|
+
'website': string;
|
|
3479
|
+
/**
|
|
3480
|
+
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
3481
|
+
* @type {string}
|
|
3482
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3483
|
+
*/
|
|
3484
|
+
'status'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum;
|
|
3485
|
+
/**
|
|
3486
|
+
* Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations.
|
|
2927
3487
|
* @type {string}
|
|
2928
|
-
* @memberof
|
|
3488
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
2929
3489
|
*/
|
|
2930
|
-
'
|
|
3490
|
+
'created_at'?: string;
|
|
2931
3491
|
}
|
|
3492
|
+
export declare const ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum: {
|
|
3493
|
+
readonly Pending: "PENDING";
|
|
3494
|
+
readonly Approved: "APPROVED";
|
|
3495
|
+
readonly Rejected: "REJECTED";
|
|
3496
|
+
};
|
|
3497
|
+
export type ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum[keyof typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum];
|
|
2932
3498
|
/**
|
|
2933
3499
|
*
|
|
2934
3500
|
* @export
|
|
@@ -3034,7 +3600,7 @@ export interface ListFraudReviews200ResponseFraudReviewsInner {
|
|
|
3034
3600
|
*/
|
|
3035
3601
|
'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
|
|
3036
3602
|
/**
|
|
3037
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
3603
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
3038
3604
|
* @type {Array<string>}
|
|
3039
3605
|
* @memberof ListFraudReviews200ResponseFraudReviewsInner
|
|
3040
3606
|
*/
|
|
@@ -3067,6 +3633,7 @@ export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
|
|
|
3067
3633
|
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
3068
3634
|
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
3069
3635
|
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
3636
|
+
readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
|
|
3070
3637
|
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
3071
3638
|
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
3072
3639
|
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
@@ -3154,6 +3721,18 @@ export interface ListFundingSources200ResponseFundingSourcesInner {
|
|
|
3154
3721
|
* @memberof ListFundingSources200ResponseFundingSourcesInner
|
|
3155
3722
|
*/
|
|
3156
3723
|
'method': ListFundingSources200ResponseFundingSourcesInnerMethodEnum;
|
|
3724
|
+
/**
|
|
3725
|
+
* Indicates the level of access granted for using this funding source. Permissions is an array containing the following: * `api_orders` * `dashboard_orders` * `balance_funding`
|
|
3726
|
+
* @type {Array<string>}
|
|
3727
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInner
|
|
3728
|
+
*/
|
|
3729
|
+
'usage_permissions'?: Array<ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum>;
|
|
3730
|
+
/**
|
|
3731
|
+
* Status of the funding_source
|
|
3732
|
+
* @type {string}
|
|
3733
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInner
|
|
3734
|
+
*/
|
|
3735
|
+
'status'?: ListFundingSources200ResponseFundingSourcesInnerStatusEnum;
|
|
3157
3736
|
/**
|
|
3158
3737
|
* **Only available when `method` is set to `invoice`.**
|
|
3159
3738
|
* @type {string}
|
|
@@ -3174,6 +3753,19 @@ export declare const ListFundingSources200ResponseFundingSourcesInnerMethodEnum:
|
|
|
3174
3753
|
readonly Invoice: "invoice";
|
|
3175
3754
|
};
|
|
3176
3755
|
export type ListFundingSources200ResponseFundingSourcesInnerMethodEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum];
|
|
3756
|
+
export declare const ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum: {
|
|
3757
|
+
readonly ApiOrders: "api_orders";
|
|
3758
|
+
readonly DashboardOrders: "dashboard_orders";
|
|
3759
|
+
readonly BalanceFunding: "balance_funding";
|
|
3760
|
+
};
|
|
3761
|
+
export type ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum];
|
|
3762
|
+
export declare const ListFundingSources200ResponseFundingSourcesInnerStatusEnum: {
|
|
3763
|
+
readonly Active: "active";
|
|
3764
|
+
readonly Deleted: "deleted";
|
|
3765
|
+
readonly PendingConfirmation: "pending_confirmation";
|
|
3766
|
+
readonly Failed: "failed";
|
|
3767
|
+
};
|
|
3768
|
+
export type ListFundingSources200ResponseFundingSourcesInnerStatusEnum = typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum];
|
|
3177
3769
|
export declare const ListFundingSources200ResponseFundingSourcesInnerTypeEnum: {
|
|
3178
3770
|
readonly Commercial: "COMMERCIAL";
|
|
3179
3771
|
readonly ProForma: "PRO_FORMA";
|
|
@@ -3693,7 +4285,7 @@ export interface ListProductsResponse {
|
|
|
3693
4285
|
'products': Array<ListProductsResponseProductsInner>;
|
|
3694
4286
|
}
|
|
3695
4287
|
/**
|
|
3696
|
-
* A product represents one way to payout a reward to
|
|
4288
|
+
* A product represents one way to payout a reward to its recipient. Think: * Amazon.com gift card (ID: `OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](https://www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details.
|
|
3697
4289
|
* @export
|
|
3698
4290
|
* @interface ListProductsResponseProductsInner
|
|
3699
4291
|
*/
|
|
@@ -3717,7 +4309,7 @@ export interface ListProductsResponseProductsInner {
|
|
|
3717
4309
|
*/
|
|
3718
4310
|
'description': string;
|
|
3719
4311
|
/**
|
|
3720
|
-
* The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>
|
|
4312
|
+
* The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>
|
|
3721
4313
|
* @type {string}
|
|
3722
4314
|
* @memberof ListProductsResponseProductsInner
|
|
3723
4315
|
*/
|
|
@@ -3729,7 +4321,7 @@ export interface ListProductsResponseProductsInner {
|
|
|
3729
4321
|
*/
|
|
3730
4322
|
'disclosure': string;
|
|
3731
4323
|
/**
|
|
3732
|
-
* Products
|
|
4324
|
+
* Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts.
|
|
3733
4325
|
* @type {Array<ListProductsResponseProductsInnerSkusInner>}
|
|
3734
4326
|
* @memberof ListProductsResponseProductsInner
|
|
3735
4327
|
*/
|
|
@@ -3752,10 +4344,23 @@ export interface ListProductsResponseProductsInner {
|
|
|
3752
4344
|
* @memberof ListProductsResponseProductsInner
|
|
3753
4345
|
*/
|
|
3754
4346
|
'images': Array<ListProductsResponseProductsInnerImagesInner>;
|
|
4347
|
+
/**
|
|
4348
|
+
* Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`.
|
|
4349
|
+
* @type {string}
|
|
4350
|
+
* @memberof ListProductsResponseProductsInner
|
|
4351
|
+
*/
|
|
4352
|
+
'usage_instructions'?: string;
|
|
4353
|
+
/**
|
|
4354
|
+
*
|
|
4355
|
+
* @type {ListProductsResponseProductsInnerDocuments}
|
|
4356
|
+
* @memberof ListProductsResponseProductsInner
|
|
4357
|
+
*/
|
|
4358
|
+
'documents'?: ListProductsResponseProductsInnerDocuments | null;
|
|
3755
4359
|
}
|
|
3756
4360
|
export declare const ListProductsResponseProductsInnerCategoryEnum: {
|
|
3757
4361
|
readonly Ach: "ach";
|
|
3758
4362
|
readonly Charity: "charity";
|
|
4363
|
+
readonly InstantDebitTransfer: "instant_debit_transfer";
|
|
3759
4364
|
readonly MerchantCard: "merchant_card";
|
|
3760
4365
|
readonly Paypal: "paypal";
|
|
3761
4366
|
readonly Venmo: "venmo";
|
|
@@ -3894,6 +4499,31 @@ export interface ListProductsResponseProductsInnerCountriesInner {
|
|
|
3894
4499
|
*/
|
|
3895
4500
|
'abbr': string;
|
|
3896
4501
|
}
|
|
4502
|
+
/**
|
|
4503
|
+
* URLs and files related to product documentation.
|
|
4504
|
+
* @export
|
|
4505
|
+
* @interface ListProductsResponseProductsInnerDocuments
|
|
4506
|
+
*/
|
|
4507
|
+
export interface ListProductsResponseProductsInnerDocuments {
|
|
4508
|
+
/**
|
|
4509
|
+
* URL to the cardholder agreement PDF file.
|
|
4510
|
+
* @type {string}
|
|
4511
|
+
* @memberof ListProductsResponseProductsInnerDocuments
|
|
4512
|
+
*/
|
|
4513
|
+
'cardholder_agreement_pdf'?: string;
|
|
4514
|
+
/**
|
|
4515
|
+
* URL to the cardholder agreement web page.
|
|
4516
|
+
* @type {string}
|
|
4517
|
+
* @memberof ListProductsResponseProductsInnerDocuments
|
|
4518
|
+
*/
|
|
4519
|
+
'cardholder_agreement_url'?: string;
|
|
4520
|
+
/**
|
|
4521
|
+
* URL to the privacy policy web page.
|
|
4522
|
+
* @type {string}
|
|
4523
|
+
* @memberof ListProductsResponseProductsInnerDocuments
|
|
4524
|
+
*/
|
|
4525
|
+
'privacy_policy_url'?: string;
|
|
4526
|
+
}
|
|
3897
4527
|
/**
|
|
3898
4528
|
*
|
|
3899
4529
|
* @export
|
|
@@ -3912,6 +4542,12 @@ export interface ListProductsResponseProductsInnerImagesInner {
|
|
|
3912
4542
|
* @memberof ListProductsResponseProductsInnerImagesInner
|
|
3913
4543
|
*/
|
|
3914
4544
|
'type': ListProductsResponseProductsInnerImagesInnerTypeEnum;
|
|
4545
|
+
/**
|
|
4546
|
+
* The MIME content type of this image
|
|
4547
|
+
* @type {string}
|
|
4548
|
+
* @memberof ListProductsResponseProductsInnerImagesInner
|
|
4549
|
+
*/
|
|
4550
|
+
'content_type'?: string | null;
|
|
3915
4551
|
}
|
|
3916
4552
|
export declare const ListProductsResponseProductsInnerImagesInnerTypeEnum: {
|
|
3917
4553
|
readonly Card: "card";
|
|
@@ -4049,7 +4685,7 @@ export interface ListRewards200ResponseRewardsInnerDelivery {
|
|
|
4049
4685
|
*/
|
|
4050
4686
|
'method'?: ListRewards200ResponseRewardsInnerDeliveryMethodEnum;
|
|
4051
4687
|
/**
|
|
4052
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
4688
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
4053
4689
|
* @type {string}
|
|
4054
4690
|
* @memberof ListRewards200ResponseRewardsInnerDelivery
|
|
4055
4691
|
*/
|
|
@@ -5252,7 +5888,7 @@ export declare const PayoutStatusEnum: {
|
|
|
5252
5888
|
};
|
|
5253
5889
|
export type PayoutStatusEnum = typeof PayoutStatusEnum[keyof typeof PayoutStatusEnum];
|
|
5254
5890
|
/**
|
|
5255
|
-
* A product represents one way to payout a reward to
|
|
5891
|
+
* A product represents one way to payout a reward to its recipient. Think: * Amazon.com gift card (ID: `OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](https://www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details.
|
|
5256
5892
|
* @export
|
|
5257
5893
|
* @interface Product
|
|
5258
5894
|
*/
|
|
@@ -5276,7 +5912,7 @@ export interface Product {
|
|
|
5276
5912
|
*/
|
|
5277
5913
|
'description': string;
|
|
5278
5914
|
/**
|
|
5279
|
-
* The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>
|
|
5915
|
+
* The category of this product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> </tbody> </table>
|
|
5280
5916
|
* @type {string}
|
|
5281
5917
|
* @memberof Product
|
|
5282
5918
|
*/
|
|
@@ -5288,7 +5924,7 @@ export interface Product {
|
|
|
5288
5924
|
*/
|
|
5289
5925
|
'disclosure': string;
|
|
5290
5926
|
/**
|
|
5291
|
-
* Products
|
|
5927
|
+
* Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts.
|
|
5292
5928
|
* @type {Array<ListProductsResponseProductsInnerSkusInner>}
|
|
5293
5929
|
* @memberof Product
|
|
5294
5930
|
*/
|
|
@@ -5311,10 +5947,23 @@ export interface Product {
|
|
|
5311
5947
|
* @memberof Product
|
|
5312
5948
|
*/
|
|
5313
5949
|
'images': Array<ListProductsResponseProductsInnerImagesInner>;
|
|
5950
|
+
/**
|
|
5951
|
+
* Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`.
|
|
5952
|
+
* @type {string}
|
|
5953
|
+
* @memberof Product
|
|
5954
|
+
*/
|
|
5955
|
+
'usage_instructions'?: string;
|
|
5956
|
+
/**
|
|
5957
|
+
*
|
|
5958
|
+
* @type {ListProductsResponseProductsInnerDocuments}
|
|
5959
|
+
* @memberof Product
|
|
5960
|
+
*/
|
|
5961
|
+
'documents'?: ListProductsResponseProductsInnerDocuments | null;
|
|
5314
5962
|
}
|
|
5315
5963
|
export declare const ProductCategoryEnum: {
|
|
5316
5964
|
readonly Ach: "ach";
|
|
5317
5965
|
readonly Charity: "charity";
|
|
5966
|
+
readonly InstantDebitTransfer: "instant_debit_transfer";
|
|
5318
5967
|
readonly MerchantCard: "merchant_card";
|
|
5319
5968
|
readonly Paypal: "paypal";
|
|
5320
5969
|
readonly Venmo: "venmo";
|
|
@@ -5440,6 +6089,31 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
5440
6089
|
readonly Zmk: "ZMK";
|
|
5441
6090
|
};
|
|
5442
6091
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
6092
|
+
/**
|
|
6093
|
+
* URLs and files related to product documentation.
|
|
6094
|
+
* @export
|
|
6095
|
+
* @interface ProductDocuments
|
|
6096
|
+
*/
|
|
6097
|
+
export interface ProductDocuments {
|
|
6098
|
+
/**
|
|
6099
|
+
* URL to the cardholder agreement PDF file.
|
|
6100
|
+
* @type {string}
|
|
6101
|
+
* @memberof ProductDocuments
|
|
6102
|
+
*/
|
|
6103
|
+
'cardholder_agreement_pdf'?: string;
|
|
6104
|
+
/**
|
|
6105
|
+
* URL to the cardholder agreement web page.
|
|
6106
|
+
* @type {string}
|
|
6107
|
+
* @memberof ProductDocuments
|
|
6108
|
+
*/
|
|
6109
|
+
'cardholder_agreement_url'?: string;
|
|
6110
|
+
/**
|
|
6111
|
+
* URL to the privacy policy web page.
|
|
6112
|
+
* @type {string}
|
|
6113
|
+
* @memberof ProductDocuments
|
|
6114
|
+
*/
|
|
6115
|
+
'privacy_policy_url'?: string;
|
|
6116
|
+
}
|
|
5443
6117
|
/**
|
|
5444
6118
|
* Details of the recipient of the reward
|
|
5445
6119
|
* @export
|
|
@@ -5503,7 +6177,7 @@ export interface Report {
|
|
|
5503
6177
|
*/
|
|
5504
6178
|
'created_at'?: string;
|
|
5505
6179
|
/**
|
|
5506
|
-
* Timestamp of when the report is expected to finish generating. If the report
|
|
6180
|
+
* Timestamp of when the report is expected to finish generating. If the report is complete, this will return the time the report completed generating at.
|
|
5507
6181
|
* @type {string}
|
|
5508
6182
|
* @memberof Report
|
|
5509
6183
|
*/
|
|
@@ -6205,7 +6879,7 @@ export interface RewardWithLinkDelivery {
|
|
|
6205
6879
|
*/
|
|
6206
6880
|
'method': RewardWithLinkDeliveryMethodEnum;
|
|
6207
6881
|
/**
|
|
6208
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
6882
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
6209
6883
|
* @type {string}
|
|
6210
6884
|
* @memberof RewardWithLinkDelivery
|
|
6211
6885
|
*/
|
|
@@ -6310,7 +6984,7 @@ export interface RewardWithoutLinkDelivery {
|
|
|
6310
6984
|
*/
|
|
6311
6985
|
'method'?: RewardWithoutLinkDeliveryMethodEnum;
|
|
6312
6986
|
/**
|
|
6313
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link
|
|
6987
|
+
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
6314
6988
|
* @type {string}
|
|
6315
6989
|
* @memberof RewardWithoutLinkDelivery
|
|
6316
6990
|
*/
|
|
@@ -6491,6 +7165,12 @@ export interface SingleRewardOrderRewardDelivery {
|
|
|
6491
7165
|
* @memberof SingleRewardOrderRewardDelivery
|
|
6492
7166
|
*/
|
|
6493
7167
|
'method'?: SingleRewardOrderRewardDeliveryMethodEnum;
|
|
7168
|
+
/**
|
|
7169
|
+
*
|
|
7170
|
+
* @type {SingleRewardOrderRewardDeliveryMeta}
|
|
7171
|
+
* @memberof SingleRewardOrderRewardDelivery
|
|
7172
|
+
*/
|
|
7173
|
+
'meta'?: SingleRewardOrderRewardDeliveryMeta;
|
|
6494
7174
|
}
|
|
6495
7175
|
export declare const SingleRewardOrderRewardDeliveryMethodEnum: {
|
|
6496
7176
|
readonly Email: "EMAIL";
|
|
@@ -6498,6 +7178,31 @@ export declare const SingleRewardOrderRewardDeliveryMethodEnum: {
|
|
|
6498
7178
|
readonly Phone: "PHONE";
|
|
6499
7179
|
};
|
|
6500
7180
|
export type SingleRewardOrderRewardDeliveryMethodEnum = typeof SingleRewardOrderRewardDeliveryMethodEnum[keyof typeof SingleRewardOrderRewardDeliveryMethodEnum];
|
|
7181
|
+
/**
|
|
7182
|
+
* Customizable reward delivery metadata, taking precedence over the related campaign settings.
|
|
7183
|
+
* @export
|
|
7184
|
+
* @interface SingleRewardOrderRewardDeliveryMeta
|
|
7185
|
+
*/
|
|
7186
|
+
export interface SingleRewardOrderRewardDeliveryMeta {
|
|
7187
|
+
/**
|
|
7188
|
+
* The \"sender name\" used in the delivery. If it\'s an email reward, \"via Tremendous\" will be appended to the value. Please note that you cannot customize the sender email.
|
|
7189
|
+
* @type {string}
|
|
7190
|
+
* @memberof SingleRewardOrderRewardDeliveryMeta
|
|
7191
|
+
*/
|
|
7192
|
+
'sender_name'?: string;
|
|
7193
|
+
/**
|
|
7194
|
+
* The subject line used in the delivery.
|
|
7195
|
+
* @type {string}
|
|
7196
|
+
* @memberof SingleRewardOrderRewardDeliveryMeta
|
|
7197
|
+
*/
|
|
7198
|
+
'subject_line'?: string;
|
|
7199
|
+
/**
|
|
7200
|
+
* The content of the message of the reward, shown in the email / SMS and on the landing page.
|
|
7201
|
+
* @type {string}
|
|
7202
|
+
* @memberof SingleRewardOrderRewardDeliveryMeta
|
|
7203
|
+
*/
|
|
7204
|
+
'message'?: string;
|
|
7205
|
+
}
|
|
6501
7206
|
/**
|
|
6502
7207
|
*
|
|
6503
7208
|
* @export
|
|
@@ -6991,7 +7696,7 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
6991
7696
|
* @param {*} [options] Override http request option.
|
|
6992
7697
|
* @throws {RequiredError}
|
|
6993
7698
|
*/
|
|
6994
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7699
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign200Response>>;
|
|
6995
7700
|
/**
|
|
6996
7701
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
6997
7702
|
* @summary Retrieve campaign
|
|
@@ -6999,7 +7704,7 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
6999
7704
|
* @param {*} [options] Override http request option.
|
|
7000
7705
|
* @throws {RequiredError}
|
|
7001
7706
|
*/
|
|
7002
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7707
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign200Response>>;
|
|
7003
7708
|
/**
|
|
7004
7709
|
* Retrieve a list of all campaigns created in your account
|
|
7005
7710
|
* @summary List campaigns
|
|
@@ -7015,7 +7720,7 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
7015
7720
|
* @param {*} [options] Override http request option.
|
|
7016
7721
|
* @throws {RequiredError}
|
|
7017
7722
|
*/
|
|
7018
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7723
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign200Response>>;
|
|
7019
7724
|
};
|
|
7020
7725
|
/**
|
|
7021
7726
|
* CampaignsApi - factory interface
|
|
@@ -7029,7 +7734,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
7029
7734
|
* @param {*} [options] Override http request option.
|
|
7030
7735
|
* @throws {RequiredError}
|
|
7031
7736
|
*/
|
|
7032
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
7737
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign200Response>;
|
|
7033
7738
|
/**
|
|
7034
7739
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
7035
7740
|
* @summary Retrieve campaign
|
|
@@ -7037,7 +7742,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
7037
7742
|
* @param {*} [options] Override http request option.
|
|
7038
7743
|
* @throws {RequiredError}
|
|
7039
7744
|
*/
|
|
7040
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
7745
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign200Response>;
|
|
7041
7746
|
/**
|
|
7042
7747
|
* Retrieve a list of all campaigns created in your account
|
|
7043
7748
|
* @summary List campaigns
|
|
@@ -7053,7 +7758,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
7053
7758
|
* @param {*} [options] Override http request option.
|
|
7054
7759
|
* @throws {RequiredError}
|
|
7055
7760
|
*/
|
|
7056
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
7761
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign200Response>;
|
|
7057
7762
|
};
|
|
7058
7763
|
/**
|
|
7059
7764
|
* CampaignsApi - object-oriented interface
|
|
@@ -7070,7 +7775,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
7070
7775
|
* @throws {RequiredError}
|
|
7071
7776
|
* @memberof CampaignsApi
|
|
7072
7777
|
*/
|
|
7073
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7778
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign200Response, any>>;
|
|
7074
7779
|
/**
|
|
7075
7780
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
7076
7781
|
* @summary Retrieve campaign
|
|
@@ -7079,7 +7784,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
7079
7784
|
* @throws {RequiredError}
|
|
7080
7785
|
* @memberof CampaignsApi
|
|
7081
7786
|
*/
|
|
7082
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7787
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign200Response, any>>;
|
|
7083
7788
|
/**
|
|
7084
7789
|
* Retrieve a list of all campaigns created in your account
|
|
7085
7790
|
* @summary List campaigns
|
|
@@ -7097,7 +7802,306 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
7097
7802
|
* @throws {RequiredError}
|
|
7098
7803
|
* @memberof CampaignsApi
|
|
7099
7804
|
*/
|
|
7100
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7805
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign200Response, any>>;
|
|
7806
|
+
}
|
|
7807
|
+
/**
|
|
7808
|
+
* ConnectedOrganizationMembersApi - axios parameter creator
|
|
7809
|
+
* @export
|
|
7810
|
+
*/
|
|
7811
|
+
export declare const ConnectedOrganizationMembersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7812
|
+
/**
|
|
7813
|
+
* Create a connected organization member.
|
|
7814
|
+
* @summary Create connected organization member
|
|
7815
|
+
* @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create
|
|
7816
|
+
* @param {*} [options] Override http request option.
|
|
7817
|
+
* @throws {RequiredError}
|
|
7818
|
+
*/
|
|
7819
|
+
createConnectedOrganizationMember: (createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7820
|
+
/**
|
|
7821
|
+
* Create a connected organization member session.
|
|
7822
|
+
* @summary Create connected organization member session
|
|
7823
|
+
* @param {string} id ID of the connected organization member.
|
|
7824
|
+
* @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session
|
|
7825
|
+
* @param {*} [options] Override http request option.
|
|
7826
|
+
* @throws {RequiredError}
|
|
7827
|
+
*/
|
|
7828
|
+
createConnectedOrganizationMemberSession: (id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7829
|
+
/**
|
|
7830
|
+
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
7831
|
+
* @summary Retrieve a connected organization member
|
|
7832
|
+
* @param {string} id ID of the connected organization member that should be retrieved.
|
|
7833
|
+
* @param {*} [options] Override http request option.
|
|
7834
|
+
* @throws {RequiredError}
|
|
7835
|
+
*/
|
|
7836
|
+
getConnectedOrganizationMember: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7837
|
+
/**
|
|
7838
|
+
* Retrieve a list of connected organization members.
|
|
7839
|
+
* @summary List connected organization members
|
|
7840
|
+
* @param {string} connectedOrganizationId ID of the connected organization.
|
|
7841
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
7842
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
7843
|
+
* @param {*} [options] Override http request option.
|
|
7844
|
+
* @throws {RequiredError}
|
|
7845
|
+
*/
|
|
7846
|
+
listConnectedOrganizationMembers: (connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7847
|
+
};
|
|
7848
|
+
/**
|
|
7849
|
+
* ConnectedOrganizationMembersApi - functional programming interface
|
|
7850
|
+
* @export
|
|
7851
|
+
*/
|
|
7852
|
+
export declare const ConnectedOrganizationMembersApiFp: (configuration?: Configuration) => {
|
|
7853
|
+
/**
|
|
7854
|
+
* Create a connected organization member.
|
|
7855
|
+
* @summary Create connected organization member
|
|
7856
|
+
* @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create
|
|
7857
|
+
* @param {*} [options] Override http request option.
|
|
7858
|
+
* @throws {RequiredError}
|
|
7859
|
+
*/
|
|
7860
|
+
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnectedOrganizationMember200Response>>;
|
|
7861
|
+
/**
|
|
7862
|
+
* Create a connected organization member session.
|
|
7863
|
+
* @summary Create connected organization member session
|
|
7864
|
+
* @param {string} id ID of the connected organization member.
|
|
7865
|
+
* @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session
|
|
7866
|
+
* @param {*} [options] Override http request option.
|
|
7867
|
+
* @throws {RequiredError}
|
|
7868
|
+
*/
|
|
7869
|
+
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnectedOrganizationMemberSession200Response>>;
|
|
7870
|
+
/**
|
|
7871
|
+
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
7872
|
+
* @summary Retrieve a connected organization member
|
|
7873
|
+
* @param {string} id ID of the connected organization member that should be retrieved.
|
|
7874
|
+
* @param {*} [options] Override http request option.
|
|
7875
|
+
* @throws {RequiredError}
|
|
7876
|
+
*/
|
|
7877
|
+
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnectedOrganizationMember200Response>>;
|
|
7878
|
+
/**
|
|
7879
|
+
* Retrieve a list of connected organization members.
|
|
7880
|
+
* @summary List connected organization members
|
|
7881
|
+
* @param {string} connectedOrganizationId ID of the connected organization.
|
|
7882
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
7883
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
7884
|
+
* @param {*} [options] Override http request option.
|
|
7885
|
+
* @throws {RequiredError}
|
|
7886
|
+
*/
|
|
7887
|
+
listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConnectedOrganizationMembers200Response>>;
|
|
7888
|
+
};
|
|
7889
|
+
/**
|
|
7890
|
+
* ConnectedOrganizationMembersApi - factory interface
|
|
7891
|
+
* @export
|
|
7892
|
+
*/
|
|
7893
|
+
export declare const ConnectedOrganizationMembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7894
|
+
/**
|
|
7895
|
+
* Create a connected organization member.
|
|
7896
|
+
* @summary Create connected organization member
|
|
7897
|
+
* @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create
|
|
7898
|
+
* @param {*} [options] Override http request option.
|
|
7899
|
+
* @throws {RequiredError}
|
|
7900
|
+
*/
|
|
7901
|
+
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnectedOrganizationMember200Response>;
|
|
7902
|
+
/**
|
|
7903
|
+
* Create a connected organization member session.
|
|
7904
|
+
* @summary Create connected organization member session
|
|
7905
|
+
* @param {string} id ID of the connected organization member.
|
|
7906
|
+
* @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session
|
|
7907
|
+
* @param {*} [options] Override http request option.
|
|
7908
|
+
* @throws {RequiredError}
|
|
7909
|
+
*/
|
|
7910
|
+
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnectedOrganizationMemberSession200Response>;
|
|
7911
|
+
/**
|
|
7912
|
+
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
7913
|
+
* @summary Retrieve a connected organization member
|
|
7914
|
+
* @param {string} id ID of the connected organization member that should be retrieved.
|
|
7915
|
+
* @param {*} [options] Override http request option.
|
|
7916
|
+
* @throws {RequiredError}
|
|
7917
|
+
*/
|
|
7918
|
+
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnectedOrganizationMember200Response>;
|
|
7919
|
+
/**
|
|
7920
|
+
* Retrieve a list of connected organization members.
|
|
7921
|
+
* @summary List connected organization members
|
|
7922
|
+
* @param {string} connectedOrganizationId ID of the connected organization.
|
|
7923
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
7924
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
7925
|
+
* @param {*} [options] Override http request option.
|
|
7926
|
+
* @throws {RequiredError}
|
|
7927
|
+
*/
|
|
7928
|
+
listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListConnectedOrganizationMembers200Response>;
|
|
7929
|
+
};
|
|
7930
|
+
/**
|
|
7931
|
+
* ConnectedOrganizationMembersApi - object-oriented interface
|
|
7932
|
+
* @export
|
|
7933
|
+
* @class ConnectedOrganizationMembersApi
|
|
7934
|
+
* @extends {BaseAPI}
|
|
7935
|
+
*/
|
|
7936
|
+
export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
7937
|
+
/**
|
|
7938
|
+
* Create a connected organization member.
|
|
7939
|
+
* @summary Create connected organization member
|
|
7940
|
+
* @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create
|
|
7941
|
+
* @param {*} [options] Override http request option.
|
|
7942
|
+
* @throws {RequiredError}
|
|
7943
|
+
* @memberof ConnectedOrganizationMembersApi
|
|
7944
|
+
*/
|
|
7945
|
+
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnectedOrganizationMember200Response, any>>;
|
|
7946
|
+
/**
|
|
7947
|
+
* Create a connected organization member session.
|
|
7948
|
+
* @summary Create connected organization member session
|
|
7949
|
+
* @param {string} id ID of the connected organization member.
|
|
7950
|
+
* @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session
|
|
7951
|
+
* @param {*} [options] Override http request option.
|
|
7952
|
+
* @throws {RequiredError}
|
|
7953
|
+
* @memberof ConnectedOrganizationMembersApi
|
|
7954
|
+
*/
|
|
7955
|
+
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnectedOrganizationMemberSession200Response, any>>;
|
|
7956
|
+
/**
|
|
7957
|
+
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
7958
|
+
* @summary Retrieve a connected organization member
|
|
7959
|
+
* @param {string} id ID of the connected organization member that should be retrieved.
|
|
7960
|
+
* @param {*} [options] Override http request option.
|
|
7961
|
+
* @throws {RequiredError}
|
|
7962
|
+
* @memberof ConnectedOrganizationMembersApi
|
|
7963
|
+
*/
|
|
7964
|
+
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnectedOrganizationMember200Response, any>>;
|
|
7965
|
+
/**
|
|
7966
|
+
* Retrieve a list of connected organization members.
|
|
7967
|
+
* @summary List connected organization members
|
|
7968
|
+
* @param {string} connectedOrganizationId ID of the connected organization.
|
|
7969
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
7970
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
7971
|
+
* @param {*} [options] Override http request option.
|
|
7972
|
+
* @throws {RequiredError}
|
|
7973
|
+
* @memberof ConnectedOrganizationMembersApi
|
|
7974
|
+
*/
|
|
7975
|
+
listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConnectedOrganizationMembers200Response, any>>;
|
|
7976
|
+
}
|
|
7977
|
+
/**
|
|
7978
|
+
* ConnectedOrganizationsApi - axios parameter creator
|
|
7979
|
+
* @export
|
|
7980
|
+
*/
|
|
7981
|
+
export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7982
|
+
/**
|
|
7983
|
+
* Create a connected organization.
|
|
7984
|
+
* @summary Create connected organization
|
|
7985
|
+
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
7986
|
+
* @param {*} [options] Override http request option.
|
|
7987
|
+
* @throws {RequiredError}
|
|
7988
|
+
*/
|
|
7989
|
+
createConnectedOrganization: (createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7990
|
+
/**
|
|
7991
|
+
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
7992
|
+
* @summary Retrieve a connected organization
|
|
7993
|
+
* @param {string} id ID of the connected organization that should be retrieved.
|
|
7994
|
+
* @param {*} [options] Override http request option.
|
|
7995
|
+
* @throws {RequiredError}
|
|
7996
|
+
*/
|
|
7997
|
+
getConnectedOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7998
|
+
/**
|
|
7999
|
+
* Retrieve a list of connected organizations.
|
|
8000
|
+
* @summary List connected organizations
|
|
8001
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
8002
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
8003
|
+
* @param {*} [options] Override http request option.
|
|
8004
|
+
* @throws {RequiredError}
|
|
8005
|
+
*/
|
|
8006
|
+
listConnectedOrganizations: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8007
|
+
};
|
|
8008
|
+
/**
|
|
8009
|
+
* ConnectedOrganizationsApi - functional programming interface
|
|
8010
|
+
* @export
|
|
8011
|
+
*/
|
|
8012
|
+
export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration) => {
|
|
8013
|
+
/**
|
|
8014
|
+
* Create a connected organization.
|
|
8015
|
+
* @summary Create connected organization
|
|
8016
|
+
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
8017
|
+
* @param {*} [options] Override http request option.
|
|
8018
|
+
* @throws {RequiredError}
|
|
8019
|
+
*/
|
|
8020
|
+
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnectedOrganization200Response>>;
|
|
8021
|
+
/**
|
|
8022
|
+
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
8023
|
+
* @summary Retrieve a connected organization
|
|
8024
|
+
* @param {string} id ID of the connected organization that should be retrieved.
|
|
8025
|
+
* @param {*} [options] Override http request option.
|
|
8026
|
+
* @throws {RequiredError}
|
|
8027
|
+
*/
|
|
8028
|
+
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConnectedOrganization200Response>>;
|
|
8029
|
+
/**
|
|
8030
|
+
* Retrieve a list of connected organizations.
|
|
8031
|
+
* @summary List connected organizations
|
|
8032
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
8033
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
8034
|
+
* @param {*} [options] Override http request option.
|
|
8035
|
+
* @throws {RequiredError}
|
|
8036
|
+
*/
|
|
8037
|
+
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConnectedOrganizations200Response>>;
|
|
8038
|
+
};
|
|
8039
|
+
/**
|
|
8040
|
+
* ConnectedOrganizationsApi - factory interface
|
|
8041
|
+
* @export
|
|
8042
|
+
*/
|
|
8043
|
+
export declare const ConnectedOrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8044
|
+
/**
|
|
8045
|
+
* Create a connected organization.
|
|
8046
|
+
* @summary Create connected organization
|
|
8047
|
+
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
8048
|
+
* @param {*} [options] Override http request option.
|
|
8049
|
+
* @throws {RequiredError}
|
|
8050
|
+
*/
|
|
8051
|
+
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnectedOrganization200Response>;
|
|
8052
|
+
/**
|
|
8053
|
+
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
8054
|
+
* @summary Retrieve a connected organization
|
|
8055
|
+
* @param {string} id ID of the connected organization that should be retrieved.
|
|
8056
|
+
* @param {*} [options] Override http request option.
|
|
8057
|
+
* @throws {RequiredError}
|
|
8058
|
+
*/
|
|
8059
|
+
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateConnectedOrganization200Response>;
|
|
8060
|
+
/**
|
|
8061
|
+
* Retrieve a list of connected organizations.
|
|
8062
|
+
* @summary List connected organizations
|
|
8063
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
8064
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
8065
|
+
* @param {*} [options] Override http request option.
|
|
8066
|
+
* @throws {RequiredError}
|
|
8067
|
+
*/
|
|
8068
|
+
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListConnectedOrganizations200Response>;
|
|
8069
|
+
};
|
|
8070
|
+
/**
|
|
8071
|
+
* ConnectedOrganizationsApi - object-oriented interface
|
|
8072
|
+
* @export
|
|
8073
|
+
* @class ConnectedOrganizationsApi
|
|
8074
|
+
* @extends {BaseAPI}
|
|
8075
|
+
*/
|
|
8076
|
+
export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
8077
|
+
/**
|
|
8078
|
+
* Create a connected organization.
|
|
8079
|
+
* @summary Create connected organization
|
|
8080
|
+
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
8081
|
+
* @param {*} [options] Override http request option.
|
|
8082
|
+
* @throws {RequiredError}
|
|
8083
|
+
* @memberof ConnectedOrganizationsApi
|
|
8084
|
+
*/
|
|
8085
|
+
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnectedOrganization200Response, any>>;
|
|
8086
|
+
/**
|
|
8087
|
+
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
8088
|
+
* @summary Retrieve a connected organization
|
|
8089
|
+
* @param {string} id ID of the connected organization that should be retrieved.
|
|
8090
|
+
* @param {*} [options] Override http request option.
|
|
8091
|
+
* @throws {RequiredError}
|
|
8092
|
+
* @memberof ConnectedOrganizationsApi
|
|
8093
|
+
*/
|
|
8094
|
+
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConnectedOrganization200Response, any>>;
|
|
8095
|
+
/**
|
|
8096
|
+
* Retrieve a list of connected organizations.
|
|
8097
|
+
* @summary List connected organizations
|
|
8098
|
+
* @param {number} [offset] Offsets the returned list by the given number of connected organizations.
|
|
8099
|
+
* @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10.
|
|
8100
|
+
* @param {*} [options] Override http request option.
|
|
8101
|
+
* @throws {RequiredError}
|
|
8102
|
+
* @memberof ConnectedOrganizationsApi
|
|
8103
|
+
*/
|
|
8104
|
+
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConnectedOrganizations200Response, any>>;
|
|
7101
8105
|
}
|
|
7102
8106
|
/**
|
|
7103
8107
|
* FieldsApi - axios parameter creator
|
|
@@ -8062,7 +9066,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
8062
9066
|
*/
|
|
8063
9067
|
approveOrder: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8064
9068
|
/**
|
|
8065
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
9069
|
+
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
|
|
8066
9070
|
* @summary Create order
|
|
8067
9071
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
8068
9072
|
* @param {*} [options] Override http request option.
|
|
@@ -8113,7 +9117,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
8113
9117
|
*/
|
|
8114
9118
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrder200Response>>;
|
|
8115
9119
|
/**
|
|
8116
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
9120
|
+
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
|
|
8117
9121
|
* @summary Create order
|
|
8118
9122
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
8119
9123
|
* @param {*} [options] Override http request option.
|
|
@@ -8164,7 +9168,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
8164
9168
|
*/
|
|
8165
9169
|
approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrder200Response>;
|
|
8166
9170
|
/**
|
|
8167
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
9171
|
+
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
|
|
8168
9172
|
* @summary Create order
|
|
8169
9173
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
8170
9174
|
* @param {*} [options] Override http request option.
|
|
@@ -8218,7 +9222,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
8218
9222
|
*/
|
|
8219
9223
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrder200Response, any>>;
|
|
8220
9224
|
/**
|
|
8221
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
9225
|
+
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
|
|
8222
9226
|
* @summary Create order
|
|
8223
9227
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
8224
9228
|
* @param {*} [options] Override http request option.
|
|
@@ -8511,7 +9515,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
8511
9515
|
*/
|
|
8512
9516
|
export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8513
9517
|
/**
|
|
8514
|
-
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be
|
|
9518
|
+
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response.
|
|
8515
9519
|
* @summary Create report
|
|
8516
9520
|
* @param {CreateReportRequest} createReportRequest Report to create
|
|
8517
9521
|
* @param {*} [options] Override http request option.
|
|
@@ -8533,13 +9537,13 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8533
9537
|
*/
|
|
8534
9538
|
export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
8535
9539
|
/**
|
|
8536
|
-
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be
|
|
9540
|
+
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response.
|
|
8537
9541
|
* @summary Create report
|
|
8538
9542
|
* @param {CreateReportRequest} createReportRequest Report to create
|
|
8539
9543
|
* @param {*} [options] Override http request option.
|
|
8540
9544
|
* @throws {RequiredError}
|
|
8541
9545
|
*/
|
|
8542
|
-
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9546
|
+
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReport200Response>>;
|
|
8543
9547
|
/**
|
|
8544
9548
|
* Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days.
|
|
8545
9549
|
* @summary Retrieve report
|
|
@@ -8547,7 +9551,7 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
8547
9551
|
* @param {*} [options] Override http request option.
|
|
8548
9552
|
* @throws {RequiredError}
|
|
8549
9553
|
*/
|
|
8550
|
-
getReport(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9554
|
+
getReport(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReport200Response>>;
|
|
8551
9555
|
};
|
|
8552
9556
|
/**
|
|
8553
9557
|
* ReportsApi - factory interface
|
|
@@ -8555,13 +9559,13 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
8555
9559
|
*/
|
|
8556
9560
|
export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8557
9561
|
/**
|
|
8558
|
-
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be
|
|
9562
|
+
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response.
|
|
8559
9563
|
* @summary Create report
|
|
8560
9564
|
* @param {CreateReportRequest} createReportRequest Report to create
|
|
8561
9565
|
* @param {*} [options] Override http request option.
|
|
8562
9566
|
* @throws {RequiredError}
|
|
8563
9567
|
*/
|
|
8564
|
-
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9568
|
+
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateReport200Response>;
|
|
8565
9569
|
/**
|
|
8566
9570
|
* Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days.
|
|
8567
9571
|
* @summary Retrieve report
|
|
@@ -8569,7 +9573,7 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
8569
9573
|
* @param {*} [options] Override http request option.
|
|
8570
9574
|
* @throws {RequiredError}
|
|
8571
9575
|
*/
|
|
8572
|
-
getReport(id: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9576
|
+
getReport(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateReport200Response>;
|
|
8573
9577
|
};
|
|
8574
9578
|
/**
|
|
8575
9579
|
* ReportsApi - object-oriented interface
|
|
@@ -8579,14 +9583,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
8579
9583
|
*/
|
|
8580
9584
|
export declare class ReportsApi extends BaseAPI {
|
|
8581
9585
|
/**
|
|
8582
|
-
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be
|
|
9586
|
+
* Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">report_type</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Type of report for retrieval. <table> <thead> <tr> <th>Report type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>digital_rewards</code></td> <td>Report for Tremendous digital reward history</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">format</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Format the report will be generated in. <table> <thead> <tr> <th>Format</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>csv</code></td> <td>CSV format for report</td> </tr> </tbody> </table></p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">filters</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters to apply to the report. Corresponds to the filters provided in the dashboard</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">digital_rewards</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Filters object for a <code>report_type: digital_rewards</code> report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Amount of the rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Minimum amount of the rewards that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Maximum amount of the rewards that should be returned in the report</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous campaign that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Creation dates of rewards returned in the report</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">gte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Minimum date the reward was created</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">lte</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Maximum date the reward was created</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivered_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Delivery date for gifts that should be returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery_method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Delivery method for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the Tremendous order that this report should be limited to</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">order_status</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Order status for rewards returned in the report</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">status</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>Status for rewards returned in the report</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response.
|
|
8583
9587
|
* @summary Create report
|
|
8584
9588
|
* @param {CreateReportRequest} createReportRequest Report to create
|
|
8585
9589
|
* @param {*} [options] Override http request option.
|
|
8586
9590
|
* @throws {RequiredError}
|
|
8587
9591
|
* @memberof ReportsApi
|
|
8588
9592
|
*/
|
|
8589
|
-
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9593
|
+
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReport200Response, any>>;
|
|
8590
9594
|
/**
|
|
8591
9595
|
* Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days.
|
|
8592
9596
|
* @summary Retrieve report
|
|
@@ -8595,7 +9599,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
8595
9599
|
* @throws {RequiredError}
|
|
8596
9600
|
* @memberof ReportsApi
|
|
8597
9601
|
*/
|
|
8598
|
-
getReport(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9602
|
+
getReport(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReport200Response, any>>;
|
|
8599
9603
|
}
|
|
8600
9604
|
/**
|
|
8601
9605
|
* RewardsApi - axios parameter creator
|
|
@@ -8603,21 +9607,21 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
8603
9607
|
*/
|
|
8604
9608
|
export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8605
9609
|
/**
|
|
8606
|
-
*
|
|
8607
|
-
* @summary
|
|
8608
|
-
* @param {string} id ID of the reward
|
|
9610
|
+
* Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
|
|
9611
|
+
* @summary Cancel reward
|
|
9612
|
+
* @param {string} id ID of the reward that should be canceled
|
|
8609
9613
|
* @param {*} [options] Override http request option.
|
|
8610
9614
|
* @throws {RequiredError}
|
|
8611
9615
|
*/
|
|
8612
|
-
|
|
9616
|
+
cancelReward: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8613
9617
|
/**
|
|
8614
|
-
* Generate a
|
|
8615
|
-
* @summary Generate a reward
|
|
9618
|
+
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
9619
|
+
* @summary Generate a reward URL
|
|
8616
9620
|
* @param {string} id ID of the reward
|
|
8617
9621
|
* @param {*} [options] Override http request option.
|
|
8618
9622
|
* @throws {RequiredError}
|
|
8619
9623
|
*/
|
|
8620
|
-
|
|
9624
|
+
generateRewardLink: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8621
9625
|
/**
|
|
8622
9626
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
8623
9627
|
* @summary Retrieve single reward
|
|
@@ -8650,21 +9654,21 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8650
9654
|
*/
|
|
8651
9655
|
export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
8652
9656
|
/**
|
|
8653
|
-
*
|
|
8654
|
-
* @summary
|
|
8655
|
-
* @param {string} id ID of the reward
|
|
9657
|
+
* Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
|
|
9658
|
+
* @summary Cancel reward
|
|
9659
|
+
* @param {string} id ID of the reward that should be canceled
|
|
8656
9660
|
* @param {*} [options] Override http request option.
|
|
8657
9661
|
* @throws {RequiredError}
|
|
8658
9662
|
*/
|
|
8659
|
-
|
|
9663
|
+
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
8660
9664
|
/**
|
|
8661
|
-
* Generate a
|
|
8662
|
-
* @summary Generate a reward
|
|
9665
|
+
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
9666
|
+
* @summary Generate a reward URL
|
|
8663
9667
|
* @param {string} id ID of the reward
|
|
8664
9668
|
* @param {*} [options] Override http request option.
|
|
8665
9669
|
* @throws {RequiredError}
|
|
8666
9670
|
*/
|
|
8667
|
-
|
|
9671
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateRewardLink200Response>>;
|
|
8668
9672
|
/**
|
|
8669
9673
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
8670
9674
|
* @summary Retrieve single reward
|
|
@@ -8697,21 +9701,21 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
8697
9701
|
*/
|
|
8698
9702
|
export declare const RewardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8699
9703
|
/**
|
|
8700
|
-
*
|
|
8701
|
-
* @summary
|
|
8702
|
-
* @param {string} id ID of the reward
|
|
9704
|
+
* Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
|
|
9705
|
+
* @summary Cancel reward
|
|
9706
|
+
* @param {string} id ID of the reward that should be canceled
|
|
8703
9707
|
* @param {*} [options] Override http request option.
|
|
8704
9708
|
* @throws {RequiredError}
|
|
8705
9709
|
*/
|
|
8706
|
-
|
|
9710
|
+
cancelReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
8707
9711
|
/**
|
|
8708
|
-
* Generate a
|
|
8709
|
-
* @summary Generate a reward
|
|
9712
|
+
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
9713
|
+
* @summary Generate a reward URL
|
|
8710
9714
|
* @param {string} id ID of the reward
|
|
8711
9715
|
* @param {*} [options] Override http request option.
|
|
8712
9716
|
* @throws {RequiredError}
|
|
8713
9717
|
*/
|
|
8714
|
-
|
|
9718
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRewardLink200Response>;
|
|
8715
9719
|
/**
|
|
8716
9720
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
8717
9721
|
* @summary Retrieve single reward
|
|
@@ -8746,23 +9750,23 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
8746
9750
|
*/
|
|
8747
9751
|
export declare class RewardsApi extends BaseAPI {
|
|
8748
9752
|
/**
|
|
8749
|
-
*
|
|
8750
|
-
* @summary
|
|
8751
|
-
* @param {string} id ID of the reward
|
|
9753
|
+
* Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
|
|
9754
|
+
* @summary Cancel reward
|
|
9755
|
+
* @param {string} id ID of the reward that should be canceled
|
|
8752
9756
|
* @param {*} [options] Override http request option.
|
|
8753
9757
|
* @throws {RequiredError}
|
|
8754
9758
|
* @memberof RewardsApi
|
|
8755
9759
|
*/
|
|
8756
|
-
|
|
9760
|
+
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
8757
9761
|
/**
|
|
8758
|
-
* Generate a
|
|
8759
|
-
* @summary Generate a reward
|
|
9762
|
+
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
9763
|
+
* @summary Generate a reward URL
|
|
8760
9764
|
* @param {string} id ID of the reward
|
|
8761
9765
|
* @param {*} [options] Override http request option.
|
|
8762
9766
|
* @throws {RequiredError}
|
|
8763
9767
|
* @memberof RewardsApi
|
|
8764
9768
|
*/
|
|
8765
|
-
|
|
9769
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateRewardLink200Response, any>>;
|
|
8766
9770
|
/**
|
|
8767
9771
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
8768
9772
|
* @summary Retrieve single reward
|