tremendous 3.1.0 β 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 +706 -73
- package/dist/api.js +712 -83
- package/package.json +3 -3
package/dist/api.d.ts
CHANGED
|
@@ -93,6 +93,49 @@ export interface Campaign {
|
|
|
93
93
|
*/
|
|
94
94
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
95
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;
|
|
138
|
+
}
|
|
96
139
|
/**
|
|
97
140
|
*
|
|
98
141
|
* @export
|
|
@@ -232,17 +275,12 @@ export interface CreateMember {
|
|
|
232
275
|
*/
|
|
233
276
|
'email': string;
|
|
234
277
|
/**
|
|
235
|
-
*
|
|
278
|
+
* The role ID of the member within the organization.
|
|
236
279
|
* @type {string}
|
|
237
280
|
* @memberof CreateMember
|
|
238
281
|
*/
|
|
239
|
-
'role':
|
|
282
|
+
'role': string;
|
|
240
283
|
}
|
|
241
|
-
export declare const CreateMemberRoleEnum: {
|
|
242
|
-
readonly Member: "MEMBER";
|
|
243
|
-
readonly Admin: "ADMIN";
|
|
244
|
-
};
|
|
245
|
-
export type CreateMemberRoleEnum = typeof CreateMemberRoleEnum[keyof typeof CreateMemberRoleEnum];
|
|
246
284
|
/**
|
|
247
285
|
*
|
|
248
286
|
* @export
|
|
@@ -269,17 +307,12 @@ export interface CreateMemberRequest {
|
|
|
269
307
|
*/
|
|
270
308
|
'email': string;
|
|
271
309
|
/**
|
|
272
|
-
*
|
|
310
|
+
* The role ID of the member within the organization.
|
|
273
311
|
* @type {string}
|
|
274
312
|
* @memberof CreateMemberRequest
|
|
275
313
|
*/
|
|
276
|
-
'role':
|
|
314
|
+
'role': string;
|
|
277
315
|
}
|
|
278
|
-
export declare const CreateMemberRequestRoleEnum: {
|
|
279
|
-
readonly Member: "MEMBER";
|
|
280
|
-
readonly Admin: "ADMIN";
|
|
281
|
-
};
|
|
282
|
-
export type CreateMemberRequestRoleEnum = typeof CreateMemberRequestRoleEnum[keyof typeof CreateMemberRequestRoleEnum];
|
|
283
316
|
/**
|
|
284
317
|
*
|
|
285
318
|
* @export
|
|
@@ -767,11 +800,17 @@ export interface CreateOrganizationRequestCopySettings {
|
|
|
767
800
|
*/
|
|
768
801
|
'security_settings'?: boolean;
|
|
769
802
|
/**
|
|
770
|
-
* 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`.
|
|
771
804
|
* @type {boolean}
|
|
772
805
|
* @memberof CreateOrganizationRequestCopySettings
|
|
773
806
|
*/
|
|
774
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;
|
|
775
814
|
/**
|
|
776
815
|
* Copy over the fraud prevention settings and rules from the current organization to the new organization. Defaults to `false`.
|
|
777
816
|
* @type {boolean}
|
|
@@ -779,6 +818,45 @@ export interface CreateOrganizationRequestCopySettings {
|
|
|
779
818
|
*/
|
|
780
819
|
'fraud_prevention'?: boolean;
|
|
781
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;
|
|
859
|
+
}
|
|
782
860
|
/**
|
|
783
861
|
*
|
|
784
862
|
* @export
|
|
@@ -1289,11 +1367,11 @@ export interface GetMember200ResponseMember {
|
|
|
1289
1367
|
*/
|
|
1290
1368
|
'active'?: boolean;
|
|
1291
1369
|
/**
|
|
1292
|
-
*
|
|
1370
|
+
* The role ID associated with the member within the organization.
|
|
1293
1371
|
* @type {string}
|
|
1294
1372
|
* @memberof GetMember200ResponseMember
|
|
1295
1373
|
*/
|
|
1296
|
-
'role'
|
|
1374
|
+
'role'?: string | null;
|
|
1297
1375
|
/**
|
|
1298
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`.
|
|
1299
1377
|
* @type {string}
|
|
@@ -1307,11 +1385,6 @@ export interface GetMember200ResponseMember {
|
|
|
1307
1385
|
*/
|
|
1308
1386
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
1309
1387
|
}
|
|
1310
|
-
export declare const GetMember200ResponseMemberRoleEnum: {
|
|
1311
|
-
readonly Member: "MEMBER";
|
|
1312
|
-
readonly Admin: "ADMIN";
|
|
1313
|
-
};
|
|
1314
|
-
export type GetMember200ResponseMemberRoleEnum = typeof GetMember200ResponseMemberRoleEnum[keyof typeof GetMember200ResponseMemberRoleEnum];
|
|
1315
1388
|
export declare const GetMember200ResponseMemberStatusEnum: {
|
|
1316
1389
|
readonly Registered: "REGISTERED";
|
|
1317
1390
|
readonly Invited: "INVITED";
|
|
@@ -1692,6 +1765,21 @@ export interface ListFields200ResponseFieldsInner {
|
|
|
1692
1765
|
*/
|
|
1693
1766
|
'scope'?: string;
|
|
1694
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
|
+
}
|
|
1695
1783
|
/**
|
|
1696
1784
|
*
|
|
1697
1785
|
* @export
|
|
@@ -1971,11 +2059,11 @@ export interface ListMembers200ResponseMembersInner {
|
|
|
1971
2059
|
*/
|
|
1972
2060
|
'active'?: boolean;
|
|
1973
2061
|
/**
|
|
1974
|
-
*
|
|
2062
|
+
* The role ID associated with the member within the organization.
|
|
1975
2063
|
* @type {string}
|
|
1976
2064
|
* @memberof ListMembers200ResponseMembersInner
|
|
1977
2065
|
*/
|
|
1978
|
-
'role'
|
|
2066
|
+
'role'?: string | null;
|
|
1979
2067
|
/**
|
|
1980
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`.
|
|
1981
2069
|
* @type {string}
|
|
@@ -1995,11 +2083,6 @@ export interface ListMembers200ResponseMembersInner {
|
|
|
1995
2083
|
*/
|
|
1996
2084
|
'last_login_at'?: string | null;
|
|
1997
2085
|
}
|
|
1998
|
-
export declare const ListMembers200ResponseMembersInnerRoleEnum: {
|
|
1999
|
-
readonly Member: "MEMBER";
|
|
2000
|
-
readonly Admin: "ADMIN";
|
|
2001
|
-
};
|
|
2002
|
-
export type ListMembers200ResponseMembersInnerRoleEnum = typeof ListMembers200ResponseMembersInnerRoleEnum[keyof typeof ListMembers200ResponseMembersInnerRoleEnum];
|
|
2003
2086
|
export declare const ListMembers200ResponseMembersInnerStatusEnum: {
|
|
2004
2087
|
readonly Registered: "REGISTERED";
|
|
2005
2088
|
readonly Invited: "INVITED";
|
|
@@ -2801,6 +2884,44 @@ export interface ListRewards429Response {
|
|
|
2801
2884
|
*/
|
|
2802
2885
|
'errors': ListRewards401ResponseErrors;
|
|
2803
2886
|
}
|
|
2887
|
+
/**
|
|
2888
|
+
*
|
|
2889
|
+
* @export
|
|
2890
|
+
* @interface ListRoles200Response
|
|
2891
|
+
*/
|
|
2892
|
+
export interface ListRoles200Response {
|
|
2893
|
+
/**
|
|
2894
|
+
*
|
|
2895
|
+
* @type {Array<ListRoles200ResponseRolesInner>}
|
|
2896
|
+
* @memberof ListRoles200Response
|
|
2897
|
+
*/
|
|
2898
|
+
'roles': Array<ListRoles200ResponseRolesInner>;
|
|
2899
|
+
}
|
|
2900
|
+
/**
|
|
2901
|
+
* Each organization member is assigned a role that defines the permissions they have within the organization.
|
|
2902
|
+
* @export
|
|
2903
|
+
* @interface ListRoles200ResponseRolesInner
|
|
2904
|
+
*/
|
|
2905
|
+
export interface ListRoles200ResponseRolesInner {
|
|
2906
|
+
/**
|
|
2907
|
+
*
|
|
2908
|
+
* @type {string}
|
|
2909
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2910
|
+
*/
|
|
2911
|
+
'id': string;
|
|
2912
|
+
/**
|
|
2913
|
+
*
|
|
2914
|
+
* @type {string}
|
|
2915
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2916
|
+
*/
|
|
2917
|
+
'title': string;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {string}
|
|
2921
|
+
* @memberof ListRoles200ResponseRolesInner
|
|
2922
|
+
*/
|
|
2923
|
+
'description': string;
|
|
2924
|
+
}
|
|
2804
2925
|
/**
|
|
2805
2926
|
*
|
|
2806
2927
|
* @export
|
|
@@ -2883,11 +3004,11 @@ export interface Member {
|
|
|
2883
3004
|
*/
|
|
2884
3005
|
'active'?: boolean;
|
|
2885
3006
|
/**
|
|
2886
|
-
*
|
|
3007
|
+
* The role ID associated with the member within the organization.
|
|
2887
3008
|
* @type {string}
|
|
2888
3009
|
* @memberof Member
|
|
2889
3010
|
*/
|
|
2890
|
-
'role'
|
|
3011
|
+
'role'?: string | null;
|
|
2891
3012
|
/**
|
|
2892
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`.
|
|
2893
3014
|
* @type {string}
|
|
@@ -2907,11 +3028,6 @@ export interface Member {
|
|
|
2907
3028
|
*/
|
|
2908
3029
|
'last_login_at'?: string | null;
|
|
2909
3030
|
}
|
|
2910
|
-
export declare const MemberRoleEnum: {
|
|
2911
|
-
readonly Member: "MEMBER";
|
|
2912
|
-
readonly Admin: "ADMIN";
|
|
2913
|
-
};
|
|
2914
|
-
export type MemberRoleEnum = typeof MemberRoleEnum[keyof typeof MemberRoleEnum];
|
|
2915
3031
|
export declare const MemberStatusEnum: {
|
|
2916
3032
|
readonly Registered: "REGISTERED";
|
|
2917
3033
|
readonly Invited: "INVITED";
|
|
@@ -2948,11 +3064,11 @@ export interface MemberBase {
|
|
|
2948
3064
|
*/
|
|
2949
3065
|
'active'?: boolean;
|
|
2950
3066
|
/**
|
|
2951
|
-
*
|
|
3067
|
+
* The role ID associated with the member within the organization.
|
|
2952
3068
|
* @type {string}
|
|
2953
3069
|
* @memberof MemberBase
|
|
2954
3070
|
*/
|
|
2955
|
-
'role'
|
|
3071
|
+
'role'?: string | null;
|
|
2956
3072
|
/**
|
|
2957
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`.
|
|
2958
3074
|
* @type {string}
|
|
@@ -2960,11 +3076,6 @@ export interface MemberBase {
|
|
|
2960
3076
|
*/
|
|
2961
3077
|
'status': MemberBaseStatusEnum;
|
|
2962
3078
|
}
|
|
2963
|
-
export declare const MemberBaseRoleEnum: {
|
|
2964
|
-
readonly Member: "MEMBER";
|
|
2965
|
-
readonly Admin: "ADMIN";
|
|
2966
|
-
};
|
|
2967
|
-
export type MemberBaseRoleEnum = typeof MemberBaseRoleEnum[keyof typeof MemberBaseRoleEnum];
|
|
2968
3079
|
export declare const MemberBaseStatusEnum: {
|
|
2969
3080
|
readonly Registered: "REGISTERED";
|
|
2970
3081
|
readonly Invited: "INVITED";
|
|
@@ -3001,11 +3112,11 @@ export interface MemberWithEvents {
|
|
|
3001
3112
|
*/
|
|
3002
3113
|
'active'?: boolean;
|
|
3003
3114
|
/**
|
|
3004
|
-
*
|
|
3115
|
+
* The role ID associated with the member within the organization.
|
|
3005
3116
|
* @type {string}
|
|
3006
3117
|
* @memberof MemberWithEvents
|
|
3007
3118
|
*/
|
|
3008
|
-
'role'
|
|
3119
|
+
'role'?: string | null;
|
|
3009
3120
|
/**
|
|
3010
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`.
|
|
3011
3122
|
* @type {string}
|
|
@@ -3019,11 +3130,6 @@ export interface MemberWithEvents {
|
|
|
3019
3130
|
*/
|
|
3020
3131
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
3021
3132
|
}
|
|
3022
|
-
export declare const MemberWithEventsRoleEnum: {
|
|
3023
|
-
readonly Member: "MEMBER";
|
|
3024
|
-
readonly Admin: "ADMIN";
|
|
3025
|
-
};
|
|
3026
|
-
export type MemberWithEventsRoleEnum = typeof MemberWithEventsRoleEnum[keyof typeof MemberWithEventsRoleEnum];
|
|
3027
3133
|
export declare const MemberWithEventsStatusEnum: {
|
|
3028
3134
|
readonly Registered: "REGISTERED";
|
|
3029
3135
|
readonly Invited: "INVITED";
|
|
@@ -3060,11 +3166,11 @@ export interface MemberWithoutEvents {
|
|
|
3060
3166
|
*/
|
|
3061
3167
|
'active'?: boolean;
|
|
3062
3168
|
/**
|
|
3063
|
-
*
|
|
3169
|
+
* The role ID associated with the member within the organization.
|
|
3064
3170
|
* @type {string}
|
|
3065
3171
|
* @memberof MemberWithoutEvents
|
|
3066
3172
|
*/
|
|
3067
|
-
'role'
|
|
3173
|
+
'role'?: string | null;
|
|
3068
3174
|
/**
|
|
3069
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`.
|
|
3070
3176
|
* @type {string}
|
|
@@ -3084,11 +3190,6 @@ export interface MemberWithoutEvents {
|
|
|
3084
3190
|
*/
|
|
3085
3191
|
'last_login_at'?: string | null;
|
|
3086
3192
|
}
|
|
3087
|
-
export declare const MemberWithoutEventsRoleEnum: {
|
|
3088
|
-
readonly Member: "MEMBER";
|
|
3089
|
-
readonly Admin: "ADMIN";
|
|
3090
|
-
};
|
|
3091
|
-
export type MemberWithoutEventsRoleEnum = typeof MemberWithoutEventsRoleEnum[keyof typeof MemberWithoutEventsRoleEnum];
|
|
3092
3193
|
export declare const MemberWithoutEventsStatusEnum: {
|
|
3093
3194
|
readonly Registered: "REGISTERED";
|
|
3094
3195
|
readonly Invited: "INVITED";
|
|
@@ -3929,6 +4030,69 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
3929
4030
|
readonly Zmk: "ZMK";
|
|
3930
4031
|
};
|
|
3931
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
|
+
}
|
|
3932
4096
|
/**
|
|
3933
4097
|
* Details of the recipient of the reward
|
|
3934
4098
|
* @export
|
|
@@ -4592,6 +4756,31 @@ export declare const RewardWithoutLinkDeliveryStatusEnum: {
|
|
|
4592
4756
|
readonly Pending: "PENDING";
|
|
4593
4757
|
};
|
|
4594
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
|
+
}
|
|
4595
4784
|
/**
|
|
4596
4785
|
*
|
|
4597
4786
|
* @export
|
|
@@ -4605,6 +4794,112 @@ export interface SimulateWebhookRequest {
|
|
|
4605
4794
|
*/
|
|
4606
4795
|
'event': string;
|
|
4607
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
|
+
}
|
|
4608
4903
|
/**
|
|
4609
4904
|
*
|
|
4610
4905
|
* @export
|
|
@@ -4746,11 +5041,11 @@ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
4746
5041
|
*
|
|
4747
5042
|
* @summary Update campaign
|
|
4748
5043
|
* @param {string} id ID of the campaign that should be updated
|
|
4749
|
-
* @param {
|
|
5044
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
4750
5045
|
* @param {*} [options] Override http request option.
|
|
4751
5046
|
* @throws {RequiredError}
|
|
4752
5047
|
*/
|
|
4753
|
-
updateCampaign: (id: string,
|
|
5048
|
+
updateCampaign: (id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4754
5049
|
};
|
|
4755
5050
|
/**
|
|
4756
5051
|
* CampaignsApi - functional programming interface
|
|
@@ -4784,11 +5079,11 @@ export declare const CampaignsApiFp: (configuration?: Configuration) => {
|
|
|
4784
5079
|
*
|
|
4785
5080
|
* @summary Update campaign
|
|
4786
5081
|
* @param {string} id ID of the campaign that should be updated
|
|
4787
|
-
* @param {
|
|
5082
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
4788
5083
|
* @param {*} [options] Override http request option.
|
|
4789
5084
|
* @throws {RequiredError}
|
|
4790
5085
|
*/
|
|
4791
|
-
updateCampaign(id: string,
|
|
5086
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCampaign201Response>>;
|
|
4792
5087
|
};
|
|
4793
5088
|
/**
|
|
4794
5089
|
* CampaignsApi - factory interface
|
|
@@ -4822,11 +5117,11 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
4822
5117
|
*
|
|
4823
5118
|
* @summary Update campaign
|
|
4824
5119
|
* @param {string} id ID of the campaign that should be updated
|
|
4825
|
-
* @param {
|
|
5120
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
4826
5121
|
* @param {*} [options] Override http request option.
|
|
4827
5122
|
* @throws {RequiredError}
|
|
4828
5123
|
*/
|
|
4829
|
-
updateCampaign(id: string,
|
|
5124
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: any): AxiosPromise<CreateCampaign201Response>;
|
|
4830
5125
|
};
|
|
4831
5126
|
/**
|
|
4832
5127
|
* CampaignsApi - object-oriented interface
|
|
@@ -4865,12 +5160,12 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
4865
5160
|
*
|
|
4866
5161
|
* @summary Update campaign
|
|
4867
5162
|
* @param {string} id ID of the campaign that should be updated
|
|
4868
|
-
* @param {
|
|
5163
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
4869
5164
|
* @param {*} [options] Override http request option.
|
|
4870
5165
|
* @throws {RequiredError}
|
|
4871
5166
|
* @memberof CampaignsApi
|
|
4872
5167
|
*/
|
|
4873
|
-
updateCampaign(id: string,
|
|
5168
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCampaign201Response, any>>;
|
|
4874
5169
|
}
|
|
4875
5170
|
/**
|
|
4876
5171
|
* FieldsApi - axios parameter creator
|
|
@@ -4927,6 +5222,65 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
4927
5222
|
*/
|
|
4928
5223
|
listFields(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFields200Response, any>>;
|
|
4929
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
|
+
}
|
|
4930
5284
|
/**
|
|
4931
5285
|
* FundingSourcesApi - axios parameter creator
|
|
4932
5286
|
* @export
|
|
@@ -5031,7 +5385,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5031
5385
|
/**
|
|
5032
5386
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
5033
5387
|
* @summary Delete invoice
|
|
5034
|
-
* @param {string} id ID of the invoice that should be
|
|
5388
|
+
* @param {string} id ID of the invoice that should be removed
|
|
5035
5389
|
* @param {*} [options] Override http request option.
|
|
5036
5390
|
* @throws {RequiredError}
|
|
5037
5391
|
*/
|
|
@@ -5086,7 +5440,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
5086
5440
|
/**
|
|
5087
5441
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
5088
5442
|
* @summary Delete invoice
|
|
5089
|
-
* @param {string} id ID of the invoice that should be
|
|
5443
|
+
* @param {string} id ID of the invoice that should be removed
|
|
5090
5444
|
* @param {*} [options] Override http request option.
|
|
5091
5445
|
* @throws {RequiredError}
|
|
5092
5446
|
*/
|
|
@@ -5141,7 +5495,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5141
5495
|
/**
|
|
5142
5496
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
5143
5497
|
* @summary Delete invoice
|
|
5144
|
-
* @param {string} id ID of the invoice that should be
|
|
5498
|
+
* @param {string} id ID of the invoice that should be removed
|
|
5145
5499
|
* @param {*} [options] Override http request option.
|
|
5146
5500
|
* @throws {RequiredError}
|
|
5147
5501
|
*/
|
|
@@ -5199,7 +5553,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
5199
5553
|
/**
|
|
5200
5554
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
5201
5555
|
* @summary Delete invoice
|
|
5202
|
-
* @param {string} id ID of the invoice that should be
|
|
5556
|
+
* @param {string} id ID of the invoice that should be removed
|
|
5203
5557
|
* @param {*} [options] Override http request option.
|
|
5204
5558
|
* @throws {RequiredError}
|
|
5205
5559
|
* @memberof InvoicesApi
|
|
@@ -5249,7 +5603,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
5249
5603
|
*/
|
|
5250
5604
|
export declare const MembersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5251
5605
|
/**
|
|
5252
|
-
* 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.
|
|
5253
5607
|
* @summary Create member
|
|
5254
5608
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5255
5609
|
* @param {*} [options] Override http request option.
|
|
@@ -5278,7 +5632,7 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5278
5632
|
*/
|
|
5279
5633
|
export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
5280
5634
|
/**
|
|
5281
|
-
* 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.
|
|
5282
5636
|
* @summary Create member
|
|
5283
5637
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5284
5638
|
* @param {*} [options] Override http request option.
|
|
@@ -5307,7 +5661,7 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
|
5307
5661
|
*/
|
|
5308
5662
|
export declare const MembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5309
5663
|
/**
|
|
5310
|
-
* 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.
|
|
5311
5665
|
* @summary Create member
|
|
5312
5666
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5313
5667
|
* @param {*} [options] Override http request option.
|
|
@@ -5338,7 +5692,7 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
5338
5692
|
*/
|
|
5339
5693
|
export declare class MembersApi extends BaseAPI {
|
|
5340
5694
|
/**
|
|
5341
|
-
* 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.
|
|
5342
5696
|
* @summary Create member
|
|
5343
5697
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
5344
5698
|
* @param {*} [options] Override http request option.
|
|
@@ -5821,6 +6175,197 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
5821
6175
|
*/
|
|
5822
6176
|
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductsResponse, any>>;
|
|
5823
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
|
+
}
|
|
5824
6369
|
/**
|
|
5825
6370
|
* RewardsApi - axios parameter creator
|
|
5826
6371
|
* @export
|
|
@@ -6012,6 +6557,61 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
6012
6557
|
*/
|
|
6013
6558
|
resendReward(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
6014
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
|
+
}
|
|
6015
6615
|
/**
|
|
6016
6616
|
* WebhooksApi - axios parameter creator
|
|
6017
6617
|
* @export
|
|
@@ -6025,6 +6625,14 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6025
6625
|
* @throws {RequiredError}
|
|
6026
6626
|
*/
|
|
6027
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>;
|
|
6028
6636
|
/**
|
|
6029
6637
|
* > π Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6030
6638
|
* @summary Retrieve webhook
|
|
@@ -6071,6 +6679,14 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
|
6071
6679
|
* @throws {RequiredError}
|
|
6072
6680
|
*/
|
|
6073
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>>;
|
|
6074
6690
|
/**
|
|
6075
6691
|
* > π Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6076
6692
|
* @summary Retrieve webhook
|
|
@@ -6117,6 +6733,14 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6117
6733
|
* @throws {RequiredError}
|
|
6118
6734
|
*/
|
|
6119
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>;
|
|
6120
6744
|
/**
|
|
6121
6745
|
* > π Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6122
6746
|
* @summary Retrieve webhook
|
|
@@ -6166,6 +6790,15 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
6166
6790
|
* @memberof WebhooksApi
|
|
6167
6791
|
*/
|
|
6168
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>>;
|
|
6169
6802
|
/**
|
|
6170
6803
|
* > π Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6171
6804
|
* @summary Retrieve webhook
|