tremendous 3.0.1 → 3.3.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/dist/api.d.ts +1041 -130
- package/dist/api.js +917 -147
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -51,7 +51,7 @@ export interface BalanceTransaction {
|
|
|
51
51
|
'description'?: string;
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
|
-
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
54
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
55
55
|
* @export
|
|
56
56
|
* @interface Campaign
|
|
57
57
|
*/
|
|
@@ -61,7 +61,7 @@ export interface Campaign {
|
|
|
61
61
|
* @type {string}
|
|
62
62
|
* @memberof Campaign
|
|
63
63
|
*/
|
|
64
|
-
'id'
|
|
64
|
+
'id'?: string;
|
|
65
65
|
/**
|
|
66
66
|
* Name of the campaign
|
|
67
67
|
* @type {string}
|
|
@@ -80,6 +80,61 @@ export interface Campaign {
|
|
|
80
80
|
* @memberof Campaign
|
|
81
81
|
*/
|
|
82
82
|
'products': Array<string>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
86
|
+
* @memberof Campaign
|
|
87
|
+
*/
|
|
88
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
92
|
+
* @memberof Campaign
|
|
93
|
+
*/
|
|
94
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
98
|
+
* @export
|
|
99
|
+
* @interface CampaignBase
|
|
100
|
+
*/
|
|
101
|
+
export interface CampaignBase {
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof CampaignBase
|
|
106
|
+
*/
|
|
107
|
+
'id'?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Name of the campaign
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof CampaignBase
|
|
112
|
+
*/
|
|
113
|
+
'name'?: string;
|
|
114
|
+
/**
|
|
115
|
+
* Description of the campaign
|
|
116
|
+
* @type {string}
|
|
117
|
+
* @memberof CampaignBase
|
|
118
|
+
*/
|
|
119
|
+
'description'?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* List of IDs of products (different gift cards, charity, etc.) that are available in this campaign.
|
|
122
|
+
* @type {Array<string>}
|
|
123
|
+
* @memberof CampaignBase
|
|
124
|
+
*/
|
|
125
|
+
'products'?: Array<string>;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
129
|
+
* @memberof CampaignBase
|
|
130
|
+
*/
|
|
131
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
135
|
+
* @memberof CampaignBase
|
|
136
|
+
*/
|
|
137
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
83
138
|
}
|
|
84
139
|
/**
|
|
85
140
|
*
|
|
@@ -94,6 +149,56 @@ export interface CreateApiKey200Response {
|
|
|
94
149
|
*/
|
|
95
150
|
'api_key'?: string;
|
|
96
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
*
|
|
154
|
+
* @export
|
|
155
|
+
* @interface CreateCampaign201Response
|
|
156
|
+
*/
|
|
157
|
+
export interface CreateCampaign201Response {
|
|
158
|
+
/**
|
|
159
|
+
*
|
|
160
|
+
* @type {ListCampaigns200ResponseCampaignsInner}
|
|
161
|
+
* @memberof CreateCampaign201Response
|
|
162
|
+
*/
|
|
163
|
+
'campaign': ListCampaigns200ResponseCampaignsInner;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
167
|
+
* @export
|
|
168
|
+
* @interface CreateCampaignRequest
|
|
169
|
+
*/
|
|
170
|
+
export interface CreateCampaignRequest {
|
|
171
|
+
/**
|
|
172
|
+
* Name of the campaign
|
|
173
|
+
* @type {string}
|
|
174
|
+
* @memberof CreateCampaignRequest
|
|
175
|
+
*/
|
|
176
|
+
'name': string;
|
|
177
|
+
/**
|
|
178
|
+
* Description of the campaign
|
|
179
|
+
* @type {string}
|
|
180
|
+
* @memberof CreateCampaignRequest
|
|
181
|
+
*/
|
|
182
|
+
'description': string | null;
|
|
183
|
+
/**
|
|
184
|
+
* List of IDs of products (different gift cards, charity, etc.) that are available in this campaign.
|
|
185
|
+
* @type {Array<string>}
|
|
186
|
+
* @memberof CreateCampaignRequest
|
|
187
|
+
*/
|
|
188
|
+
'products': Array<string>;
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
192
|
+
* @memberof CreateCampaignRequest
|
|
193
|
+
*/
|
|
194
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
198
|
+
* @memberof CreateCampaignRequest
|
|
199
|
+
*/
|
|
200
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
201
|
+
}
|
|
97
202
|
/**
|
|
98
203
|
*
|
|
99
204
|
* @export
|
|
@@ -170,23 +275,12 @@ export interface CreateMember {
|
|
|
170
275
|
*/
|
|
171
276
|
'email': string;
|
|
172
277
|
/**
|
|
173
|
-
*
|
|
174
|
-
* @type {string}
|
|
175
|
-
* @memberof CreateMember
|
|
176
|
-
*/
|
|
177
|
-
'name': string;
|
|
178
|
-
/**
|
|
179
|
-
* Role of the member within the organization. <table> <thead> <tr> <th>Role</th> <th>Description</th> </tr> </thead> <tr> <td><code>MEMBER</code></td> <td>Limited permissions. Can view their own reward and order histories only.</td> </tr> <tr> <td><code>ADMIN</code></td> <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td> </tr> <tbody> </table>
|
|
278
|
+
* The role ID of the member within the organization.
|
|
180
279
|
* @type {string}
|
|
181
280
|
* @memberof CreateMember
|
|
182
281
|
*/
|
|
183
|
-
'role':
|
|
282
|
+
'role': string;
|
|
184
283
|
}
|
|
185
|
-
export declare const CreateMemberRoleEnum: {
|
|
186
|
-
readonly Member: "MEMBER";
|
|
187
|
-
readonly Admin: "ADMIN";
|
|
188
|
-
};
|
|
189
|
-
export type CreateMemberRoleEnum = typeof CreateMemberRoleEnum[keyof typeof CreateMemberRoleEnum];
|
|
190
284
|
/**
|
|
191
285
|
*
|
|
192
286
|
* @export
|
|
@@ -213,23 +307,12 @@ export interface CreateMemberRequest {
|
|
|
213
307
|
*/
|
|
214
308
|
'email': string;
|
|
215
309
|
/**
|
|
216
|
-
*
|
|
217
|
-
* @type {string}
|
|
218
|
-
* @memberof CreateMemberRequest
|
|
219
|
-
*/
|
|
220
|
-
'name': string;
|
|
221
|
-
/**
|
|
222
|
-
* Role of the member within the organization. <table> <thead> <tr> <th>Role</th> <th>Description</th> </tr> </thead> <tr> <td><code>MEMBER</code></td> <td>Limited permissions. Can view their own reward and order histories only.</td> </tr> <tr> <td><code>ADMIN</code></td> <td>Update organization settings, invite other members to the organization, and view all member order and reward histories within their organization.</td> </tr> <tbody> </table>
|
|
310
|
+
* The role ID of the member within the organization.
|
|
223
311
|
* @type {string}
|
|
224
312
|
* @memberof CreateMemberRequest
|
|
225
313
|
*/
|
|
226
|
-
'role':
|
|
314
|
+
'role': string;
|
|
227
315
|
}
|
|
228
|
-
export declare const CreateMemberRequestRoleEnum: {
|
|
229
|
-
readonly Member: "MEMBER";
|
|
230
|
-
readonly Admin: "ADMIN";
|
|
231
|
-
};
|
|
232
|
-
export type CreateMemberRequestRoleEnum = typeof CreateMemberRequestRoleEnum[keyof typeof CreateMemberRequestRoleEnum];
|
|
233
316
|
/**
|
|
234
317
|
*
|
|
235
318
|
* @export
|
|
@@ -489,10 +572,10 @@ export interface CreateOrderRequestReward {
|
|
|
489
572
|
'deliver_at'?: string;
|
|
490
573
|
/**
|
|
491
574
|
*
|
|
492
|
-
* @type {Array<
|
|
575
|
+
* @type {Array<CreateOrderRequestRewardCustomFieldsInner>}
|
|
493
576
|
* @memberof CreateOrderRequestReward
|
|
494
577
|
*/
|
|
495
|
-
'custom_fields'?: Array<
|
|
578
|
+
'custom_fields'?: Array<CreateOrderRequestRewardCustomFieldsInner>;
|
|
496
579
|
/**
|
|
497
580
|
* Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`.
|
|
498
581
|
* @type {string}
|
|
@@ -506,6 +589,25 @@ export interface CreateOrderRequestReward {
|
|
|
506
589
|
*/
|
|
507
590
|
'delivery'?: CreateOrderRequestRewardDelivery;
|
|
508
591
|
}
|
|
592
|
+
/**
|
|
593
|
+
* Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/reference/using-custom-fields-to-add-custom-data-to-rewards).)
|
|
594
|
+
* @export
|
|
595
|
+
* @interface CreateOrderRequestRewardCustomFieldsInner
|
|
596
|
+
*/
|
|
597
|
+
export interface CreateOrderRequestRewardCustomFieldsInner {
|
|
598
|
+
/**
|
|
599
|
+
* Tremendous ID of the custom field
|
|
600
|
+
* @type {string}
|
|
601
|
+
* @memberof CreateOrderRequestRewardCustomFieldsInner
|
|
602
|
+
*/
|
|
603
|
+
'id'?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Value of the custom field
|
|
606
|
+
* @type {string}
|
|
607
|
+
* @memberof CreateOrderRequestRewardCustomFieldsInner
|
|
608
|
+
*/
|
|
609
|
+
'value'?: string | null;
|
|
610
|
+
}
|
|
509
611
|
/**
|
|
510
612
|
* Details on how the reward is delivered to the recipient.
|
|
511
613
|
* @export
|
|
@@ -698,11 +800,62 @@ export interface CreateOrganizationRequestCopySettings {
|
|
|
698
800
|
*/
|
|
699
801
|
'security_settings'?: boolean;
|
|
700
802
|
/**
|
|
701
|
-
* Copy over the users from the current organization to the new organization. Defaults to `false`.
|
|
803
|
+
* Copy over the users and custom roles from the current organization to the new organization. Defaults to `false`.
|
|
702
804
|
* @type {boolean}
|
|
703
805
|
* @memberof CreateOrganizationRequestCopySettings
|
|
704
806
|
*/
|
|
705
807
|
'users'?: boolean;
|
|
808
|
+
/**
|
|
809
|
+
* Copy over the custom roles from the current organization to the new organization. Custom roles are always copied if `users` is `true`. Defaults to `false`.
|
|
810
|
+
* @type {boolean}
|
|
811
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
812
|
+
*/
|
|
813
|
+
'custom_roles'?: boolean;
|
|
814
|
+
/**
|
|
815
|
+
* Copy over the fraud prevention settings and rules from the current organization to the new organization. Defaults to `false`.
|
|
816
|
+
* @type {boolean}
|
|
817
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
818
|
+
*/
|
|
819
|
+
'fraud_prevention'?: boolean;
|
|
820
|
+
}
|
|
821
|
+
/**
|
|
822
|
+
*
|
|
823
|
+
* @export
|
|
824
|
+
* @interface CreatePublicKey
|
|
825
|
+
*/
|
|
826
|
+
export interface CreatePublicKey {
|
|
827
|
+
/**
|
|
828
|
+
* Base64 encoded (public) PEM file
|
|
829
|
+
* @type {string}
|
|
830
|
+
* @memberof CreatePublicKey
|
|
831
|
+
*/
|
|
832
|
+
'public_key': string;
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
*
|
|
836
|
+
* @export
|
|
837
|
+
* @interface CreatePublicKey200Response
|
|
838
|
+
*/
|
|
839
|
+
export interface CreatePublicKey200Response {
|
|
840
|
+
/**
|
|
841
|
+
*
|
|
842
|
+
* @type {PublicKeysResponsePublicKeysInner}
|
|
843
|
+
* @memberof CreatePublicKey200Response
|
|
844
|
+
*/
|
|
845
|
+
'public_key': PublicKeysResponsePublicKeysInner;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @export
|
|
850
|
+
* @interface CreatePublicKeyRequest
|
|
851
|
+
*/
|
|
852
|
+
export interface CreatePublicKeyRequest {
|
|
853
|
+
/**
|
|
854
|
+
* Base64 encoded (public) PEM file
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof CreatePublicKeyRequest
|
|
857
|
+
*/
|
|
858
|
+
'public_key': string;
|
|
706
859
|
}
|
|
707
860
|
/**
|
|
708
861
|
*
|
|
@@ -872,6 +1025,12 @@ export interface CustomField {
|
|
|
872
1025
|
* @memberof CustomField
|
|
873
1026
|
*/
|
|
874
1027
|
'value'?: string | null;
|
|
1028
|
+
/**
|
|
1029
|
+
* Label of the custom field
|
|
1030
|
+
* @type {string}
|
|
1031
|
+
* @memberof CustomField
|
|
1032
|
+
*/
|
|
1033
|
+
'label'?: string;
|
|
875
1034
|
}
|
|
876
1035
|
/**
|
|
877
1036
|
* Details on how the reward is delivered to the recipient.
|
|
@@ -1151,19 +1310,6 @@ export interface GenerateRewardToken200ResponseReward {
|
|
|
1151
1310
|
*/
|
|
1152
1311
|
'expires_at'?: string;
|
|
1153
1312
|
}
|
|
1154
|
-
/**
|
|
1155
|
-
*
|
|
1156
|
-
* @export
|
|
1157
|
-
* @interface GetCampaign200Response
|
|
1158
|
-
*/
|
|
1159
|
-
export interface GetCampaign200Response {
|
|
1160
|
-
/**
|
|
1161
|
-
*
|
|
1162
|
-
* @type {ListCampaigns200ResponseCampaignsInner}
|
|
1163
|
-
* @memberof GetCampaign200Response
|
|
1164
|
-
*/
|
|
1165
|
-
'campaign': ListCampaigns200ResponseCampaignsInner;
|
|
1166
|
-
}
|
|
1167
1313
|
/**
|
|
1168
1314
|
*
|
|
1169
1315
|
* @export
|
|
@@ -1215,11 +1361,17 @@ export interface GetMember200ResponseMember {
|
|
|
1215
1361
|
*/
|
|
1216
1362
|
'name': string | null;
|
|
1217
1363
|
/**
|
|
1218
|
-
*
|
|
1364
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
1365
|
+
* @type {boolean}
|
|
1366
|
+
* @memberof GetMember200ResponseMember
|
|
1367
|
+
*/
|
|
1368
|
+
'active'?: boolean;
|
|
1369
|
+
/**
|
|
1370
|
+
* The role ID associated with the member within the organization.
|
|
1219
1371
|
* @type {string}
|
|
1220
1372
|
* @memberof GetMember200ResponseMember
|
|
1221
1373
|
*/
|
|
1222
|
-
'role'
|
|
1374
|
+
'role'?: string | null;
|
|
1223
1375
|
/**
|
|
1224
1376
|
* 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`.
|
|
1225
1377
|
* @type {string}
|
|
@@ -1233,12 +1385,6 @@ export interface GetMember200ResponseMember {
|
|
|
1233
1385
|
*/
|
|
1234
1386
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
1235
1387
|
}
|
|
1236
|
-
export declare const GetMember200ResponseMemberRoleEnum: {
|
|
1237
|
-
readonly Member: "MEMBER";
|
|
1238
|
-
readonly Admin: "ADMIN";
|
|
1239
|
-
readonly Deleted: "DELETED";
|
|
1240
|
-
};
|
|
1241
|
-
export type GetMember200ResponseMemberRoleEnum = typeof GetMember200ResponseMemberRoleEnum[keyof typeof GetMember200ResponseMemberRoleEnum];
|
|
1242
1388
|
export declare const GetMember200ResponseMemberStatusEnum: {
|
|
1243
1389
|
readonly Registered: "REGISTERED";
|
|
1244
1390
|
readonly Invited: "INVITED";
|
|
@@ -1433,7 +1579,7 @@ export interface ListCampaigns200Response {
|
|
|
1433
1579
|
'campaigns': Array<ListCampaigns200ResponseCampaignsInner>;
|
|
1434
1580
|
}
|
|
1435
1581
|
/**
|
|
1436
|
-
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
1582
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
1437
1583
|
* @export
|
|
1438
1584
|
* @interface ListCampaigns200ResponseCampaignsInner
|
|
1439
1585
|
*/
|
|
@@ -1443,7 +1589,7 @@ export interface ListCampaigns200ResponseCampaignsInner {
|
|
|
1443
1589
|
* @type {string}
|
|
1444
1590
|
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
1445
1591
|
*/
|
|
1446
|
-
'id'
|
|
1592
|
+
'id'?: string;
|
|
1447
1593
|
/**
|
|
1448
1594
|
* Name of the campaign
|
|
1449
1595
|
* @type {string}
|
|
@@ -1462,6 +1608,104 @@ export interface ListCampaigns200ResponseCampaignsInner {
|
|
|
1462
1608
|
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
1463
1609
|
*/
|
|
1464
1610
|
'products': Array<string>;
|
|
1611
|
+
/**
|
|
1612
|
+
*
|
|
1613
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
1614
|
+
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
1615
|
+
*/
|
|
1616
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
1617
|
+
/**
|
|
1618
|
+
*
|
|
1619
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
1620
|
+
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
1621
|
+
*/
|
|
1622
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* Definition of the email style
|
|
1626
|
+
* @export
|
|
1627
|
+
* @interface ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1628
|
+
*/
|
|
1629
|
+
export interface ListCampaigns200ResponseCampaignsInnerEmailStyle {
|
|
1630
|
+
/**
|
|
1631
|
+
* If sending via email, this is how the email will appear to be sent from
|
|
1632
|
+
* @type {string}
|
|
1633
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1634
|
+
*/
|
|
1635
|
+
'sender_name'?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Email subject line
|
|
1638
|
+
* @type {string}
|
|
1639
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1640
|
+
*/
|
|
1641
|
+
'subject_line'?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location.
|
|
1644
|
+
* @type {string}
|
|
1645
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1646
|
+
*/
|
|
1647
|
+
'logo_image_url'?: string | null;
|
|
1648
|
+
/**
|
|
1649
|
+
* Image height in pixels
|
|
1650
|
+
* @type {number}
|
|
1651
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1652
|
+
*/
|
|
1653
|
+
'logo_image_height_px'?: number | null;
|
|
1654
|
+
/**
|
|
1655
|
+
* Logo backgrond color code (hex, rgb, or rgba)
|
|
1656
|
+
* @type {string}
|
|
1657
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1658
|
+
*/
|
|
1659
|
+
'logo_background_color'?: string | null;
|
|
1660
|
+
/**
|
|
1661
|
+
* Button color code (hex, rgb, or rgba)
|
|
1662
|
+
* @type {string}
|
|
1663
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1664
|
+
*/
|
|
1665
|
+
'button_color'?: string | null;
|
|
1666
|
+
}
|
|
1667
|
+
/**
|
|
1668
|
+
* Definition of the webpage style
|
|
1669
|
+
* @export
|
|
1670
|
+
* @interface ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1671
|
+
*/
|
|
1672
|
+
export interface ListCampaigns200ResponseCampaignsInnerWebpageStyle {
|
|
1673
|
+
/**
|
|
1674
|
+
* Headline for the reward page
|
|
1675
|
+
* @type {string}
|
|
1676
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1677
|
+
*/
|
|
1678
|
+
'headline'?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* Message for the reward page
|
|
1681
|
+
* @type {string}
|
|
1682
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1683
|
+
*/
|
|
1684
|
+
'message'?: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location.
|
|
1687
|
+
* @type {string}
|
|
1688
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1689
|
+
*/
|
|
1690
|
+
'logo_image_url'?: string | null;
|
|
1691
|
+
/**
|
|
1692
|
+
* Image height in pixels
|
|
1693
|
+
* @type {number}
|
|
1694
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1695
|
+
*/
|
|
1696
|
+
'logo_image_height_px'?: number | null;
|
|
1697
|
+
/**
|
|
1698
|
+
* Logo backgrond color code (hex, rgb, or rgba)
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1701
|
+
*/
|
|
1702
|
+
'logo_background_color'?: string | null;
|
|
1703
|
+
/**
|
|
1704
|
+
* Backgrond color code (hex, rgb, or rgba)
|
|
1705
|
+
* @type {string}
|
|
1706
|
+
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1707
|
+
*/
|
|
1708
|
+
'background_color'?: string | null;
|
|
1465
1709
|
}
|
|
1466
1710
|
/**
|
|
1467
1711
|
*
|
|
@@ -1521,6 +1765,21 @@ export interface ListFields200ResponseFieldsInner {
|
|
|
1521
1765
|
*/
|
|
1522
1766
|
'scope'?: string;
|
|
1523
1767
|
}
|
|
1768
|
+
/**
|
|
1769
|
+
*
|
|
1770
|
+
* @export
|
|
1771
|
+
* @interface ListForexResponse
|
|
1772
|
+
*/
|
|
1773
|
+
export interface ListForexResponse {
|
|
1774
|
+
/**
|
|
1775
|
+
*
|
|
1776
|
+
* @type {{ [key: string]: number; }}
|
|
1777
|
+
* @memberof ListForexResponse
|
|
1778
|
+
*/
|
|
1779
|
+
'forex': {
|
|
1780
|
+
[key: string]: number;
|
|
1781
|
+
};
|
|
1782
|
+
}
|
|
1524
1783
|
/**
|
|
1525
1784
|
*
|
|
1526
1785
|
* @export
|
|
@@ -1794,11 +2053,17 @@ export interface ListMembers200ResponseMembersInner {
|
|
|
1794
2053
|
*/
|
|
1795
2054
|
'name': string | null;
|
|
1796
2055
|
/**
|
|
1797
|
-
*
|
|
2056
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
2057
|
+
* @type {boolean}
|
|
2058
|
+
* @memberof ListMembers200ResponseMembersInner
|
|
2059
|
+
*/
|
|
2060
|
+
'active'?: boolean;
|
|
2061
|
+
/**
|
|
2062
|
+
* The role ID associated with the member within the organization.
|
|
1798
2063
|
* @type {string}
|
|
1799
2064
|
* @memberof ListMembers200ResponseMembersInner
|
|
1800
2065
|
*/
|
|
1801
|
-
'role'
|
|
2066
|
+
'role'?: string | null;
|
|
1802
2067
|
/**
|
|
1803
2068
|
* 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`.
|
|
1804
2069
|
* @type {string}
|
|
@@ -1818,12 +2083,6 @@ export interface ListMembers200ResponseMembersInner {
|
|
|
1818
2083
|
*/
|
|
1819
2084
|
'last_login_at'?: string | null;
|
|
1820
2085
|
}
|
|
1821
|
-
export declare const ListMembers200ResponseMembersInnerRoleEnum: {
|
|
1822
|
-
readonly Member: "MEMBER";
|
|
1823
|
-
readonly Admin: "ADMIN";
|
|
1824
|
-
readonly Deleted: "DELETED";
|
|
1825
|
-
};
|
|
1826
|
-
export type ListMembers200ResponseMembersInnerRoleEnum = typeof ListMembers200ResponseMembersInnerRoleEnum[keyof typeof ListMembers200ResponseMembersInnerRoleEnum];
|
|
1827
2086
|
export declare const ListMembers200ResponseMembersInnerStatusEnum: {
|
|
1828
2087
|
readonly Registered: "REGISTERED";
|
|
1829
2088
|
readonly Invited: "INVITED";
|
|
@@ -2378,6 +2637,12 @@ export interface ListRewards200ResponseRewardsInnerCustomFieldsInner {
|
|
|
2378
2637
|
* @memberof ListRewards200ResponseRewardsInnerCustomFieldsInner
|
|
2379
2638
|
*/
|
|
2380
2639
|
'value'?: string | null;
|
|
2640
|
+
/**
|
|
2641
|
+
* Label of the custom field
|
|
2642
|
+
* @type {string}
|
|
2643
|
+
* @memberof ListRewards200ResponseRewardsInnerCustomFieldsInner
|
|
2644
|
+
*/
|
|
2645
|
+
'label'?: string;
|
|
2381
2646
|
}
|
|
2382
2647
|
/**
|
|
2383
2648
|
* Details on how the reward is delivered to the recipient.
|
|
@@ -2622,43 +2887,81 @@ export interface ListRewards429Response {
|
|
|
2622
2887
|
/**
|
|
2623
2888
|
*
|
|
2624
2889
|
* @export
|
|
2625
|
-
* @interface
|
|
2890
|
+
* @interface ListRoles200Response
|
|
2626
2891
|
*/
|
|
2627
|
-
export interface
|
|
2892
|
+
export interface ListRoles200Response {
|
|
2628
2893
|
/**
|
|
2629
2894
|
*
|
|
2630
|
-
* @type {Array<
|
|
2631
|
-
* @memberof
|
|
2895
|
+
* @type {Array<ListRoles200ResponseRolesInner>}
|
|
2896
|
+
* @memberof ListRoles200Response
|
|
2632
2897
|
*/
|
|
2633
|
-
'
|
|
2898
|
+
'roles': Array<ListRoles200ResponseRolesInner>;
|
|
2634
2899
|
}
|
|
2635
2900
|
/**
|
|
2636
|
-
*
|
|
2901
|
+
* Each organization member is assigned a role that defines the permissions they have within the organization.
|
|
2637
2902
|
* @export
|
|
2638
|
-
* @interface
|
|
2903
|
+
* @interface ListRoles200ResponseRolesInner
|
|
2639
2904
|
*/
|
|
2640
|
-
export interface
|
|
2905
|
+
export interface ListRoles200ResponseRolesInner {
|
|
2641
2906
|
/**
|
|
2642
2907
|
*
|
|
2643
|
-
* @type {
|
|
2644
|
-
* @memberof
|
|
2908
|
+
* @type {string}
|
|
2909
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2645
2910
|
*/
|
|
2646
|
-
'
|
|
2647
|
-
}
|
|
2648
|
-
/**
|
|
2649
|
-
*
|
|
2650
|
-
* @export
|
|
2651
|
-
* @interface ListWebhooks200ResponseWebhooksInner
|
|
2652
|
-
*/
|
|
2653
|
-
export interface ListWebhooks200ResponseWebhooksInner {
|
|
2911
|
+
'id': string;
|
|
2654
2912
|
/**
|
|
2655
2913
|
*
|
|
2656
2914
|
* @type {string}
|
|
2657
|
-
* @memberof
|
|
2915
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2658
2916
|
*/
|
|
2659
|
-
'
|
|
2917
|
+
'title': string;
|
|
2660
2918
|
/**
|
|
2661
|
-
*
|
|
2919
|
+
*
|
|
2920
|
+
* @type {string}
|
|
2921
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2922
|
+
*/
|
|
2923
|
+
'description': string;
|
|
2924
|
+
}
|
|
2925
|
+
/**
|
|
2926
|
+
*
|
|
2927
|
+
* @export
|
|
2928
|
+
* @interface ListWebhookEvents200Response
|
|
2929
|
+
*/
|
|
2930
|
+
export interface ListWebhookEvents200Response {
|
|
2931
|
+
/**
|
|
2932
|
+
*
|
|
2933
|
+
* @type {Array<string>}
|
|
2934
|
+
* @memberof ListWebhookEvents200Response
|
|
2935
|
+
*/
|
|
2936
|
+
'events'?: Array<string>;
|
|
2937
|
+
}
|
|
2938
|
+
/**
|
|
2939
|
+
*
|
|
2940
|
+
* @export
|
|
2941
|
+
* @interface ListWebhooks200Response
|
|
2942
|
+
*/
|
|
2943
|
+
export interface ListWebhooks200Response {
|
|
2944
|
+
/**
|
|
2945
|
+
*
|
|
2946
|
+
* @type {Array<ListWebhooks200ResponseWebhooksInner>}
|
|
2947
|
+
* @memberof ListWebhooks200Response
|
|
2948
|
+
*/
|
|
2949
|
+
'webhooks'?: Array<ListWebhooks200ResponseWebhooksInner>;
|
|
2950
|
+
}
|
|
2951
|
+
/**
|
|
2952
|
+
*
|
|
2953
|
+
* @export
|
|
2954
|
+
* @interface ListWebhooks200ResponseWebhooksInner
|
|
2955
|
+
*/
|
|
2956
|
+
export interface ListWebhooks200ResponseWebhooksInner {
|
|
2957
|
+
/**
|
|
2958
|
+
*
|
|
2959
|
+
* @type {string}
|
|
2960
|
+
* @memberof ListWebhooks200ResponseWebhooksInner
|
|
2961
|
+
*/
|
|
2962
|
+
'id'?: string;
|
|
2963
|
+
/**
|
|
2964
|
+
* URL the webhook will make requests to
|
|
2662
2965
|
* @type {string}
|
|
2663
2966
|
* @memberof ListWebhooks200ResponseWebhooksInner
|
|
2664
2967
|
*/
|
|
@@ -2695,11 +2998,17 @@ export interface Member {
|
|
|
2695
2998
|
*/
|
|
2696
2999
|
'name': string | null;
|
|
2697
3000
|
/**
|
|
2698
|
-
*
|
|
3001
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
3002
|
+
* @type {boolean}
|
|
3003
|
+
* @memberof Member
|
|
3004
|
+
*/
|
|
3005
|
+
'active'?: boolean;
|
|
3006
|
+
/**
|
|
3007
|
+
* The role ID associated with the member within the organization.
|
|
2699
3008
|
* @type {string}
|
|
2700
3009
|
* @memberof Member
|
|
2701
3010
|
*/
|
|
2702
|
-
'role'
|
|
3011
|
+
'role'?: string | null;
|
|
2703
3012
|
/**
|
|
2704
3013
|
* 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`.
|
|
2705
3014
|
* @type {string}
|
|
@@ -2719,12 +3028,6 @@ export interface Member {
|
|
|
2719
3028
|
*/
|
|
2720
3029
|
'last_login_at'?: string | null;
|
|
2721
3030
|
}
|
|
2722
|
-
export declare const MemberRoleEnum: {
|
|
2723
|
-
readonly Member: "MEMBER";
|
|
2724
|
-
readonly Admin: "ADMIN";
|
|
2725
|
-
readonly Deleted: "DELETED";
|
|
2726
|
-
};
|
|
2727
|
-
export type MemberRoleEnum = typeof MemberRoleEnum[keyof typeof MemberRoleEnum];
|
|
2728
3031
|
export declare const MemberStatusEnum: {
|
|
2729
3032
|
readonly Registered: "REGISTERED";
|
|
2730
3033
|
readonly Invited: "INVITED";
|
|
@@ -2755,11 +3058,17 @@ export interface MemberBase {
|
|
|
2755
3058
|
*/
|
|
2756
3059
|
'name': string | null;
|
|
2757
3060
|
/**
|
|
2758
|
-
*
|
|
3061
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
3062
|
+
* @type {boolean}
|
|
3063
|
+
* @memberof MemberBase
|
|
3064
|
+
*/
|
|
3065
|
+
'active'?: boolean;
|
|
3066
|
+
/**
|
|
3067
|
+
* The role ID associated with the member within the organization.
|
|
2759
3068
|
* @type {string}
|
|
2760
3069
|
* @memberof MemberBase
|
|
2761
3070
|
*/
|
|
2762
|
-
'role'
|
|
3071
|
+
'role'?: string | null;
|
|
2763
3072
|
/**
|
|
2764
3073
|
* 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`.
|
|
2765
3074
|
* @type {string}
|
|
@@ -2767,12 +3076,6 @@ export interface MemberBase {
|
|
|
2767
3076
|
*/
|
|
2768
3077
|
'status': MemberBaseStatusEnum;
|
|
2769
3078
|
}
|
|
2770
|
-
export declare const MemberBaseRoleEnum: {
|
|
2771
|
-
readonly Member: "MEMBER";
|
|
2772
|
-
readonly Admin: "ADMIN";
|
|
2773
|
-
readonly Deleted: "DELETED";
|
|
2774
|
-
};
|
|
2775
|
-
export type MemberBaseRoleEnum = typeof MemberBaseRoleEnum[keyof typeof MemberBaseRoleEnum];
|
|
2776
3079
|
export declare const MemberBaseStatusEnum: {
|
|
2777
3080
|
readonly Registered: "REGISTERED";
|
|
2778
3081
|
readonly Invited: "INVITED";
|
|
@@ -2803,11 +3106,17 @@ export interface MemberWithEvents {
|
|
|
2803
3106
|
*/
|
|
2804
3107
|
'name': string | null;
|
|
2805
3108
|
/**
|
|
2806
|
-
*
|
|
3109
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
3110
|
+
* @type {boolean}
|
|
3111
|
+
* @memberof MemberWithEvents
|
|
3112
|
+
*/
|
|
3113
|
+
'active'?: boolean;
|
|
3114
|
+
/**
|
|
3115
|
+
* The role ID associated with the member within the organization.
|
|
2807
3116
|
* @type {string}
|
|
2808
3117
|
* @memberof MemberWithEvents
|
|
2809
3118
|
*/
|
|
2810
|
-
'role'
|
|
3119
|
+
'role'?: string | null;
|
|
2811
3120
|
/**
|
|
2812
3121
|
* 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`.
|
|
2813
3122
|
* @type {string}
|
|
@@ -2821,12 +3130,6 @@ export interface MemberWithEvents {
|
|
|
2821
3130
|
*/
|
|
2822
3131
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
2823
3132
|
}
|
|
2824
|
-
export declare const MemberWithEventsRoleEnum: {
|
|
2825
|
-
readonly Member: "MEMBER";
|
|
2826
|
-
readonly Admin: "ADMIN";
|
|
2827
|
-
readonly Deleted: "DELETED";
|
|
2828
|
-
};
|
|
2829
|
-
export type MemberWithEventsRoleEnum = typeof MemberWithEventsRoleEnum[keyof typeof MemberWithEventsRoleEnum];
|
|
2830
3133
|
export declare const MemberWithEventsStatusEnum: {
|
|
2831
3134
|
readonly Registered: "REGISTERED";
|
|
2832
3135
|
readonly Invited: "INVITED";
|
|
@@ -2857,11 +3160,17 @@ export interface MemberWithoutEvents {
|
|
|
2857
3160
|
*/
|
|
2858
3161
|
'name': string | null;
|
|
2859
3162
|
/**
|
|
2860
|
-
*
|
|
3163
|
+
* Is this member currently active in the organization. If `false`, the member will not be able to access the organization.
|
|
3164
|
+
* @type {boolean}
|
|
3165
|
+
* @memberof MemberWithoutEvents
|
|
3166
|
+
*/
|
|
3167
|
+
'active'?: boolean;
|
|
3168
|
+
/**
|
|
3169
|
+
* The role ID associated with the member within the organization.
|
|
2861
3170
|
* @type {string}
|
|
2862
3171
|
* @memberof MemberWithoutEvents
|
|
2863
3172
|
*/
|
|
2864
|
-
'role'
|
|
3173
|
+
'role'?: string | null;
|
|
2865
3174
|
/**
|
|
2866
3175
|
* 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`.
|
|
2867
3176
|
* @type {string}
|
|
@@ -2881,12 +3190,6 @@ export interface MemberWithoutEvents {
|
|
|
2881
3190
|
*/
|
|
2882
3191
|
'last_login_at'?: string | null;
|
|
2883
3192
|
}
|
|
2884
|
-
export declare const MemberWithoutEventsRoleEnum: {
|
|
2885
|
-
readonly Member: "MEMBER";
|
|
2886
|
-
readonly Admin: "ADMIN";
|
|
2887
|
-
readonly Deleted: "DELETED";
|
|
2888
|
-
};
|
|
2889
|
-
export type MemberWithoutEventsRoleEnum = typeof MemberWithoutEventsRoleEnum[keyof typeof MemberWithoutEventsRoleEnum];
|
|
2890
3193
|
export declare const MemberWithoutEventsStatusEnum: {
|
|
2891
3194
|
readonly Registered: "REGISTERED";
|
|
2892
3195
|
readonly Invited: "INVITED";
|
|
@@ -3727,6 +4030,69 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
3727
4030
|
readonly Zmk: "ZMK";
|
|
3728
4031
|
};
|
|
3729
4032
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
4033
|
+
/**
|
|
4034
|
+
* To authenticate your requests using asymmetric key pairs (e.g., for signing embed requests), you need to share your public key with us. The public key resource allows you to manage your active public keys and track their last usage.
|
|
4035
|
+
* @export
|
|
4036
|
+
* @interface PublicKey
|
|
4037
|
+
*/
|
|
4038
|
+
export interface PublicKey {
|
|
4039
|
+
/**
|
|
4040
|
+
*
|
|
4041
|
+
* @type {string}
|
|
4042
|
+
* @memberof PublicKey
|
|
4043
|
+
*/
|
|
4044
|
+
'id'?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* Your public key, PEM encoded
|
|
4047
|
+
* @type {string}
|
|
4048
|
+
* @memberof PublicKey
|
|
4049
|
+
*/
|
|
4050
|
+
'pem'?: string;
|
|
4051
|
+
/**
|
|
4052
|
+
* The last time your public key was used to sign a request
|
|
4053
|
+
* @type {string}
|
|
4054
|
+
* @memberof PublicKey
|
|
4055
|
+
*/
|
|
4056
|
+
'last_used_at'?: string | null;
|
|
4057
|
+
}
|
|
4058
|
+
/**
|
|
4059
|
+
*
|
|
4060
|
+
* @export
|
|
4061
|
+
* @interface PublicKeysResponse
|
|
4062
|
+
*/
|
|
4063
|
+
export interface PublicKeysResponse {
|
|
4064
|
+
/**
|
|
4065
|
+
*
|
|
4066
|
+
* @type {Array<PublicKeysResponsePublicKeysInner>}
|
|
4067
|
+
* @memberof PublicKeysResponse
|
|
4068
|
+
*/
|
|
4069
|
+
'public_keys': Array<PublicKeysResponsePublicKeysInner>;
|
|
4070
|
+
}
|
|
4071
|
+
/**
|
|
4072
|
+
* To authenticate your requests using asymmetric key pairs (e.g., for signing embed requests), you need to share your public key with us. The public key resource allows you to manage your active public keys and track their last usage.
|
|
4073
|
+
* @export
|
|
4074
|
+
* @interface PublicKeysResponsePublicKeysInner
|
|
4075
|
+
*/
|
|
4076
|
+
export interface PublicKeysResponsePublicKeysInner {
|
|
4077
|
+
/**
|
|
4078
|
+
*
|
|
4079
|
+
* @type {string}
|
|
4080
|
+
* @memberof PublicKeysResponsePublicKeysInner
|
|
4081
|
+
*/
|
|
4082
|
+
'id'?: string;
|
|
4083
|
+
/**
|
|
4084
|
+
* Your public key, PEM encoded
|
|
4085
|
+
* @type {string}
|
|
4086
|
+
* @memberof PublicKeysResponsePublicKeysInner
|
|
4087
|
+
*/
|
|
4088
|
+
'pem'?: string;
|
|
4089
|
+
/**
|
|
4090
|
+
* The last time your public key was used to sign a request
|
|
4091
|
+
* @type {string}
|
|
4092
|
+
* @memberof PublicKeysResponsePublicKeysInner
|
|
4093
|
+
*/
|
|
4094
|
+
'last_used_at'?: string | null;
|
|
4095
|
+
}
|
|
3730
4096
|
/**
|
|
3731
4097
|
* Details of the recipient of the reward
|
|
3732
4098
|
* @export
|
|
@@ -3924,6 +4290,12 @@ export interface RewardBaseCustomFieldsInner {
|
|
|
3924
4290
|
* @memberof RewardBaseCustomFieldsInner
|
|
3925
4291
|
*/
|
|
3926
4292
|
'value'?: string | null;
|
|
4293
|
+
/**
|
|
4294
|
+
* Label of the custom field
|
|
4295
|
+
* @type {string}
|
|
4296
|
+
* @memberof RewardBaseCustomFieldsInner
|
|
4297
|
+
*/
|
|
4298
|
+
'label'?: string;
|
|
3927
4299
|
}
|
|
3928
4300
|
/**
|
|
3929
4301
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
@@ -4384,6 +4756,31 @@ export declare const RewardWithoutLinkDeliveryStatusEnum: {
|
|
|
4384
4756
|
readonly Pending: "PENDING";
|
|
4385
4757
|
};
|
|
4386
4758
|
export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
|
|
4759
|
+
/**
|
|
4760
|
+
* Each organization member is assigned a role that defines the permissions they have within the organization.
|
|
4761
|
+
* @export
|
|
4762
|
+
* @interface Role
|
|
4763
|
+
*/
|
|
4764
|
+
export interface Role {
|
|
4765
|
+
/**
|
|
4766
|
+
*
|
|
4767
|
+
* @type {string}
|
|
4768
|
+
* @memberof Role
|
|
4769
|
+
*/
|
|
4770
|
+
'id': string;
|
|
4771
|
+
/**
|
|
4772
|
+
*
|
|
4773
|
+
* @type {string}
|
|
4774
|
+
* @memberof Role
|
|
4775
|
+
*/
|
|
4776
|
+
'title': string;
|
|
4777
|
+
/**
|
|
4778
|
+
*
|
|
4779
|
+
* @type {string}
|
|
4780
|
+
* @memberof Role
|
|
4781
|
+
*/
|
|
4782
|
+
'description': string;
|
|
4783
|
+
}
|
|
4387
4784
|
/**
|
|
4388
4785
|
*
|
|
4389
4786
|
* @export
|
|
@@ -4397,6 +4794,112 @@ export interface SimulateWebhookRequest {
|
|
|
4397
4794
|
*/
|
|
4398
4795
|
'event': string;
|
|
4399
4796
|
}
|
|
4797
|
+
/**
|
|
4798
|
+
*
|
|
4799
|
+
* @export
|
|
4800
|
+
* @interface TestPublicKey
|
|
4801
|
+
*/
|
|
4802
|
+
export interface TestPublicKey {
|
|
4803
|
+
/**
|
|
4804
|
+
* A JWT token encoded with RS256, signed using the RSA private key corresponding to your public key.
|
|
4805
|
+
* @type {string}
|
|
4806
|
+
* @memberof TestPublicKey
|
|
4807
|
+
*/
|
|
4808
|
+
'jwt': string;
|
|
4809
|
+
}
|
|
4810
|
+
/**
|
|
4811
|
+
*
|
|
4812
|
+
* @export
|
|
4813
|
+
* @interface TestPublicKeyRequest
|
|
4814
|
+
*/
|
|
4815
|
+
export interface TestPublicKeyRequest {
|
|
4816
|
+
/**
|
|
4817
|
+
* A JWT token encoded with RS256, signed using the RSA private key corresponding to your public key.
|
|
4818
|
+
* @type {string}
|
|
4819
|
+
* @memberof TestPublicKeyRequest
|
|
4820
|
+
*/
|
|
4821
|
+
'jwt': string;
|
|
4822
|
+
}
|
|
4823
|
+
/**
|
|
4824
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
4825
|
+
* @export
|
|
4826
|
+
* @interface UpdateCampaign
|
|
4827
|
+
*/
|
|
4828
|
+
export interface UpdateCampaign {
|
|
4829
|
+
/**
|
|
4830
|
+
*
|
|
4831
|
+
* @type {string}
|
|
4832
|
+
* @memberof UpdateCampaign
|
|
4833
|
+
*/
|
|
4834
|
+
'id'?: string;
|
|
4835
|
+
/**
|
|
4836
|
+
* Name of the campaign
|
|
4837
|
+
* @type {string}
|
|
4838
|
+
* @memberof UpdateCampaign
|
|
4839
|
+
*/
|
|
4840
|
+
'name'?: string;
|
|
4841
|
+
/**
|
|
4842
|
+
* Description of the campaign
|
|
4843
|
+
* @type {string}
|
|
4844
|
+
* @memberof UpdateCampaign
|
|
4845
|
+
*/
|
|
4846
|
+
'description'?: string | null;
|
|
4847
|
+
/**
|
|
4848
|
+
* List of IDs of products (different gift cards, charity, etc.) that are available in this campaign.
|
|
4849
|
+
* @type {Array<string>}
|
|
4850
|
+
* @memberof UpdateCampaign
|
|
4851
|
+
*/
|
|
4852
|
+
'products'?: Array<string>;
|
|
4853
|
+
/**
|
|
4854
|
+
*
|
|
4855
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
4856
|
+
* @memberof UpdateCampaign
|
|
4857
|
+
*/
|
|
4858
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
4859
|
+
/**
|
|
4860
|
+
*
|
|
4861
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
4862
|
+
* @memberof UpdateCampaign
|
|
4863
|
+
*/
|
|
4864
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
4865
|
+
}
|
|
4866
|
+
/**
|
|
4867
|
+
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
4868
|
+
* @export
|
|
4869
|
+
* @interface UpdateCampaignRequest
|
|
4870
|
+
*/
|
|
4871
|
+
export interface UpdateCampaignRequest {
|
|
4872
|
+
/**
|
|
4873
|
+
* Name of the campaign
|
|
4874
|
+
* @type {string}
|
|
4875
|
+
* @memberof UpdateCampaignRequest
|
|
4876
|
+
*/
|
|
4877
|
+
'name'?: string;
|
|
4878
|
+
/**
|
|
4879
|
+
* Description of the campaign
|
|
4880
|
+
* @type {string}
|
|
4881
|
+
* @memberof UpdateCampaignRequest
|
|
4882
|
+
*/
|
|
4883
|
+
'description'?: string | null;
|
|
4884
|
+
/**
|
|
4885
|
+
* List of IDs of products (different gift cards, charity, etc.) that are available in this campaign.
|
|
4886
|
+
* @type {Array<string>}
|
|
4887
|
+
* @memberof UpdateCampaignRequest
|
|
4888
|
+
*/
|
|
4889
|
+
'products'?: Array<string>;
|
|
4890
|
+
/**
|
|
4891
|
+
*
|
|
4892
|
+
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
4893
|
+
* @memberof UpdateCampaignRequest
|
|
4894
|
+
*/
|
|
4895
|
+
'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle;
|
|
4896
|
+
/**
|
|
4897
|
+
*
|
|
4898
|
+
* @type {ListCampaigns200ResponseCampaignsInnerEmailStyle}
|
|
4899
|
+
* @memberof UpdateCampaignRequest
|
|
4900
|
+
*/
|
|
4901
|
+
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
4902
|
+
}
|
|
4400
4903
|
/**
|
|
4401
4904
|
*
|
|
4402
4905
|
* @export
|
|
@@ -4511,6 +5014,14 @@ export declare class BalanceTransactionsApi extends BaseAPI {
|
|
|
4511
5014
|
* @export
|
|
4512
5015
|
*/
|
|
4513
5016
|
export declare const CampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5017
|
+
/**
|
|
5018
|
+
*
|
|
5019
|
+
* @summary Create campaign
|
|
5020
|
+
* @param {CreateCampaignRequest} createCampaignRequest Campaign details
|
|
5021
|
+
* @param {*} [options] Override http request option.
|
|
5022
|
+
* @throws {RequiredError}
|
|
5023
|
+
*/
|
|
5024
|
+
createCampaign: (createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4514
5025
|
/**
|
|
4515
5026
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
4516
5027
|
* @summary Retrieve campaign
|
|
@@ -4526,12 +5037,29 @@ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4526
5037
|
* @throws {RequiredError}
|
|
4527
5038
|
*/
|
|
4528
5039
|
listCampaigns: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5040
|
+
/**
|
|
5041
|
+
*
|
|
5042
|
+
* @summary Update campaign
|
|
5043
|
+
* @param {string} id ID of the campaign that should be updated
|
|
5044
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
5045
|
+
* @param {*} [options] Override http request option.
|
|
5046
|
+
* @throws {RequiredError}
|
|
5047
|
+
*/
|
|
5048
|
+
updateCampaign: (id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4529
5049
|
};
|
|
4530
5050
|
/**
|
|
4531
5051
|
* CampaignsApi - functional programming interface
|
|
4532
5052
|
* @export
|
|
4533
5053
|
*/
|
|
4534
5054
|
export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
5055
|
+
/**
|
|
5056
|
+
*
|
|
5057
|
+
* @summary Create campaign
|
|
5058
|
+
* @param {CreateCampaignRequest} createCampaignRequest Campaign details
|
|
5059
|
+
* @param {*} [options] Override http request option.
|
|
5060
|
+
* @throws {RequiredError}
|
|
5061
|
+
*/
|
|
5062
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign201Response>>;
|
|
4535
5063
|
/**
|
|
4536
5064
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
4537
5065
|
* @summary Retrieve campaign
|
|
@@ -4539,7 +5067,7 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
4539
5067
|
* @param {*} [options] Override http request option.
|
|
4540
5068
|
* @throws {RequiredError}
|
|
4541
5069
|
*/
|
|
4542
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5070
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign201Response>>;
|
|
4543
5071
|
/**
|
|
4544
5072
|
* Retrieve a list of all campaigns created in your account
|
|
4545
5073
|
* @summary List campaigns
|
|
@@ -4547,12 +5075,29 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
4547
5075
|
* @throws {RequiredError}
|
|
4548
5076
|
*/
|
|
4549
5077
|
listCampaigns(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCampaigns200Response>>;
|
|
5078
|
+
/**
|
|
5079
|
+
*
|
|
5080
|
+
* @summary Update campaign
|
|
5081
|
+
* @param {string} id ID of the campaign that should be updated
|
|
5082
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
5083
|
+
* @param {*} [options] Override http request option.
|
|
5084
|
+
* @throws {RequiredError}
|
|
5085
|
+
*/
|
|
5086
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign201Response>>;
|
|
4550
5087
|
};
|
|
4551
5088
|
/**
|
|
4552
5089
|
* CampaignsApi - factory interface
|
|
4553
5090
|
* @export
|
|
4554
5091
|
*/
|
|
4555
5092
|
export declare const CampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5093
|
+
/**
|
|
5094
|
+
*
|
|
5095
|
+
* @summary Create campaign
|
|
5096
|
+
* @param {CreateCampaignRequest} createCampaignRequest Campaign details
|
|
5097
|
+
* @param {*} [options] Override http request option.
|
|
5098
|
+
* @throws {RequiredError}
|
|
5099
|
+
*/
|
|
5100
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: any): AxiosPromise<CreateCampaign201Response>;
|
|
4556
5101
|
/**
|
|
4557
5102
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
4558
5103
|
* @summary Retrieve campaign
|
|
@@ -4560,7 +5105,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
4560
5105
|
* @param {*} [options] Override http request option.
|
|
4561
5106
|
* @throws {RequiredError}
|
|
4562
5107
|
*/
|
|
4563
|
-
getCampaign(id: string, options?: any): AxiosPromise<
|
|
5108
|
+
getCampaign(id: string, options?: any): AxiosPromise<CreateCampaign201Response>;
|
|
4564
5109
|
/**
|
|
4565
5110
|
* Retrieve a list of all campaigns created in your account
|
|
4566
5111
|
* @summary List campaigns
|
|
@@ -4568,6 +5113,15 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
4568
5113
|
* @throws {RequiredError}
|
|
4569
5114
|
*/
|
|
4570
5115
|
listCampaigns(options?: any): AxiosPromise<ListCampaigns200Response>;
|
|
5116
|
+
/**
|
|
5117
|
+
*
|
|
5118
|
+
* @summary Update campaign
|
|
5119
|
+
* @param {string} id ID of the campaign that should be updated
|
|
5120
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
5121
|
+
* @param {*} [options] Override http request option.
|
|
5122
|
+
* @throws {RequiredError}
|
|
5123
|
+
*/
|
|
5124
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: any): AxiosPromise<CreateCampaign201Response>;
|
|
4571
5125
|
};
|
|
4572
5126
|
/**
|
|
4573
5127
|
* CampaignsApi - object-oriented interface
|
|
@@ -4576,6 +5130,15 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
4576
5130
|
* @extends {BaseAPI}
|
|
4577
5131
|
*/
|
|
4578
5132
|
export declare class CampaignsApi extends BaseAPI {
|
|
5133
|
+
/**
|
|
5134
|
+
*
|
|
5135
|
+
* @summary Create campaign
|
|
5136
|
+
* @param {CreateCampaignRequest} createCampaignRequest Campaign details
|
|
5137
|
+
* @param {*} [options] Override http request option.
|
|
5138
|
+
* @throws {RequiredError}
|
|
5139
|
+
* @memberof CampaignsApi
|
|
5140
|
+
*/
|
|
5141
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign201Response, any>>;
|
|
4579
5142
|
/**
|
|
4580
5143
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
4581
5144
|
* @summary Retrieve campaign
|
|
@@ -4584,7 +5147,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
4584
5147
|
* @throws {RequiredError}
|
|
4585
5148
|
* @memberof CampaignsApi
|
|
4586
5149
|
*/
|
|
4587
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5150
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign201Response, any>>;
|
|
4588
5151
|
/**
|
|
4589
5152
|
* Retrieve a list of all campaigns created in your account
|
|
4590
5153
|
* @summary List campaigns
|
|
@@ -4593,6 +5156,16 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
4593
5156
|
* @memberof CampaignsApi
|
|
4594
5157
|
*/
|
|
4595
5158
|
listCampaigns(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCampaigns200Response, any>>;
|
|
5159
|
+
/**
|
|
5160
|
+
*
|
|
5161
|
+
* @summary Update campaign
|
|
5162
|
+
* @param {string} id ID of the campaign that should be updated
|
|
5163
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
5164
|
+
* @param {*} [options] Override http request option.
|
|
5165
|
+
* @throws {RequiredError}
|
|
5166
|
+
* @memberof CampaignsApi
|
|
5167
|
+
*/
|
|
5168
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign201Response, any>>;
|
|
4596
5169
|
}
|
|
4597
5170
|
/**
|
|
4598
5171
|
* FieldsApi - axios parameter creator
|
|
@@ -4649,6 +5222,65 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
4649
5222
|
*/
|
|
4650
5223
|
listFields(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFields200Response, any>>;
|
|
4651
5224
|
}
|
|
5225
|
+
/**
|
|
5226
|
+
* ForexApi - axios parameter creator
|
|
5227
|
+
* @export
|
|
5228
|
+
*/
|
|
5229
|
+
export declare const ForexApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5230
|
+
/**
|
|
5231
|
+
* Retrieve a list of exchange rates
|
|
5232
|
+
* @summary List exchange rates
|
|
5233
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
5234
|
+
* @param {*} [options] Override http request option.
|
|
5235
|
+
* @throws {RequiredError}
|
|
5236
|
+
*/
|
|
5237
|
+
listForex: (base?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5238
|
+
};
|
|
5239
|
+
/**
|
|
5240
|
+
* ForexApi - functional programming interface
|
|
5241
|
+
* @export
|
|
5242
|
+
*/
|
|
5243
|
+
export declare const ForexApiFp: (configuration?: Configuration) => {
|
|
5244
|
+
/**
|
|
5245
|
+
* Retrieve a list of exchange rates
|
|
5246
|
+
* @summary List exchange rates
|
|
5247
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
5248
|
+
* @param {*} [options] Override http request option.
|
|
5249
|
+
* @throws {RequiredError}
|
|
5250
|
+
*/
|
|
5251
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListForexResponse>>;
|
|
5252
|
+
};
|
|
5253
|
+
/**
|
|
5254
|
+
* ForexApi - factory interface
|
|
5255
|
+
* @export
|
|
5256
|
+
*/
|
|
5257
|
+
export declare const ForexApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5258
|
+
/**
|
|
5259
|
+
* Retrieve a list of exchange rates
|
|
5260
|
+
* @summary List exchange rates
|
|
5261
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
5262
|
+
* @param {*} [options] Override http request option.
|
|
5263
|
+
* @throws {RequiredError}
|
|
5264
|
+
*/
|
|
5265
|
+
listForex(base?: string, options?: any): AxiosPromise<ListForexResponse>;
|
|
5266
|
+
};
|
|
5267
|
+
/**
|
|
5268
|
+
* ForexApi - object-oriented interface
|
|
5269
|
+
* @export
|
|
5270
|
+
* @class ForexApi
|
|
5271
|
+
* @extends {BaseAPI}
|
|
5272
|
+
*/
|
|
5273
|
+
export declare class ForexApi extends BaseAPI {
|
|
5274
|
+
/**
|
|
5275
|
+
* Retrieve a list of exchange rates
|
|
5276
|
+
* @summary List exchange rates
|
|
5277
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
5278
|
+
* @param {*} [options] Override http request option.
|
|
5279
|
+
* @throws {RequiredError}
|
|
5280
|
+
* @memberof ForexApi
|
|
5281
|
+
*/
|
|
5282
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListForexResponse, any>>;
|
|
5283
|
+
}
|
|
4652
5284
|
/**
|
|
4653
5285
|
* FundingSourcesApi - axios parameter creator
|
|
4654
5286
|
* @export
|
|
@@ -4753,7 +5385,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4753
5385
|
/**
|
|
4754
5386
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
4755
5387
|
* @summary Delete invoice
|
|
4756
|
-
* @param {string} id ID of the invoice that should be
|
|
5388
|
+
* @param {string} id ID of the invoice that should be removed
|
|
4757
5389
|
* @param {*} [options] Override http request option.
|
|
4758
5390
|
* @throws {RequiredError}
|
|
4759
5391
|
*/
|
|
@@ -4808,7 +5440,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
4808
5440
|
/**
|
|
4809
5441
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
4810
5442
|
* @summary Delete invoice
|
|
4811
|
-
* @param {string} id ID of the invoice that should be
|
|
5443
|
+
* @param {string} id ID of the invoice that should be removed
|
|
4812
5444
|
* @param {*} [options] Override http request option.
|
|
4813
5445
|
* @throws {RequiredError}
|
|
4814
5446
|
*/
|
|
@@ -4863,7 +5495,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
4863
5495
|
/**
|
|
4864
5496
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
4865
5497
|
* @summary Delete invoice
|
|
4866
|
-
* @param {string} id ID of the invoice that should be
|
|
5498
|
+
* @param {string} id ID of the invoice that should be removed
|
|
4867
5499
|
* @param {*} [options] Override http request option.
|
|
4868
5500
|
* @throws {RequiredError}
|
|
4869
5501
|
*/
|
|
@@ -4921,7 +5553,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
4921
5553
|
/**
|
|
4922
5554
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
4923
5555
|
* @summary Delete invoice
|
|
4924
|
-
* @param {string} id ID of the invoice that should be
|
|
5556
|
+
* @param {string} id ID of the invoice that should be removed
|
|
4925
5557
|
* @param {*} [options] Override http request option.
|
|
4926
5558
|
* @throws {RequiredError}
|
|
4927
5559
|
* @memberof InvoicesApi
|
|
@@ -4971,7 +5603,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
4971
5603
|
*/
|
|
4972
5604
|
export declare const MembersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4973
5605
|
/**
|
|
4974
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
5606
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
4975
5607
|
* @summary Create member
|
|
4976
5608
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
4977
5609
|
* @param {*} [options] Override http request option.
|
|
@@ -5000,7 +5632,7 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5000
5632
|
*/
|
|
5001
5633
|
export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
5002
5634
|
/**
|
|
5003
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
5635
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
5004
5636
|
* @summary Create member
|
|
5005
5637
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5006
5638
|
* @param {*} [options] Override http request option.
|
|
@@ -5029,7 +5661,7 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
|
5029
5661
|
*/
|
|
5030
5662
|
export declare const MembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5031
5663
|
/**
|
|
5032
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
5664
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
5033
5665
|
* @summary Create member
|
|
5034
5666
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5035
5667
|
* @param {*} [options] Override http request option.
|
|
@@ -5060,7 +5692,7 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
5060
5692
|
*/
|
|
5061
5693
|
export declare class MembersApi extends BaseAPI {
|
|
5062
5694
|
/**
|
|
5063
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
5695
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
5064
5696
|
* @summary Create member
|
|
5065
5697
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5066
5698
|
* @param {*} [options] Override http request option.
|
|
@@ -5100,7 +5732,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5100
5732
|
*/
|
|
5101
5733
|
approveOrder: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5102
5734
|
/**
|
|
5103
|
-
* 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> </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.
|
|
5735
|
+
* 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.
|
|
5104
5736
|
* @summary Create order
|
|
5105
5737
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
5106
5738
|
* @param {*} [options] Override http request option.
|
|
@@ -5151,7 +5783,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
5151
5783
|
*/
|
|
5152
5784
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder201Response>>;
|
|
5153
5785
|
/**
|
|
5154
|
-
* 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> </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.
|
|
5786
|
+
* 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.
|
|
5155
5787
|
* @summary Create order
|
|
5156
5788
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
5157
5789
|
* @param {*} [options] Override http request option.
|
|
@@ -5202,7 +5834,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5202
5834
|
*/
|
|
5203
5835
|
approveOrder(id: string, options?: any): AxiosPromise<CreateOrder201Response>;
|
|
5204
5836
|
/**
|
|
5205
|
-
* 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> </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.
|
|
5837
|
+
* 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.
|
|
5206
5838
|
* @summary Create order
|
|
5207
5839
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
5208
5840
|
* @param {*} [options] Override http request option.
|
|
@@ -5256,7 +5888,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
5256
5888
|
*/
|
|
5257
5889
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder201Response, any>>;
|
|
5258
5890
|
/**
|
|
5259
|
-
* 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> </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.
|
|
5891
|
+
* 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.
|
|
5260
5892
|
* @summary Create order
|
|
5261
5893
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
5262
5894
|
* @param {*} [options] Override http request option.
|
|
@@ -5543,6 +6175,197 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
5543
6175
|
*/
|
|
5544
6176
|
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductsResponse, any>>;
|
|
5545
6177
|
}
|
|
6178
|
+
/**
|
|
6179
|
+
* PublicKeysApi - axios parameter creator
|
|
6180
|
+
* @export
|
|
6181
|
+
*/
|
|
6182
|
+
export declare const PublicKeysApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6183
|
+
/**
|
|
6184
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
6185
|
+
* @summary Create public key
|
|
6186
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
6187
|
+
* @param {*} [options] Override http request option.
|
|
6188
|
+
* @throws {RequiredError}
|
|
6189
|
+
*/
|
|
6190
|
+
createPublicKey: (createPublicKeyRequest: CreatePublicKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6191
|
+
/**
|
|
6192
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
6193
|
+
* @summary Delete public key
|
|
6194
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
6195
|
+
* @param {*} [options] Override http request option.
|
|
6196
|
+
* @throws {RequiredError}
|
|
6197
|
+
*/
|
|
6198
|
+
deletePublicKey: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6199
|
+
/**
|
|
6200
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
6201
|
+
* @summary Retrieve public key
|
|
6202
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
6203
|
+
* @param {*} [options] Override http request option.
|
|
6204
|
+
* @throws {RequiredError}
|
|
6205
|
+
*/
|
|
6206
|
+
getPublicKey: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6207
|
+
/**
|
|
6208
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
6209
|
+
* @summary List public keys
|
|
6210
|
+
* @param {*} [options] Override http request option.
|
|
6211
|
+
* @throws {RequiredError}
|
|
6212
|
+
*/
|
|
6213
|
+
listPublicKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6214
|
+
/**
|
|
6215
|
+
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
6216
|
+
* @summary Test public key
|
|
6217
|
+
* @param {string} id ID of the public key to test
|
|
6218
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
6219
|
+
* @param {*} [options] Override http request option.
|
|
6220
|
+
* @throws {RequiredError}
|
|
6221
|
+
*/
|
|
6222
|
+
testPublicKey: (id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6223
|
+
};
|
|
6224
|
+
/**
|
|
6225
|
+
* PublicKeysApi - functional programming interface
|
|
6226
|
+
* @export
|
|
6227
|
+
*/
|
|
6228
|
+
export declare const PublicKeysApiFp: (configuration?: Configuration) => {
|
|
6229
|
+
/**
|
|
6230
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
6231
|
+
* @summary Create public key
|
|
6232
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
6233
|
+
* @param {*} [options] Override http request option.
|
|
6234
|
+
* @throws {RequiredError}
|
|
6235
|
+
*/
|
|
6236
|
+
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePublicKey200Response>>;
|
|
6237
|
+
/**
|
|
6238
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
6239
|
+
* @summary Delete public key
|
|
6240
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
6241
|
+
* @param {*} [options] Override http request option.
|
|
6242
|
+
* @throws {RequiredError}
|
|
6243
|
+
*/
|
|
6244
|
+
deletePublicKey(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6245
|
+
/**
|
|
6246
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
6247
|
+
* @summary Retrieve public key
|
|
6248
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
6249
|
+
* @param {*} [options] Override http request option.
|
|
6250
|
+
* @throws {RequiredError}
|
|
6251
|
+
*/
|
|
6252
|
+
getPublicKey(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePublicKey200Response>>;
|
|
6253
|
+
/**
|
|
6254
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
6255
|
+
* @summary List public keys
|
|
6256
|
+
* @param {*} [options] Override http request option.
|
|
6257
|
+
* @throws {RequiredError}
|
|
6258
|
+
*/
|
|
6259
|
+
listPublicKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKeysResponse>>;
|
|
6260
|
+
/**
|
|
6261
|
+
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
6262
|
+
* @summary Test public key
|
|
6263
|
+
* @param {string} id ID of the public key to test
|
|
6264
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
6265
|
+
* @param {*} [options] Override http request option.
|
|
6266
|
+
* @throws {RequiredError}
|
|
6267
|
+
*/
|
|
6268
|
+
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6269
|
+
};
|
|
6270
|
+
/**
|
|
6271
|
+
* PublicKeysApi - factory interface
|
|
6272
|
+
* @export
|
|
6273
|
+
*/
|
|
6274
|
+
export declare const PublicKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6275
|
+
/**
|
|
6276
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
6277
|
+
* @summary Create public key
|
|
6278
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
6279
|
+
* @param {*} [options] Override http request option.
|
|
6280
|
+
* @throws {RequiredError}
|
|
6281
|
+
*/
|
|
6282
|
+
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?: any): AxiosPromise<CreatePublicKey200Response>;
|
|
6283
|
+
/**
|
|
6284
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
6285
|
+
* @summary Delete public key
|
|
6286
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
6287
|
+
* @param {*} [options] Override http request option.
|
|
6288
|
+
* @throws {RequiredError}
|
|
6289
|
+
*/
|
|
6290
|
+
deletePublicKey(id: string, options?: any): AxiosPromise<void>;
|
|
6291
|
+
/**
|
|
6292
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
6293
|
+
* @summary Retrieve public key
|
|
6294
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
6295
|
+
* @param {*} [options] Override http request option.
|
|
6296
|
+
* @throws {RequiredError}
|
|
6297
|
+
*/
|
|
6298
|
+
getPublicKey(id: string, options?: any): AxiosPromise<CreatePublicKey200Response>;
|
|
6299
|
+
/**
|
|
6300
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
6301
|
+
* @summary List public keys
|
|
6302
|
+
* @param {*} [options] Override http request option.
|
|
6303
|
+
* @throws {RequiredError}
|
|
6304
|
+
*/
|
|
6305
|
+
listPublicKeys(options?: any): AxiosPromise<PublicKeysResponse>;
|
|
6306
|
+
/**
|
|
6307
|
+
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
6308
|
+
* @summary Test public key
|
|
6309
|
+
* @param {string} id ID of the public key to test
|
|
6310
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
6311
|
+
* @param {*} [options] Override http request option.
|
|
6312
|
+
* @throws {RequiredError}
|
|
6313
|
+
*/
|
|
6314
|
+
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: any): AxiosPromise<void>;
|
|
6315
|
+
};
|
|
6316
|
+
/**
|
|
6317
|
+
* PublicKeysApi - object-oriented interface
|
|
6318
|
+
* @export
|
|
6319
|
+
* @class PublicKeysApi
|
|
6320
|
+
* @extends {BaseAPI}
|
|
6321
|
+
*/
|
|
6322
|
+
export declare class PublicKeysApi extends BaseAPI {
|
|
6323
|
+
/**
|
|
6324
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
6325
|
+
* @summary Create public key
|
|
6326
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
6327
|
+
* @param {*} [options] Override http request option.
|
|
6328
|
+
* @throws {RequiredError}
|
|
6329
|
+
* @memberof PublicKeysApi
|
|
6330
|
+
*/
|
|
6331
|
+
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePublicKey200Response, any>>;
|
|
6332
|
+
/**
|
|
6333
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
6334
|
+
* @summary Delete public key
|
|
6335
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
6336
|
+
* @param {*} [options] Override http request option.
|
|
6337
|
+
* @throws {RequiredError}
|
|
6338
|
+
* @memberof PublicKeysApi
|
|
6339
|
+
*/
|
|
6340
|
+
deletePublicKey(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6341
|
+
/**
|
|
6342
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
6343
|
+
* @summary Retrieve public key
|
|
6344
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
6345
|
+
* @param {*} [options] Override http request option.
|
|
6346
|
+
* @throws {RequiredError}
|
|
6347
|
+
* @memberof PublicKeysApi
|
|
6348
|
+
*/
|
|
6349
|
+
getPublicKey(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePublicKey200Response, any>>;
|
|
6350
|
+
/**
|
|
6351
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
6352
|
+
* @summary List public keys
|
|
6353
|
+
* @param {*} [options] Override http request option.
|
|
6354
|
+
* @throws {RequiredError}
|
|
6355
|
+
* @memberof PublicKeysApi
|
|
6356
|
+
*/
|
|
6357
|
+
listPublicKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicKeysResponse, any>>;
|
|
6358
|
+
/**
|
|
6359
|
+
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
6360
|
+
* @summary Test public key
|
|
6361
|
+
* @param {string} id ID of the public key to test
|
|
6362
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
6363
|
+
* @param {*} [options] Override http request option.
|
|
6364
|
+
* @throws {RequiredError}
|
|
6365
|
+
* @memberof PublicKeysApi
|
|
6366
|
+
*/
|
|
6367
|
+
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6368
|
+
}
|
|
5546
6369
|
/**
|
|
5547
6370
|
* RewardsApi - axios parameter creator
|
|
5548
6371
|
* @export
|
|
@@ -5734,6 +6557,61 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5734
6557
|
*/
|
|
5735
6558
|
resendReward(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
5736
6559
|
}
|
|
6560
|
+
/**
|
|
6561
|
+
* RolesApi - axios parameter creator
|
|
6562
|
+
* @export
|
|
6563
|
+
*/
|
|
6564
|
+
export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6565
|
+
/**
|
|
6566
|
+
* List all available roles in the organization.
|
|
6567
|
+
* @summary List roles
|
|
6568
|
+
* @param {*} [options] Override http request option.
|
|
6569
|
+
* @throws {RequiredError}
|
|
6570
|
+
*/
|
|
6571
|
+
listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6572
|
+
};
|
|
6573
|
+
/**
|
|
6574
|
+
* RolesApi - functional programming interface
|
|
6575
|
+
* @export
|
|
6576
|
+
*/
|
|
6577
|
+
export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
6578
|
+
/**
|
|
6579
|
+
* List all available roles in the organization.
|
|
6580
|
+
* @summary List roles
|
|
6581
|
+
* @param {*} [options] Override http request option.
|
|
6582
|
+
* @throws {RequiredError}
|
|
6583
|
+
*/
|
|
6584
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRoles200Response>>;
|
|
6585
|
+
};
|
|
6586
|
+
/**
|
|
6587
|
+
* RolesApi - factory interface
|
|
6588
|
+
* @export
|
|
6589
|
+
*/
|
|
6590
|
+
export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6591
|
+
/**
|
|
6592
|
+
* List all available roles in the organization.
|
|
6593
|
+
* @summary List roles
|
|
6594
|
+
* @param {*} [options] Override http request option.
|
|
6595
|
+
* @throws {RequiredError}
|
|
6596
|
+
*/
|
|
6597
|
+
listRoles(options?: any): AxiosPromise<ListRoles200Response>;
|
|
6598
|
+
};
|
|
6599
|
+
/**
|
|
6600
|
+
* RolesApi - object-oriented interface
|
|
6601
|
+
* @export
|
|
6602
|
+
* @class RolesApi
|
|
6603
|
+
* @extends {BaseAPI}
|
|
6604
|
+
*/
|
|
6605
|
+
export declare class RolesApi extends BaseAPI {
|
|
6606
|
+
/**
|
|
6607
|
+
* List all available roles in the organization.
|
|
6608
|
+
* @summary List roles
|
|
6609
|
+
* @param {*} [options] Override http request option.
|
|
6610
|
+
* @throws {RequiredError}
|
|
6611
|
+
* @memberof RolesApi
|
|
6612
|
+
*/
|
|
6613
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRoles200Response, any>>;
|
|
6614
|
+
}
|
|
5737
6615
|
/**
|
|
5738
6616
|
* WebhooksApi - axios parameter creator
|
|
5739
6617
|
* @export
|
|
@@ -5747,6 +6625,14 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5747
6625
|
* @throws {RequiredError}
|
|
5748
6626
|
*/
|
|
5749
6627
|
createWebhook: (createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6628
|
+
/**
|
|
6629
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6630
|
+
* @summary Delete webhook
|
|
6631
|
+
* @param {string} id ID of the webhook to delete
|
|
6632
|
+
* @param {*} [options] Override http request option.
|
|
6633
|
+
* @throws {RequiredError}
|
|
6634
|
+
*/
|
|
6635
|
+
deleteWebhook: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5750
6636
|
/**
|
|
5751
6637
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5752
6638
|
* @summary Retrieve webhook
|
|
@@ -5793,6 +6679,14 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
|
5793
6679
|
* @throws {RequiredError}
|
|
5794
6680
|
*/
|
|
5795
6681
|
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWebhook200Response>>;
|
|
6682
|
+
/**
|
|
6683
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6684
|
+
* @summary Delete webhook
|
|
6685
|
+
* @param {string} id ID of the webhook to delete
|
|
6686
|
+
* @param {*} [options] Override http request option.
|
|
6687
|
+
* @throws {RequiredError}
|
|
6688
|
+
*/
|
|
6689
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5796
6690
|
/**
|
|
5797
6691
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5798
6692
|
* @summary Retrieve webhook
|
|
@@ -5839,6 +6733,14 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
5839
6733
|
* @throws {RequiredError}
|
|
5840
6734
|
*/
|
|
5841
6735
|
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: any): AxiosPromise<CreateWebhook200Response>;
|
|
6736
|
+
/**
|
|
6737
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6738
|
+
* @summary Delete webhook
|
|
6739
|
+
* @param {string} id ID of the webhook to delete
|
|
6740
|
+
* @param {*} [options] Override http request option.
|
|
6741
|
+
* @throws {RequiredError}
|
|
6742
|
+
*/
|
|
6743
|
+
deleteWebhook(id: string, options?: any): AxiosPromise<void>;
|
|
5842
6744
|
/**
|
|
5843
6745
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5844
6746
|
* @summary Retrieve webhook
|
|
@@ -5888,6 +6790,15 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
5888
6790
|
* @memberof WebhooksApi
|
|
5889
6791
|
*/
|
|
5890
6792
|
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWebhook200Response, any>>;
|
|
6793
|
+
/**
|
|
6794
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6795
|
+
* @summary Delete webhook
|
|
6796
|
+
* @param {string} id ID of the webhook to delete
|
|
6797
|
+
* @param {*} [options] Override http request option.
|
|
6798
|
+
* @throws {RequiredError}
|
|
6799
|
+
* @memberof WebhooksApi
|
|
6800
|
+
*/
|
|
6801
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5891
6802
|
/**
|
|
5892
6803
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5893
6804
|
* @summary Retrieve webhook
|