@faable/auth-sdk 1.0.13 → 1.0.15
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/FaableAuthApi.d.ts +57 -1
- package/dist/FaableAuthApi.js +6 -0
- package/dist/types/api.d.ts +1911 -0
- package/dist/types/api.js +6 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/index.js +2 -0
- package/package.json +4 -2
- package/tsconfig.json +2 -1
|
@@ -0,0 +1,1911 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/account/current": {
|
|
7
|
+
/**
|
|
8
|
+
* Get current Account
|
|
9
|
+
* @description Get current Account
|
|
10
|
+
*/
|
|
11
|
+
get: {
|
|
12
|
+
responses: {
|
|
13
|
+
/** @description Default Response */
|
|
14
|
+
200: {
|
|
15
|
+
content: {
|
|
16
|
+
"application/json": components["schemas"]["AuthAccount"];
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
"/account": {
|
|
23
|
+
/**
|
|
24
|
+
* List Auth Accounts
|
|
25
|
+
* @description List Auth Accounts
|
|
26
|
+
*/
|
|
27
|
+
get: {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: {
|
|
30
|
+
/** @description Start from this cursor */
|
|
31
|
+
cursor?: string;
|
|
32
|
+
/** @description Size of the results array */
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
responses: {
|
|
37
|
+
/** @description Default Response */
|
|
38
|
+
200: {
|
|
39
|
+
content: {
|
|
40
|
+
"application/json": components["schemas"]["AuthAccountPage"];
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Create an Account
|
|
47
|
+
* @description Create an Account
|
|
48
|
+
*/
|
|
49
|
+
post: {
|
|
50
|
+
requestBody?: {
|
|
51
|
+
content: {
|
|
52
|
+
"application/json": components["schemas"]["AuthAccountCreate"];
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
responses: {
|
|
56
|
+
/** @description Default Response */
|
|
57
|
+
201: {
|
|
58
|
+
content: {
|
|
59
|
+
"application/json": components["schemas"]["AuthAccount"];
|
|
60
|
+
};
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
};
|
|
65
|
+
"/account/{account_id}": {
|
|
66
|
+
/**
|
|
67
|
+
* Get Account
|
|
68
|
+
* @description Get Account
|
|
69
|
+
*/
|
|
70
|
+
get: {
|
|
71
|
+
parameters: {
|
|
72
|
+
path: {
|
|
73
|
+
account_id: string;
|
|
74
|
+
};
|
|
75
|
+
};
|
|
76
|
+
responses: {
|
|
77
|
+
/** @description AuthAccount */
|
|
78
|
+
200: {
|
|
79
|
+
content: {
|
|
80
|
+
"application/json": {
|
|
81
|
+
/** @description AuthAccount ID */
|
|
82
|
+
id: string;
|
|
83
|
+
name: string;
|
|
84
|
+
domain: string;
|
|
85
|
+
logo_src?: string | null;
|
|
86
|
+
callback_hostnames: string[];
|
|
87
|
+
token_signature: string;
|
|
88
|
+
default_connection?: unknown;
|
|
89
|
+
default_locale: string;
|
|
90
|
+
/** @description AuthAccount creation date */
|
|
91
|
+
createdAt: string;
|
|
92
|
+
/** @description AuthAccount updated date */
|
|
93
|
+
updatedAt?: string;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
"/account/host/{host}": {
|
|
101
|
+
/**
|
|
102
|
+
* Find account by host
|
|
103
|
+
* @description Find account by host
|
|
104
|
+
*/
|
|
105
|
+
get: {
|
|
106
|
+
parameters: {
|
|
107
|
+
path: {
|
|
108
|
+
host: string;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
responses: {
|
|
112
|
+
/** @description AuthAccount */
|
|
113
|
+
200: {
|
|
114
|
+
content: {
|
|
115
|
+
"application/json": {
|
|
116
|
+
/** @description AuthAccount ID */
|
|
117
|
+
id: string;
|
|
118
|
+
name: string;
|
|
119
|
+
domain: string;
|
|
120
|
+
logo_src?: string | null;
|
|
121
|
+
callback_hostnames: string[];
|
|
122
|
+
token_signature: string;
|
|
123
|
+
default_connection?: unknown;
|
|
124
|
+
default_locale: string;
|
|
125
|
+
/** @description AuthAccount creation date */
|
|
126
|
+
createdAt: string;
|
|
127
|
+
/** @description AuthAccount updated date */
|
|
128
|
+
updatedAt?: string;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
"/connection": {
|
|
136
|
+
/**
|
|
137
|
+
* List Connections in Account
|
|
138
|
+
* @description List Connections in Account
|
|
139
|
+
*/
|
|
140
|
+
get: operations["connection/list"];
|
|
141
|
+
post: {
|
|
142
|
+
requestBody?: {
|
|
143
|
+
content: {
|
|
144
|
+
"application/json": components["schemas"]["ConnectionCreate"];
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
responses: {
|
|
148
|
+
/** @description Default Response */
|
|
149
|
+
200: {
|
|
150
|
+
content: {
|
|
151
|
+
"application/json": components["schemas"]["Connection"];
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
"/connection/{connection_id}": {
|
|
158
|
+
/**
|
|
159
|
+
* Get Connection in Account
|
|
160
|
+
* @description Get Connection in Account
|
|
161
|
+
*/
|
|
162
|
+
get: operations["connection/get"];
|
|
163
|
+
/**
|
|
164
|
+
* Delete Connection in Account
|
|
165
|
+
* @description Delete Connection in Account
|
|
166
|
+
*/
|
|
167
|
+
delete: operations["connection/remove"];
|
|
168
|
+
};
|
|
169
|
+
"/keys/rotate": {
|
|
170
|
+
/**
|
|
171
|
+
* Rotate Account Keys
|
|
172
|
+
* @description Rotate Account Keys
|
|
173
|
+
*/
|
|
174
|
+
post: {
|
|
175
|
+
requestBody?: {
|
|
176
|
+
content: {
|
|
177
|
+
"application/json": Record<string, never>;
|
|
178
|
+
};
|
|
179
|
+
};
|
|
180
|
+
responses: {
|
|
181
|
+
/** @description Default Response */
|
|
182
|
+
200: {
|
|
183
|
+
content: never;
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
"/passwordless/start": {
|
|
189
|
+
/**
|
|
190
|
+
* Start Passwordless authentication flow
|
|
191
|
+
* @description Start Passwordless authentication flow
|
|
192
|
+
*/
|
|
193
|
+
post: operations["passwordless/start"];
|
|
194
|
+
};
|
|
195
|
+
"/passwordless/magic": {
|
|
196
|
+
/** @description Receive a passwordless token and convert it to a valid session */
|
|
197
|
+
get: operations["passwordless/login"];
|
|
198
|
+
};
|
|
199
|
+
"/me": {
|
|
200
|
+
/**
|
|
201
|
+
* Introspection endpoint for current User in session
|
|
202
|
+
* @description Introspection endpoint for current User in session
|
|
203
|
+
*/
|
|
204
|
+
get: {
|
|
205
|
+
responses: {
|
|
206
|
+
/** @description Default Response */
|
|
207
|
+
200: {
|
|
208
|
+
content: {
|
|
209
|
+
"application/json": components["schemas"]["User"];
|
|
210
|
+
};
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
"/logout": {
|
|
216
|
+
/**
|
|
217
|
+
* Logout current user
|
|
218
|
+
* @description Logout current user
|
|
219
|
+
*/
|
|
220
|
+
get: {
|
|
221
|
+
parameters: {
|
|
222
|
+
query?: {
|
|
223
|
+
client_id?: string;
|
|
224
|
+
returnTo?: string;
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
responses: {
|
|
228
|
+
/** @description Default Response */
|
|
229
|
+
200: {
|
|
230
|
+
content: never;
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
};
|
|
235
|
+
"/client": {
|
|
236
|
+
/**
|
|
237
|
+
* List Clients in Account
|
|
238
|
+
* @description List Clients in Account
|
|
239
|
+
*/
|
|
240
|
+
get: operations["client/list"];
|
|
241
|
+
/**
|
|
242
|
+
* Create an OAuth Client
|
|
243
|
+
* @description Create an OAuth Client
|
|
244
|
+
*/
|
|
245
|
+
post: {
|
|
246
|
+
requestBody?: {
|
|
247
|
+
content: {
|
|
248
|
+
"application/json": components["schemas"]["ClientCreate"];
|
|
249
|
+
};
|
|
250
|
+
};
|
|
251
|
+
responses: {
|
|
252
|
+
/** @description Default Response */
|
|
253
|
+
201: {
|
|
254
|
+
content: {
|
|
255
|
+
"application/json": components["schemas"]["Client"];
|
|
256
|
+
};
|
|
257
|
+
};
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
"/client/{client_id}": {
|
|
262
|
+
/**
|
|
263
|
+
* Get Client in Account
|
|
264
|
+
* @description Get Client in Account
|
|
265
|
+
*/
|
|
266
|
+
get: operations["client/get"];
|
|
267
|
+
/**
|
|
268
|
+
* Delete Client in Account
|
|
269
|
+
* @description Delete Client in Account
|
|
270
|
+
*/
|
|
271
|
+
delete: operations["client/remove"];
|
|
272
|
+
};
|
|
273
|
+
"/authorize": {
|
|
274
|
+
/**
|
|
275
|
+
* Authorization request
|
|
276
|
+
* @description Authorization request
|
|
277
|
+
*/
|
|
278
|
+
get: operations["authorize"];
|
|
279
|
+
};
|
|
280
|
+
"/oauth/token": {
|
|
281
|
+
/**
|
|
282
|
+
* Token exchange
|
|
283
|
+
* @description Token exchange
|
|
284
|
+
*/
|
|
285
|
+
post: {
|
|
286
|
+
requestBody?: {
|
|
287
|
+
content: {
|
|
288
|
+
"application/json": components["schemas"]["OAuthToken Body"];
|
|
289
|
+
};
|
|
290
|
+
};
|
|
291
|
+
responses: {
|
|
292
|
+
/** @description Default Response */
|
|
293
|
+
200: {
|
|
294
|
+
content: never;
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
"/callback": {
|
|
300
|
+
/**
|
|
301
|
+
* OAuth2 Callback URL
|
|
302
|
+
* @description OAuth2 Callback URL
|
|
303
|
+
*/
|
|
304
|
+
get: operations["callback"];
|
|
305
|
+
};
|
|
306
|
+
"/.well-known/openid-configuration": {
|
|
307
|
+
/**
|
|
308
|
+
* OpenID Discovery
|
|
309
|
+
* @description OpenID Discovery
|
|
310
|
+
*/
|
|
311
|
+
get: {
|
|
312
|
+
responses: {
|
|
313
|
+
/** @description Default Response */
|
|
314
|
+
200: {
|
|
315
|
+
content: never;
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
"/.well-known/jwks.json": {
|
|
321
|
+
/**
|
|
322
|
+
* JWKS endpoint
|
|
323
|
+
* @description JWKS endpoint
|
|
324
|
+
*/
|
|
325
|
+
get: {
|
|
326
|
+
responses: {
|
|
327
|
+
/** @description Default Response */
|
|
328
|
+
200: {
|
|
329
|
+
content: never;
|
|
330
|
+
};
|
|
331
|
+
};
|
|
332
|
+
};
|
|
333
|
+
};
|
|
334
|
+
"/usernamepassword/login": {
|
|
335
|
+
post: {
|
|
336
|
+
requestBody?: {
|
|
337
|
+
content: {
|
|
338
|
+
"application/json": components["schemas"]["UsernamepasswordLoginBody"];
|
|
339
|
+
};
|
|
340
|
+
};
|
|
341
|
+
responses: {
|
|
342
|
+
/** @description Default Response */
|
|
343
|
+
200: {
|
|
344
|
+
content: never;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
};
|
|
349
|
+
"/login/callback": {
|
|
350
|
+
post: {
|
|
351
|
+
requestBody?: {
|
|
352
|
+
content: {
|
|
353
|
+
"application/json": components["schemas"]["LoginCallbackBody"];
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
responses: {
|
|
357
|
+
/** @description Default Response */
|
|
358
|
+
200: {
|
|
359
|
+
content: never;
|
|
360
|
+
};
|
|
361
|
+
};
|
|
362
|
+
};
|
|
363
|
+
};
|
|
364
|
+
"/user": {
|
|
365
|
+
/**
|
|
366
|
+
* List Users in Account
|
|
367
|
+
* @description List Users in Account
|
|
368
|
+
*/
|
|
369
|
+
get: operations["user/list"];
|
|
370
|
+
/**
|
|
371
|
+
* Create a user
|
|
372
|
+
* @description Create a user
|
|
373
|
+
*/
|
|
374
|
+
post: operations["user/create"];
|
|
375
|
+
};
|
|
376
|
+
"/user/{user_id}": {
|
|
377
|
+
/**
|
|
378
|
+
* Get User in Account
|
|
379
|
+
* @description Get User in Account
|
|
380
|
+
*/
|
|
381
|
+
get: operations["user/get"];
|
|
382
|
+
/**
|
|
383
|
+
* Update a user
|
|
384
|
+
* @description Update a user
|
|
385
|
+
*/
|
|
386
|
+
post: operations["user/update"];
|
|
387
|
+
/**
|
|
388
|
+
* Delete User in Account
|
|
389
|
+
* @description Delete User in Account
|
|
390
|
+
*/
|
|
391
|
+
delete: operations["user/remove"];
|
|
392
|
+
};
|
|
393
|
+
"/identity": {
|
|
394
|
+
/**
|
|
395
|
+
* List Identitys in Account
|
|
396
|
+
* @description List Identitys in Account
|
|
397
|
+
*/
|
|
398
|
+
get: operations["identity/list"];
|
|
399
|
+
};
|
|
400
|
+
"/identity/{identity_id}": {
|
|
401
|
+
/**
|
|
402
|
+
* Get Identity in Account
|
|
403
|
+
* @description Get Identity in Account
|
|
404
|
+
*/
|
|
405
|
+
get: operations["identity/get"];
|
|
406
|
+
/**
|
|
407
|
+
* Delete Identity in Account
|
|
408
|
+
* @description Delete Identity in Account
|
|
409
|
+
*/
|
|
410
|
+
delete: operations["identity/remove"];
|
|
411
|
+
};
|
|
412
|
+
"/role": {
|
|
413
|
+
/**
|
|
414
|
+
* List Roles in Account
|
|
415
|
+
* @description List Roles in Account
|
|
416
|
+
*/
|
|
417
|
+
get: operations["role/list"];
|
|
418
|
+
/**
|
|
419
|
+
* Create a Role
|
|
420
|
+
* @description Create a Role
|
|
421
|
+
*/
|
|
422
|
+
post: operations["role/create"];
|
|
423
|
+
};
|
|
424
|
+
"/role/{role_id}/users": {
|
|
425
|
+
/**
|
|
426
|
+
* List Users with Role
|
|
427
|
+
* @description List Users with Role
|
|
428
|
+
*/
|
|
429
|
+
get: operations["role/users"];
|
|
430
|
+
/**
|
|
431
|
+
* Assign Users to Role
|
|
432
|
+
* @description Assign Users to Role
|
|
433
|
+
*/
|
|
434
|
+
post: operations["role/assign_users"];
|
|
435
|
+
};
|
|
436
|
+
"/role/{role_id}": {
|
|
437
|
+
/**
|
|
438
|
+
* Get Role in Account
|
|
439
|
+
* @description Get Role in Account
|
|
440
|
+
*/
|
|
441
|
+
get: operations["role/get"];
|
|
442
|
+
/**
|
|
443
|
+
* Delete Role in Account
|
|
444
|
+
* @description Delete Role in Account
|
|
445
|
+
*/
|
|
446
|
+
delete: operations["role/remove"];
|
|
447
|
+
};
|
|
448
|
+
"/team": {
|
|
449
|
+
/**
|
|
450
|
+
* List Teams in Account
|
|
451
|
+
* @description List Teams in Account
|
|
452
|
+
*/
|
|
453
|
+
get: operations["team/list"];
|
|
454
|
+
/**
|
|
455
|
+
* Create a Team
|
|
456
|
+
* @description Create a Team
|
|
457
|
+
*/
|
|
458
|
+
post: {
|
|
459
|
+
requestBody?: {
|
|
460
|
+
content: {
|
|
461
|
+
"application/json": components["schemas"]["TeamCreate"];
|
|
462
|
+
};
|
|
463
|
+
};
|
|
464
|
+
responses: {
|
|
465
|
+
/** @description Default Response */
|
|
466
|
+
201: {
|
|
467
|
+
content: {
|
|
468
|
+
"application/json": components["schemas"]["Team"];
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
};
|
|
474
|
+
"/team/{team_id}": {
|
|
475
|
+
/**
|
|
476
|
+
* Get Team in Account
|
|
477
|
+
* @description Get Team in Account
|
|
478
|
+
*/
|
|
479
|
+
get: operations["team/get"];
|
|
480
|
+
/**
|
|
481
|
+
* Update a team
|
|
482
|
+
* @description Update a team
|
|
483
|
+
*/
|
|
484
|
+
post: operations["team/update"];
|
|
485
|
+
/**
|
|
486
|
+
* Delete Team in Account
|
|
487
|
+
* @description Delete Team in Account
|
|
488
|
+
*/
|
|
489
|
+
delete: operations["team/remove"];
|
|
490
|
+
};
|
|
491
|
+
"/member": {
|
|
492
|
+
/**
|
|
493
|
+
* List Members in Account
|
|
494
|
+
* @description List Members in Account
|
|
495
|
+
*/
|
|
496
|
+
get: operations["member/list"];
|
|
497
|
+
};
|
|
498
|
+
"/member/{member_id}": {
|
|
499
|
+
/**
|
|
500
|
+
* Get Member in Account
|
|
501
|
+
* @description Get Member in Account
|
|
502
|
+
*/
|
|
503
|
+
get: operations["member/get"];
|
|
504
|
+
/**
|
|
505
|
+
* Delete Member in Account
|
|
506
|
+
* @description Delete Member in Account
|
|
507
|
+
*/
|
|
508
|
+
delete: operations["member/remove"];
|
|
509
|
+
};
|
|
510
|
+
"/team/{team_id}/member": {
|
|
511
|
+
/**
|
|
512
|
+
* List Team Members
|
|
513
|
+
* @description List Team Members
|
|
514
|
+
*/
|
|
515
|
+
get: {
|
|
516
|
+
parameters: {
|
|
517
|
+
query?: {
|
|
518
|
+
/** @description Start from this cursor */
|
|
519
|
+
cursor?: string;
|
|
520
|
+
/** @description Size of the results array */
|
|
521
|
+
pageSize?: number;
|
|
522
|
+
};
|
|
523
|
+
path: {
|
|
524
|
+
team_id: string;
|
|
525
|
+
};
|
|
526
|
+
};
|
|
527
|
+
responses: {
|
|
528
|
+
/** @description Default Response */
|
|
529
|
+
200: {
|
|
530
|
+
content: {
|
|
531
|
+
"application/json": components["schemas"]["TeamMemberPage"];
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
/**
|
|
537
|
+
* Add Users as Team Members
|
|
538
|
+
* @description Add Users as Team Members
|
|
539
|
+
*/
|
|
540
|
+
post: {
|
|
541
|
+
parameters: {
|
|
542
|
+
path: {
|
|
543
|
+
team_id: string;
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
requestBody?: {
|
|
547
|
+
content: {
|
|
548
|
+
"application/json": components["schemas"]["TeamMemberCreate"];
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
responses: {
|
|
552
|
+
/** @description Default Response */
|
|
553
|
+
200: {
|
|
554
|
+
content: never;
|
|
555
|
+
};
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
"/team/{team_id}/member/check/{user_id}": {
|
|
560
|
+
/**
|
|
561
|
+
* Check user is member of Team
|
|
562
|
+
* @description Check user is member of Team
|
|
563
|
+
*/
|
|
564
|
+
get: {
|
|
565
|
+
parameters: {
|
|
566
|
+
query?: {
|
|
567
|
+
/** @description Start from this cursor */
|
|
568
|
+
cursor?: string;
|
|
569
|
+
/** @description Size of the results array */
|
|
570
|
+
pageSize?: number;
|
|
571
|
+
};
|
|
572
|
+
path: {
|
|
573
|
+
team_id: string;
|
|
574
|
+
user_id: string;
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
responses: {
|
|
578
|
+
/** @description Default Response */
|
|
579
|
+
200: {
|
|
580
|
+
content: {
|
|
581
|
+
"application/json": components["schemas"]["TeamMember"];
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
"/webhook": {
|
|
588
|
+
/**
|
|
589
|
+
* List Webhooks in Account
|
|
590
|
+
* @description List Webhooks in Account
|
|
591
|
+
*/
|
|
592
|
+
get: operations["webhook/list"];
|
|
593
|
+
/**
|
|
594
|
+
* Create a Webhook
|
|
595
|
+
* @description Create a Webhook
|
|
596
|
+
*/
|
|
597
|
+
post: {
|
|
598
|
+
requestBody?: {
|
|
599
|
+
content: {
|
|
600
|
+
"application/json": components["schemas"]["WebhookCreate"];
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
responses: {
|
|
604
|
+
/** @description Default Response */
|
|
605
|
+
201: {
|
|
606
|
+
content: {
|
|
607
|
+
"application/json": components["schemas"]["Webhook"];
|
|
608
|
+
};
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
};
|
|
612
|
+
};
|
|
613
|
+
"/webhook/{webhook_id}": {
|
|
614
|
+
/**
|
|
615
|
+
* Get Webhook in Account
|
|
616
|
+
* @description Get Webhook in Account
|
|
617
|
+
*/
|
|
618
|
+
get: operations["webhook/get"];
|
|
619
|
+
/**
|
|
620
|
+
* Delete Webhook in Account
|
|
621
|
+
* @description Delete Webhook in Account
|
|
622
|
+
*/
|
|
623
|
+
delete: operations["webhook/remove"];
|
|
624
|
+
};
|
|
625
|
+
"/api": {
|
|
626
|
+
/**
|
|
627
|
+
* List Apis in Account
|
|
628
|
+
* @description List Apis in Account
|
|
629
|
+
*/
|
|
630
|
+
get: operations["api/list"];
|
|
631
|
+
/**
|
|
632
|
+
* Create an API
|
|
633
|
+
* @description Create an API
|
|
634
|
+
*/
|
|
635
|
+
post: {
|
|
636
|
+
requestBody?: {
|
|
637
|
+
content: {
|
|
638
|
+
"application/json": components["schemas"]["ApiCreate"];
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
responses: {
|
|
642
|
+
/** @description Default Response */
|
|
643
|
+
201: {
|
|
644
|
+
content: {
|
|
645
|
+
"application/json": components["schemas"]["Api"];
|
|
646
|
+
};
|
|
647
|
+
};
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
};
|
|
651
|
+
"/api/{api_id}": {
|
|
652
|
+
/**
|
|
653
|
+
* Get Api in Account
|
|
654
|
+
* @description Get Api in Account
|
|
655
|
+
*/
|
|
656
|
+
get: operations["api/get"];
|
|
657
|
+
/**
|
|
658
|
+
* Delete Api in Account
|
|
659
|
+
* @description Delete Api in Account
|
|
660
|
+
*/
|
|
661
|
+
delete: operations["api/remove"];
|
|
662
|
+
};
|
|
663
|
+
}
|
|
664
|
+
export type webhooks = Record<string, never>;
|
|
665
|
+
export interface components {
|
|
666
|
+
schemas: {
|
|
667
|
+
/** @description AuthAccount */
|
|
668
|
+
AuthAccount: {
|
|
669
|
+
/** @description AuthAccount ID */
|
|
670
|
+
id: string;
|
|
671
|
+
name: string;
|
|
672
|
+
domain: string;
|
|
673
|
+
logo_src?: string | null;
|
|
674
|
+
callback_hostnames: string[];
|
|
675
|
+
token_signature: string;
|
|
676
|
+
default_connection?: unknown;
|
|
677
|
+
default_locale: string;
|
|
678
|
+
/** @description AuthAccount creation date */
|
|
679
|
+
createdAt: string;
|
|
680
|
+
/** @description AuthAccount updated date */
|
|
681
|
+
updatedAt?: string;
|
|
682
|
+
};
|
|
683
|
+
/** @description AuthAccount paginated response */
|
|
684
|
+
AuthAccountPage: {
|
|
685
|
+
/** @description next cursor */
|
|
686
|
+
next: string | null;
|
|
687
|
+
/** @description list of results */
|
|
688
|
+
results: components["schemas"]["AuthAccount"][];
|
|
689
|
+
};
|
|
690
|
+
/** @description AuthAccountCreate */
|
|
691
|
+
AuthAccountCreate: {
|
|
692
|
+
name: string;
|
|
693
|
+
email: string;
|
|
694
|
+
logo_src?: string;
|
|
695
|
+
callback_hostnames: string[];
|
|
696
|
+
default_connection?: string;
|
|
697
|
+
metadata?: {
|
|
698
|
+
[key: string]: unknown;
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
/** @description Connection */
|
|
702
|
+
Connection: {
|
|
703
|
+
/** @description Connection ID */
|
|
704
|
+
id: string;
|
|
705
|
+
connection_name: string;
|
|
706
|
+
connection_type: string;
|
|
707
|
+
authorize_url?: string | null;
|
|
708
|
+
client_id: string;
|
|
709
|
+
client_secret: string;
|
|
710
|
+
scope: string[];
|
|
711
|
+
/** @description Authorize params */
|
|
712
|
+
authorize_params: {
|
|
713
|
+
[key: string]: string;
|
|
714
|
+
};
|
|
715
|
+
/** @description Connection creation date */
|
|
716
|
+
account: string;
|
|
717
|
+
/** @description Connection creation date */
|
|
718
|
+
createdAt: string;
|
|
719
|
+
/** @description Connection updated date */
|
|
720
|
+
updatedAt?: string;
|
|
721
|
+
};
|
|
722
|
+
/** @description ConnectionCreate */
|
|
723
|
+
ConnectionCreate: {
|
|
724
|
+
connection_name: string;
|
|
725
|
+
connection_type: "github" | "google_oauth2" | "database" | "custom";
|
|
726
|
+
authorize_url?: string;
|
|
727
|
+
client_id?: string;
|
|
728
|
+
client_secret?: string;
|
|
729
|
+
scope?: string[];
|
|
730
|
+
/** @description Authorize params */
|
|
731
|
+
authorize_params?: {
|
|
732
|
+
[key: string]: string;
|
|
733
|
+
};
|
|
734
|
+
metadata?: {
|
|
735
|
+
[key: string]: unknown;
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
/** @description Connection paginated response */
|
|
739
|
+
ConnectionPage: {
|
|
740
|
+
/** @description next cursor */
|
|
741
|
+
next: string | null;
|
|
742
|
+
/** @description list of results */
|
|
743
|
+
results: components["schemas"]["Connection"][];
|
|
744
|
+
};
|
|
745
|
+
/** @description Client */
|
|
746
|
+
Client: {
|
|
747
|
+
/** @description Client ID */
|
|
748
|
+
id: string;
|
|
749
|
+
name: string;
|
|
750
|
+
description: string;
|
|
751
|
+
client_id: string;
|
|
752
|
+
client_secret: string;
|
|
753
|
+
callbacks: string[];
|
|
754
|
+
logout_urls: string[];
|
|
755
|
+
refresh_token: {
|
|
756
|
+
expiration_mode: "expire" | "not-expire";
|
|
757
|
+
infinite_token_lifetime: boolean;
|
|
758
|
+
token_lifetime: number;
|
|
759
|
+
};
|
|
760
|
+
/** @description Client creation date */
|
|
761
|
+
account: string;
|
|
762
|
+
/** @description Client creation date */
|
|
763
|
+
createdAt: string;
|
|
764
|
+
/** @description Client updated date */
|
|
765
|
+
updatedAt?: string;
|
|
766
|
+
};
|
|
767
|
+
/** @description ClientCreate */
|
|
768
|
+
ClientCreate: {
|
|
769
|
+
name: string;
|
|
770
|
+
description?: string;
|
|
771
|
+
callbacks?: string[];
|
|
772
|
+
logout_urls?: string[];
|
|
773
|
+
metadata?: {
|
|
774
|
+
[key: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
/** @description Client paginated response */
|
|
778
|
+
ClientPage: {
|
|
779
|
+
/** @description next cursor */
|
|
780
|
+
next: string | null;
|
|
781
|
+
/** @description list of results */
|
|
782
|
+
results: components["schemas"]["Client"][];
|
|
783
|
+
};
|
|
784
|
+
/** @description User */
|
|
785
|
+
User: {
|
|
786
|
+
/** @description User ID */
|
|
787
|
+
id: string;
|
|
788
|
+
/** @description User name */
|
|
789
|
+
name?: string | null;
|
|
790
|
+
/** @description unique username for this user */
|
|
791
|
+
username?: string | null;
|
|
792
|
+
/** @description Given name */
|
|
793
|
+
given_name?: string | null;
|
|
794
|
+
/** @description Family name */
|
|
795
|
+
family_name?: string | null;
|
|
796
|
+
/** @description User email */
|
|
797
|
+
email?: string | null;
|
|
798
|
+
/** @description true if email is verified */
|
|
799
|
+
email_verified: boolean;
|
|
800
|
+
/** @description contact phone number */
|
|
801
|
+
phone?: string | null;
|
|
802
|
+
/** @description phone is verified */
|
|
803
|
+
phone_verified: boolean;
|
|
804
|
+
/** @description country iso code */
|
|
805
|
+
country_iso?: string | null;
|
|
806
|
+
/** @description user birth_date */
|
|
807
|
+
birth_date?: string | null;
|
|
808
|
+
/** @description user main language */
|
|
809
|
+
locale: string;
|
|
810
|
+
/** @description customer region */
|
|
811
|
+
region?: string | null;
|
|
812
|
+
/** @description User picture url */
|
|
813
|
+
picture?: string | null;
|
|
814
|
+
/** @description Total number of logins this user has performed. */
|
|
815
|
+
logins_count: number;
|
|
816
|
+
/** @description Last IP address from which this user logged in */
|
|
817
|
+
last_ip?: string | null;
|
|
818
|
+
/** @description Last date and time this user logged in (ISO_8601 format) */
|
|
819
|
+
last_login?: string | null;
|
|
820
|
+
user_metadata: {
|
|
821
|
+
[key: string]: unknown;
|
|
822
|
+
};
|
|
823
|
+
app_metadata: {
|
|
824
|
+
[key: string]: unknown;
|
|
825
|
+
};
|
|
826
|
+
/** @description User creation date */
|
|
827
|
+
account: string;
|
|
828
|
+
/** @description User creation date */
|
|
829
|
+
createdAt: string;
|
|
830
|
+
/** @description User updated date */
|
|
831
|
+
updatedAt?: string;
|
|
832
|
+
};
|
|
833
|
+
/** @description UserCreate */
|
|
834
|
+
UserCreate: {
|
|
835
|
+
/** @description The user's full name. */
|
|
836
|
+
name?: string;
|
|
837
|
+
/** @description The user's given name. */
|
|
838
|
+
given_name?: string;
|
|
839
|
+
/** @description The user's family name. */
|
|
840
|
+
family_name?: string;
|
|
841
|
+
/** @description The user's email. */
|
|
842
|
+
email?: string;
|
|
843
|
+
/** @description contact phone number */
|
|
844
|
+
phone?: string;
|
|
845
|
+
/** @description The user's birth date */
|
|
846
|
+
birth_date?: string;
|
|
847
|
+
/** @description The user's default locale lang. */
|
|
848
|
+
locale?: string;
|
|
849
|
+
/** @description A URI pointing to the user's picture. */
|
|
850
|
+
picture?: string;
|
|
851
|
+
/** @description Initial password for this user (mandatory only for auth0 connection strategy) */
|
|
852
|
+
password?: string;
|
|
853
|
+
user_metadata?: {
|
|
854
|
+
[key: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
app_metadata?: {
|
|
857
|
+
[key: string]: unknown;
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
/** @description UserUpdate */
|
|
861
|
+
UserUpdate: {
|
|
862
|
+
/** @description name */
|
|
863
|
+
name?: string;
|
|
864
|
+
/** @description given name */
|
|
865
|
+
given_name?: string;
|
|
866
|
+
/** @description family name */
|
|
867
|
+
family_name?: string;
|
|
868
|
+
/** @description New password for this user */
|
|
869
|
+
password?: string;
|
|
870
|
+
/** @description contact phone number */
|
|
871
|
+
phone?: string;
|
|
872
|
+
/** @description user country as iso string */
|
|
873
|
+
country_iso?: string;
|
|
874
|
+
/** @description user birth_date */
|
|
875
|
+
birth_date?: string;
|
|
876
|
+
/** @description user birth_date */
|
|
877
|
+
locale?: string;
|
|
878
|
+
/** @description User picture url */
|
|
879
|
+
picture?: string;
|
|
880
|
+
user_metadata?: {
|
|
881
|
+
[key: string]: unknown;
|
|
882
|
+
};
|
|
883
|
+
app_metadata?: {
|
|
884
|
+
[key: string]: unknown;
|
|
885
|
+
};
|
|
886
|
+
};
|
|
887
|
+
/** @description User paginated response */
|
|
888
|
+
UserPage: {
|
|
889
|
+
/** @description next cursor */
|
|
890
|
+
next: string | null;
|
|
891
|
+
/** @description list of results */
|
|
892
|
+
results: components["schemas"]["User"][];
|
|
893
|
+
};
|
|
894
|
+
/** @description Identity */
|
|
895
|
+
Identity: {
|
|
896
|
+
/** @description Identity ID */
|
|
897
|
+
id: string;
|
|
898
|
+
connection: unknown;
|
|
899
|
+
user: unknown;
|
|
900
|
+
identity_id: string;
|
|
901
|
+
access_token?: string;
|
|
902
|
+
access_token_secret?: string;
|
|
903
|
+
refresh_token?: string;
|
|
904
|
+
profile_data: unknown;
|
|
905
|
+
/** @description Identity creation date */
|
|
906
|
+
account: string;
|
|
907
|
+
/** @description Identity creation date */
|
|
908
|
+
createdAt: string;
|
|
909
|
+
/** @description Identity updated date */
|
|
910
|
+
updatedAt?: string;
|
|
911
|
+
};
|
|
912
|
+
/** @description Identity paginated response */
|
|
913
|
+
IdentityPage: {
|
|
914
|
+
/** @description next cursor */
|
|
915
|
+
next: string | null;
|
|
916
|
+
/** @description list of results */
|
|
917
|
+
results: components["schemas"]["Identity"][];
|
|
918
|
+
};
|
|
919
|
+
/** @description Role */
|
|
920
|
+
Role: {
|
|
921
|
+
/** @description Role ID */
|
|
922
|
+
id: string;
|
|
923
|
+
/** @description Name for this role */
|
|
924
|
+
name: string;
|
|
925
|
+
/** @description Description of this role */
|
|
926
|
+
description: string;
|
|
927
|
+
/** @description Role creation date */
|
|
928
|
+
account: string;
|
|
929
|
+
/** @description Role creation date */
|
|
930
|
+
createdAt: string;
|
|
931
|
+
/** @description Role updated date */
|
|
932
|
+
updatedAt?: string;
|
|
933
|
+
};
|
|
934
|
+
/** @description RoleMember */
|
|
935
|
+
RoleMember: {
|
|
936
|
+
/** @description RoleMember ID */
|
|
937
|
+
id: string;
|
|
938
|
+
role: unknown;
|
|
939
|
+
user: unknown;
|
|
940
|
+
/** @description RoleMember creation date */
|
|
941
|
+
account: string;
|
|
942
|
+
/** @description RoleMember creation date */
|
|
943
|
+
createdAt: string;
|
|
944
|
+
/** @description RoleMember updated date */
|
|
945
|
+
updatedAt?: string;
|
|
946
|
+
};
|
|
947
|
+
/** @description RoleMember paginated response */
|
|
948
|
+
RoleMemberPage: {
|
|
949
|
+
/** @description next cursor */
|
|
950
|
+
next: string | null;
|
|
951
|
+
/** @description list of results */
|
|
952
|
+
results: components["schemas"]["RoleMember"][];
|
|
953
|
+
};
|
|
954
|
+
/** @description Role paginated response */
|
|
955
|
+
RolePage: {
|
|
956
|
+
/** @description next cursor */
|
|
957
|
+
next: string | null;
|
|
958
|
+
/** @description list of results */
|
|
959
|
+
results: components["schemas"]["Role"][];
|
|
960
|
+
};
|
|
961
|
+
/** @description Team */
|
|
962
|
+
Team: {
|
|
963
|
+
/** @description Team ID */
|
|
964
|
+
id: string;
|
|
965
|
+
name: string;
|
|
966
|
+
slug: string;
|
|
967
|
+
description: string | null;
|
|
968
|
+
logo_url: string | null;
|
|
969
|
+
metadata: {
|
|
970
|
+
[key: string]: unknown;
|
|
971
|
+
};
|
|
972
|
+
/** @description Team creation date */
|
|
973
|
+
account: string;
|
|
974
|
+
/** @description Team creation date */
|
|
975
|
+
createdAt: string;
|
|
976
|
+
/** @description Team updated date */
|
|
977
|
+
updatedAt?: string;
|
|
978
|
+
};
|
|
979
|
+
/** @description TeamMember */
|
|
980
|
+
TeamMember: {
|
|
981
|
+
/** @description TeamMember ID */
|
|
982
|
+
id: string;
|
|
983
|
+
user: unknown;
|
|
984
|
+
team: unknown;
|
|
985
|
+
roles: unknown[];
|
|
986
|
+
metadata: {
|
|
987
|
+
[key: string]: unknown;
|
|
988
|
+
};
|
|
989
|
+
/** @description TeamMember creation date */
|
|
990
|
+
account: string;
|
|
991
|
+
/** @description TeamMember creation date */
|
|
992
|
+
createdAt: string;
|
|
993
|
+
/** @description TeamMember updated date */
|
|
994
|
+
updatedAt?: string;
|
|
995
|
+
};
|
|
996
|
+
/** @description TeamCreate */
|
|
997
|
+
TeamCreate: {
|
|
998
|
+
name: string;
|
|
999
|
+
description?: string;
|
|
1000
|
+
metadata?: {
|
|
1001
|
+
[key: string]: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
/** @description TeamUpdate */
|
|
1005
|
+
TeamUpdate: {
|
|
1006
|
+
/** @description name */
|
|
1007
|
+
name?: string;
|
|
1008
|
+
/** @description description */
|
|
1009
|
+
description?: string;
|
|
1010
|
+
metadata?: {
|
|
1011
|
+
[key: string]: unknown;
|
|
1012
|
+
};
|
|
1013
|
+
};
|
|
1014
|
+
TeamMemberCreate: {
|
|
1015
|
+
users: string[];
|
|
1016
|
+
};
|
|
1017
|
+
/** @description Team paginated response */
|
|
1018
|
+
TeamPage: {
|
|
1019
|
+
/** @description next cursor */
|
|
1020
|
+
next: string | null;
|
|
1021
|
+
/** @description list of results */
|
|
1022
|
+
results: components["schemas"]["Team"][];
|
|
1023
|
+
};
|
|
1024
|
+
/** @description TeamMember paginated response */
|
|
1025
|
+
TeamMemberPage: {
|
|
1026
|
+
/** @description next cursor */
|
|
1027
|
+
next: string | null;
|
|
1028
|
+
/** @description list of results */
|
|
1029
|
+
results: components["schemas"]["TeamMember"][];
|
|
1030
|
+
};
|
|
1031
|
+
/** @description Webhook */
|
|
1032
|
+
Webhook: {
|
|
1033
|
+
/** @description Webhook ID */
|
|
1034
|
+
id: string;
|
|
1035
|
+
name: string;
|
|
1036
|
+
/** @description Webhook creation date */
|
|
1037
|
+
account: string;
|
|
1038
|
+
/** @description Webhook creation date */
|
|
1039
|
+
createdAt: string;
|
|
1040
|
+
/** @description Webhook updated date */
|
|
1041
|
+
updatedAt?: string;
|
|
1042
|
+
};
|
|
1043
|
+
/** @description WebhookCreate */
|
|
1044
|
+
WebhookCreate: {
|
|
1045
|
+
name: string;
|
|
1046
|
+
url: string;
|
|
1047
|
+
metadata?: {
|
|
1048
|
+
[key: string]: unknown;
|
|
1049
|
+
};
|
|
1050
|
+
};
|
|
1051
|
+
/** @description Webhook paginated response */
|
|
1052
|
+
WebhookPage: {
|
|
1053
|
+
/** @description next cursor */
|
|
1054
|
+
next: string | null;
|
|
1055
|
+
/** @description list of results */
|
|
1056
|
+
results: components["schemas"]["Webhook"][];
|
|
1057
|
+
};
|
|
1058
|
+
Permission: {
|
|
1059
|
+
value: string;
|
|
1060
|
+
description?: string;
|
|
1061
|
+
};
|
|
1062
|
+
PermissionCreate: {
|
|
1063
|
+
value: string;
|
|
1064
|
+
description?: string;
|
|
1065
|
+
};
|
|
1066
|
+
/** @description Api */
|
|
1067
|
+
Api: {
|
|
1068
|
+
/** @description Api ID */
|
|
1069
|
+
id: string;
|
|
1070
|
+
name: string;
|
|
1071
|
+
description?: string;
|
|
1072
|
+
permissions: components["schemas"]["Permission"][];
|
|
1073
|
+
/** @description Api creation date */
|
|
1074
|
+
account: string;
|
|
1075
|
+
/** @description Api creation date */
|
|
1076
|
+
createdAt: string;
|
|
1077
|
+
/** @description Api updated date */
|
|
1078
|
+
updatedAt?: string;
|
|
1079
|
+
};
|
|
1080
|
+
ApiCreate: {
|
|
1081
|
+
name: string;
|
|
1082
|
+
description?: string;
|
|
1083
|
+
permissions: components["schemas"]["PermissionCreate"][];
|
|
1084
|
+
};
|
|
1085
|
+
/** @description Api paginated response */
|
|
1086
|
+
ApiPage: {
|
|
1087
|
+
/** @description next cursor */
|
|
1088
|
+
next: string | null;
|
|
1089
|
+
/** @description list of results */
|
|
1090
|
+
results: components["schemas"]["Api"][];
|
|
1091
|
+
};
|
|
1092
|
+
"OAuthToken Body": {
|
|
1093
|
+
/** @description Grant Type. https://oauth.net/2/grant-types/ */
|
|
1094
|
+
grant_type: "authorization_code" | "client_credentials" | "refresh_token" | "password";
|
|
1095
|
+
client_id?: string;
|
|
1096
|
+
client_secret?: string;
|
|
1097
|
+
scope?: string;
|
|
1098
|
+
code?: string;
|
|
1099
|
+
code_verifier?: string;
|
|
1100
|
+
refresh_token?: string;
|
|
1101
|
+
[key: string]: unknown;
|
|
1102
|
+
};
|
|
1103
|
+
/** @description UsernamepasswordLoginBody */
|
|
1104
|
+
UsernamepasswordLoginBody: {
|
|
1105
|
+
username: string;
|
|
1106
|
+
password: string;
|
|
1107
|
+
response_type: "code" | "token";
|
|
1108
|
+
client_id: string;
|
|
1109
|
+
/** @description Which oauth connection to use. Leave empty to use default connection */
|
|
1110
|
+
connection?: string;
|
|
1111
|
+
scope?: string;
|
|
1112
|
+
/** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
|
|
1113
|
+
redirect_uri: string;
|
|
1114
|
+
/** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
|
|
1115
|
+
state?: string;
|
|
1116
|
+
/** @description whether to prompt the end user for authentication and consent */
|
|
1117
|
+
prompt?: "login" | "consent" | "none";
|
|
1118
|
+
};
|
|
1119
|
+
LoginCallbackBody: {
|
|
1120
|
+
/** @description is always wsignin1.0 */
|
|
1121
|
+
wa: string;
|
|
1122
|
+
/** @description JWT */
|
|
1123
|
+
wresult: string;
|
|
1124
|
+
/** @description Serialized JSON with context */
|
|
1125
|
+
wctx: string;
|
|
1126
|
+
};
|
|
1127
|
+
/** @description RoleCreate */
|
|
1128
|
+
RoleCreate: {
|
|
1129
|
+
name: string;
|
|
1130
|
+
description?: string;
|
|
1131
|
+
metadata?: {
|
|
1132
|
+
[key: string]: unknown;
|
|
1133
|
+
};
|
|
1134
|
+
};
|
|
1135
|
+
RoleMemberCreate: {
|
|
1136
|
+
users: string[];
|
|
1137
|
+
};
|
|
1138
|
+
};
|
|
1139
|
+
responses: never;
|
|
1140
|
+
parameters: never;
|
|
1141
|
+
requestBodies: never;
|
|
1142
|
+
headers: never;
|
|
1143
|
+
pathItems: never;
|
|
1144
|
+
}
|
|
1145
|
+
export type $defs = Record<string, never>;
|
|
1146
|
+
export type external = Record<string, never>;
|
|
1147
|
+
export interface operations {
|
|
1148
|
+
/**
|
|
1149
|
+
* List Connections in Account
|
|
1150
|
+
* @description List Connections in Account
|
|
1151
|
+
*/
|
|
1152
|
+
"connection/list": {
|
|
1153
|
+
parameters: {
|
|
1154
|
+
query?: {
|
|
1155
|
+
/** @description Filter using a FaableQL query */
|
|
1156
|
+
query?: string;
|
|
1157
|
+
/** @description Start from this cursor */
|
|
1158
|
+
cursor?: string;
|
|
1159
|
+
/** @description Size of the results array */
|
|
1160
|
+
pageSize?: number;
|
|
1161
|
+
expand?: string[];
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
responses: {
|
|
1165
|
+
/** @description Default Response */
|
|
1166
|
+
200: {
|
|
1167
|
+
content: {
|
|
1168
|
+
"application/json": components["schemas"]["ConnectionPage"];
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
/**
|
|
1174
|
+
* Get Connection in Account
|
|
1175
|
+
* @description Get Connection in Account
|
|
1176
|
+
*/
|
|
1177
|
+
"connection/get": {
|
|
1178
|
+
parameters: {
|
|
1179
|
+
path: {
|
|
1180
|
+
connection_id: string;
|
|
1181
|
+
};
|
|
1182
|
+
};
|
|
1183
|
+
responses: {
|
|
1184
|
+
/** @description Default Response */
|
|
1185
|
+
200: {
|
|
1186
|
+
content: {
|
|
1187
|
+
"application/json": components["schemas"]["Connection"];
|
|
1188
|
+
};
|
|
1189
|
+
};
|
|
1190
|
+
};
|
|
1191
|
+
};
|
|
1192
|
+
/**
|
|
1193
|
+
* Delete Connection in Account
|
|
1194
|
+
* @description Delete Connection in Account
|
|
1195
|
+
*/
|
|
1196
|
+
"connection/remove": {
|
|
1197
|
+
parameters: {
|
|
1198
|
+
path: {
|
|
1199
|
+
connection_id: string;
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
responses: {
|
|
1203
|
+
/** @description Default Response */
|
|
1204
|
+
200: {
|
|
1205
|
+
content: never;
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
};
|
|
1209
|
+
/**
|
|
1210
|
+
* Start Passwordless authentication flow
|
|
1211
|
+
* @description Start Passwordless authentication flow
|
|
1212
|
+
*/
|
|
1213
|
+
"passwordless/start": {
|
|
1214
|
+
requestBody: {
|
|
1215
|
+
content: {
|
|
1216
|
+
"application/json": {
|
|
1217
|
+
email: string;
|
|
1218
|
+
returnTo: string;
|
|
1219
|
+
};
|
|
1220
|
+
};
|
|
1221
|
+
};
|
|
1222
|
+
responses: {
|
|
1223
|
+
/** @description Default Response */
|
|
1224
|
+
200: {
|
|
1225
|
+
content: never;
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
};
|
|
1229
|
+
/** @description Receive a passwordless token and convert it to a valid session */
|
|
1230
|
+
"passwordless/login": {
|
|
1231
|
+
responses: {
|
|
1232
|
+
/** @description Default Response */
|
|
1233
|
+
200: {
|
|
1234
|
+
content: never;
|
|
1235
|
+
};
|
|
1236
|
+
};
|
|
1237
|
+
};
|
|
1238
|
+
/**
|
|
1239
|
+
* List Clients in Account
|
|
1240
|
+
* @description List Clients in Account
|
|
1241
|
+
*/
|
|
1242
|
+
"client/list": {
|
|
1243
|
+
parameters: {
|
|
1244
|
+
query?: {
|
|
1245
|
+
/** @description Filter using a FaableQL query */
|
|
1246
|
+
query?: string;
|
|
1247
|
+
/** @description Start from this cursor */
|
|
1248
|
+
cursor?: string;
|
|
1249
|
+
/** @description Size of the results array */
|
|
1250
|
+
pageSize?: number;
|
|
1251
|
+
expand?: string[];
|
|
1252
|
+
};
|
|
1253
|
+
};
|
|
1254
|
+
responses: {
|
|
1255
|
+
/** @description Default Response */
|
|
1256
|
+
200: {
|
|
1257
|
+
content: {
|
|
1258
|
+
"application/json": components["schemas"]["ClientPage"];
|
|
1259
|
+
};
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
/**
|
|
1264
|
+
* Get Client in Account
|
|
1265
|
+
* @description Get Client in Account
|
|
1266
|
+
*/
|
|
1267
|
+
"client/get": {
|
|
1268
|
+
parameters: {
|
|
1269
|
+
path: {
|
|
1270
|
+
client_id: string;
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
responses: {
|
|
1274
|
+
/** @description Default Response */
|
|
1275
|
+
200: {
|
|
1276
|
+
content: {
|
|
1277
|
+
"application/json": components["schemas"]["Client"];
|
|
1278
|
+
};
|
|
1279
|
+
};
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
/**
|
|
1283
|
+
* Delete Client in Account
|
|
1284
|
+
* @description Delete Client in Account
|
|
1285
|
+
*/
|
|
1286
|
+
"client/remove": {
|
|
1287
|
+
parameters: {
|
|
1288
|
+
path: {
|
|
1289
|
+
client_id: string;
|
|
1290
|
+
};
|
|
1291
|
+
};
|
|
1292
|
+
responses: {
|
|
1293
|
+
/** @description Default Response */
|
|
1294
|
+
200: {
|
|
1295
|
+
content: never;
|
|
1296
|
+
};
|
|
1297
|
+
};
|
|
1298
|
+
};
|
|
1299
|
+
/**
|
|
1300
|
+
* Authorization request
|
|
1301
|
+
* @description Authorization request
|
|
1302
|
+
*/
|
|
1303
|
+
authorize: {
|
|
1304
|
+
parameters: {
|
|
1305
|
+
query: {
|
|
1306
|
+
response_type: "code" | "token";
|
|
1307
|
+
/** @description Challenge method for PKCE. Only S256 is supported. */
|
|
1308
|
+
code_challenge_method?: string;
|
|
1309
|
+
/** @description Challenge for PKCE authorization code flow */
|
|
1310
|
+
code_challenge?: string;
|
|
1311
|
+
client_id: string;
|
|
1312
|
+
/** @description Which oauth connection to use. Leave empty to use default connection */
|
|
1313
|
+
connection?: string;
|
|
1314
|
+
scope?: string;
|
|
1315
|
+
/** @description The URL to which Faable will redirect the browser after authorization has been granted by the user. */
|
|
1316
|
+
redirect_uri: string;
|
|
1317
|
+
/** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
|
|
1318
|
+
state?: string;
|
|
1319
|
+
/** @description whether to prompt the end user for authentication and consent */
|
|
1320
|
+
prompt?: "login" | "consent" | "none";
|
|
1321
|
+
};
|
|
1322
|
+
};
|
|
1323
|
+
responses: {
|
|
1324
|
+
/** @description Default Response */
|
|
1325
|
+
200: {
|
|
1326
|
+
content: never;
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1329
|
+
};
|
|
1330
|
+
/**
|
|
1331
|
+
* OAuth2 Callback URL
|
|
1332
|
+
* @description OAuth2 Callback URL
|
|
1333
|
+
*/
|
|
1334
|
+
callback: {
|
|
1335
|
+
parameters: {
|
|
1336
|
+
query?: {
|
|
1337
|
+
code?: string;
|
|
1338
|
+
state?: string;
|
|
1339
|
+
error?: string;
|
|
1340
|
+
error_uri?: string;
|
|
1341
|
+
error_description?: string;
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
responses: {
|
|
1345
|
+
/** @description Default Response */
|
|
1346
|
+
200: {
|
|
1347
|
+
content: never;
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
/**
|
|
1352
|
+
* List Users in Account
|
|
1353
|
+
* @description List Users in Account
|
|
1354
|
+
*/
|
|
1355
|
+
"user/list": {
|
|
1356
|
+
parameters: {
|
|
1357
|
+
query?: {
|
|
1358
|
+
/** @description Filter using a FaableQL query */
|
|
1359
|
+
query?: string;
|
|
1360
|
+
/** @description Start from this cursor */
|
|
1361
|
+
cursor?: string;
|
|
1362
|
+
/** @description Size of the results array */
|
|
1363
|
+
pageSize?: number;
|
|
1364
|
+
expand?: string[];
|
|
1365
|
+
};
|
|
1366
|
+
};
|
|
1367
|
+
responses: {
|
|
1368
|
+
/** @description Default Response */
|
|
1369
|
+
200: {
|
|
1370
|
+
content: {
|
|
1371
|
+
"application/json": components["schemas"]["UserPage"];
|
|
1372
|
+
};
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
};
|
|
1376
|
+
/**
|
|
1377
|
+
* Create a user
|
|
1378
|
+
* @description Create a user
|
|
1379
|
+
*/
|
|
1380
|
+
"user/create": {
|
|
1381
|
+
requestBody?: {
|
|
1382
|
+
content: {
|
|
1383
|
+
"application/json": components["schemas"]["UserCreate"];
|
|
1384
|
+
};
|
|
1385
|
+
};
|
|
1386
|
+
responses: {
|
|
1387
|
+
/** @description Default Response */
|
|
1388
|
+
201: {
|
|
1389
|
+
content: {
|
|
1390
|
+
"application/json": components["schemas"]["User"];
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
/**
|
|
1396
|
+
* Get User in Account
|
|
1397
|
+
* @description Get User in Account
|
|
1398
|
+
*/
|
|
1399
|
+
"user/get": {
|
|
1400
|
+
parameters: {
|
|
1401
|
+
path: {
|
|
1402
|
+
user_id: string;
|
|
1403
|
+
};
|
|
1404
|
+
};
|
|
1405
|
+
responses: {
|
|
1406
|
+
/** @description Default Response */
|
|
1407
|
+
200: {
|
|
1408
|
+
content: {
|
|
1409
|
+
"application/json": components["schemas"]["User"];
|
|
1410
|
+
};
|
|
1411
|
+
};
|
|
1412
|
+
};
|
|
1413
|
+
};
|
|
1414
|
+
/**
|
|
1415
|
+
* Update a user
|
|
1416
|
+
* @description Update a user
|
|
1417
|
+
*/
|
|
1418
|
+
"user/update": {
|
|
1419
|
+
parameters: {
|
|
1420
|
+
path: {
|
|
1421
|
+
user_id: string;
|
|
1422
|
+
};
|
|
1423
|
+
};
|
|
1424
|
+
requestBody?: {
|
|
1425
|
+
content: {
|
|
1426
|
+
"application/json": components["schemas"]["UserUpdate"];
|
|
1427
|
+
};
|
|
1428
|
+
};
|
|
1429
|
+
responses: {
|
|
1430
|
+
/** @description Default Response */
|
|
1431
|
+
200: {
|
|
1432
|
+
content: {
|
|
1433
|
+
"application/json": components["schemas"]["User"];
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
};
|
|
1438
|
+
/**
|
|
1439
|
+
* Delete User in Account
|
|
1440
|
+
* @description Delete User in Account
|
|
1441
|
+
*/
|
|
1442
|
+
"user/remove": {
|
|
1443
|
+
parameters: {
|
|
1444
|
+
path: {
|
|
1445
|
+
user_id: string;
|
|
1446
|
+
};
|
|
1447
|
+
};
|
|
1448
|
+
responses: {
|
|
1449
|
+
/** @description Default Response */
|
|
1450
|
+
200: {
|
|
1451
|
+
content: never;
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1455
|
+
/**
|
|
1456
|
+
* List Identitys in Account
|
|
1457
|
+
* @description List Identitys in Account
|
|
1458
|
+
*/
|
|
1459
|
+
"identity/list": {
|
|
1460
|
+
parameters: {
|
|
1461
|
+
query?: {
|
|
1462
|
+
/** @description Filter using a FaableQL query */
|
|
1463
|
+
query?: string;
|
|
1464
|
+
/** @description Start from this cursor */
|
|
1465
|
+
cursor?: string;
|
|
1466
|
+
/** @description Size of the results array */
|
|
1467
|
+
pageSize?: number;
|
|
1468
|
+
expand?: string[];
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
responses: {
|
|
1472
|
+
/** @description Default Response */
|
|
1473
|
+
200: {
|
|
1474
|
+
content: {
|
|
1475
|
+
"application/json": components["schemas"]["IdentityPage"];
|
|
1476
|
+
};
|
|
1477
|
+
};
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
/**
|
|
1481
|
+
* Get Identity in Account
|
|
1482
|
+
* @description Get Identity in Account
|
|
1483
|
+
*/
|
|
1484
|
+
"identity/get": {
|
|
1485
|
+
parameters: {
|
|
1486
|
+
path: {
|
|
1487
|
+
identity_id: string;
|
|
1488
|
+
};
|
|
1489
|
+
};
|
|
1490
|
+
responses: {
|
|
1491
|
+
/** @description Default Response */
|
|
1492
|
+
200: {
|
|
1493
|
+
content: {
|
|
1494
|
+
"application/json": components["schemas"]["Identity"];
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
};
|
|
1499
|
+
/**
|
|
1500
|
+
* Delete Identity in Account
|
|
1501
|
+
* @description Delete Identity in Account
|
|
1502
|
+
*/
|
|
1503
|
+
"identity/remove": {
|
|
1504
|
+
parameters: {
|
|
1505
|
+
path: {
|
|
1506
|
+
identity_id: string;
|
|
1507
|
+
};
|
|
1508
|
+
};
|
|
1509
|
+
responses: {
|
|
1510
|
+
/** @description Default Response */
|
|
1511
|
+
200: {
|
|
1512
|
+
content: never;
|
|
1513
|
+
};
|
|
1514
|
+
};
|
|
1515
|
+
};
|
|
1516
|
+
/**
|
|
1517
|
+
* List Roles in Account
|
|
1518
|
+
* @description List Roles in Account
|
|
1519
|
+
*/
|
|
1520
|
+
"role/list": {
|
|
1521
|
+
parameters: {
|
|
1522
|
+
query?: {
|
|
1523
|
+
/** @description Filter using a FaableQL query */
|
|
1524
|
+
query?: string;
|
|
1525
|
+
/** @description Start from this cursor */
|
|
1526
|
+
cursor?: string;
|
|
1527
|
+
/** @description Size of the results array */
|
|
1528
|
+
pageSize?: number;
|
|
1529
|
+
expand?: string[];
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
responses: {
|
|
1533
|
+
/** @description Default Response */
|
|
1534
|
+
200: {
|
|
1535
|
+
content: {
|
|
1536
|
+
"application/json": components["schemas"]["RolePage"];
|
|
1537
|
+
};
|
|
1538
|
+
};
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
/**
|
|
1542
|
+
* Create a Role
|
|
1543
|
+
* @description Create a Role
|
|
1544
|
+
*/
|
|
1545
|
+
"role/create": {
|
|
1546
|
+
requestBody?: {
|
|
1547
|
+
content: {
|
|
1548
|
+
"application/json": components["schemas"]["RoleCreate"];
|
|
1549
|
+
};
|
|
1550
|
+
};
|
|
1551
|
+
responses: {
|
|
1552
|
+
/** @description Default Response */
|
|
1553
|
+
201: {
|
|
1554
|
+
content: {
|
|
1555
|
+
"application/json": components["schemas"]["Role"];
|
|
1556
|
+
};
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
};
|
|
1560
|
+
/**
|
|
1561
|
+
* List Users with Role
|
|
1562
|
+
* @description List Users with Role
|
|
1563
|
+
*/
|
|
1564
|
+
"role/users": {
|
|
1565
|
+
parameters: {
|
|
1566
|
+
query?: {
|
|
1567
|
+
/** @description Start from this cursor */
|
|
1568
|
+
cursor?: string;
|
|
1569
|
+
/** @description Size of the results array */
|
|
1570
|
+
pageSize?: number;
|
|
1571
|
+
};
|
|
1572
|
+
path: {
|
|
1573
|
+
role_id: string;
|
|
1574
|
+
};
|
|
1575
|
+
};
|
|
1576
|
+
responses: {
|
|
1577
|
+
/** @description Default Response */
|
|
1578
|
+
200: {
|
|
1579
|
+
content: {
|
|
1580
|
+
"application/json": components["schemas"]["RoleMemberPage"];
|
|
1581
|
+
};
|
|
1582
|
+
};
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
/**
|
|
1586
|
+
* Assign Users to Role
|
|
1587
|
+
* @description Assign Users to Role
|
|
1588
|
+
*/
|
|
1589
|
+
"role/assign_users": {
|
|
1590
|
+
parameters: {
|
|
1591
|
+
path: {
|
|
1592
|
+
role_id: string;
|
|
1593
|
+
};
|
|
1594
|
+
};
|
|
1595
|
+
requestBody?: {
|
|
1596
|
+
content: {
|
|
1597
|
+
"application/json": components["schemas"]["RoleMemberCreate"];
|
|
1598
|
+
};
|
|
1599
|
+
};
|
|
1600
|
+
responses: {
|
|
1601
|
+
/** @description Default Response */
|
|
1602
|
+
200: {
|
|
1603
|
+
content: never;
|
|
1604
|
+
};
|
|
1605
|
+
};
|
|
1606
|
+
};
|
|
1607
|
+
/**
|
|
1608
|
+
* Get Role in Account
|
|
1609
|
+
* @description Get Role in Account
|
|
1610
|
+
*/
|
|
1611
|
+
"role/get": {
|
|
1612
|
+
parameters: {
|
|
1613
|
+
path: {
|
|
1614
|
+
role_id: string;
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
responses: {
|
|
1618
|
+
/** @description Default Response */
|
|
1619
|
+
200: {
|
|
1620
|
+
content: {
|
|
1621
|
+
"application/json": components["schemas"]["Role"];
|
|
1622
|
+
};
|
|
1623
|
+
};
|
|
1624
|
+
};
|
|
1625
|
+
};
|
|
1626
|
+
/**
|
|
1627
|
+
* Delete Role in Account
|
|
1628
|
+
* @description Delete Role in Account
|
|
1629
|
+
*/
|
|
1630
|
+
"role/remove": {
|
|
1631
|
+
parameters: {
|
|
1632
|
+
path: {
|
|
1633
|
+
role_id: string;
|
|
1634
|
+
};
|
|
1635
|
+
};
|
|
1636
|
+
responses: {
|
|
1637
|
+
/** @description Default Response */
|
|
1638
|
+
200: {
|
|
1639
|
+
content: never;
|
|
1640
|
+
};
|
|
1641
|
+
};
|
|
1642
|
+
};
|
|
1643
|
+
/**
|
|
1644
|
+
* List Teams in Account
|
|
1645
|
+
* @description List Teams in Account
|
|
1646
|
+
*/
|
|
1647
|
+
"team/list": {
|
|
1648
|
+
parameters: {
|
|
1649
|
+
query?: {
|
|
1650
|
+
/** @description Filter using a FaableQL query */
|
|
1651
|
+
query?: string;
|
|
1652
|
+
/** @description Start from this cursor */
|
|
1653
|
+
cursor?: string;
|
|
1654
|
+
/** @description Size of the results array */
|
|
1655
|
+
pageSize?: number;
|
|
1656
|
+
expand?: string[];
|
|
1657
|
+
};
|
|
1658
|
+
};
|
|
1659
|
+
responses: {
|
|
1660
|
+
/** @description Default Response */
|
|
1661
|
+
200: {
|
|
1662
|
+
content: {
|
|
1663
|
+
"application/json": components["schemas"]["TeamPage"];
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
};
|
|
1667
|
+
};
|
|
1668
|
+
/**
|
|
1669
|
+
* Get Team in Account
|
|
1670
|
+
* @description Get Team in Account
|
|
1671
|
+
*/
|
|
1672
|
+
"team/get": {
|
|
1673
|
+
parameters: {
|
|
1674
|
+
path: {
|
|
1675
|
+
team_id: string;
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
responses: {
|
|
1679
|
+
/** @description Default Response */
|
|
1680
|
+
200: {
|
|
1681
|
+
content: {
|
|
1682
|
+
"application/json": components["schemas"]["Team"];
|
|
1683
|
+
};
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1686
|
+
};
|
|
1687
|
+
/**
|
|
1688
|
+
* Update a team
|
|
1689
|
+
* @description Update a team
|
|
1690
|
+
*/
|
|
1691
|
+
"team/update": {
|
|
1692
|
+
parameters: {
|
|
1693
|
+
path: {
|
|
1694
|
+
team_id: string;
|
|
1695
|
+
};
|
|
1696
|
+
};
|
|
1697
|
+
requestBody?: {
|
|
1698
|
+
content: {
|
|
1699
|
+
"application/json": components["schemas"]["TeamUpdate"];
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
responses: {
|
|
1703
|
+
/** @description Default Response */
|
|
1704
|
+
200: {
|
|
1705
|
+
content: {
|
|
1706
|
+
"application/json": components["schemas"]["Team"];
|
|
1707
|
+
};
|
|
1708
|
+
};
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
/**
|
|
1712
|
+
* Delete Team in Account
|
|
1713
|
+
* @description Delete Team in Account
|
|
1714
|
+
*/
|
|
1715
|
+
"team/remove": {
|
|
1716
|
+
parameters: {
|
|
1717
|
+
path: {
|
|
1718
|
+
team_id: string;
|
|
1719
|
+
};
|
|
1720
|
+
};
|
|
1721
|
+
responses: {
|
|
1722
|
+
/** @description Default Response */
|
|
1723
|
+
200: {
|
|
1724
|
+
content: never;
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
};
|
|
1728
|
+
/**
|
|
1729
|
+
* List Members in Account
|
|
1730
|
+
* @description List Members in Account
|
|
1731
|
+
*/
|
|
1732
|
+
"member/list": {
|
|
1733
|
+
parameters: {
|
|
1734
|
+
query?: {
|
|
1735
|
+
/** @description Filter using a FaableQL query */
|
|
1736
|
+
query?: string;
|
|
1737
|
+
/** @description Start from this cursor */
|
|
1738
|
+
cursor?: string;
|
|
1739
|
+
/** @description Size of the results array */
|
|
1740
|
+
pageSize?: number;
|
|
1741
|
+
expand?: string[];
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
responses: {
|
|
1745
|
+
/** @description Default Response */
|
|
1746
|
+
200: {
|
|
1747
|
+
content: {
|
|
1748
|
+
"application/json": components["schemas"]["TeamMemberPage"];
|
|
1749
|
+
};
|
|
1750
|
+
};
|
|
1751
|
+
};
|
|
1752
|
+
};
|
|
1753
|
+
/**
|
|
1754
|
+
* Get Member in Account
|
|
1755
|
+
* @description Get Member in Account
|
|
1756
|
+
*/
|
|
1757
|
+
"member/get": {
|
|
1758
|
+
parameters: {
|
|
1759
|
+
path: {
|
|
1760
|
+
member_id: string;
|
|
1761
|
+
};
|
|
1762
|
+
};
|
|
1763
|
+
responses: {
|
|
1764
|
+
/** @description Default Response */
|
|
1765
|
+
200: {
|
|
1766
|
+
content: {
|
|
1767
|
+
"application/json": components["schemas"]["TeamMember"];
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
};
|
|
1771
|
+
};
|
|
1772
|
+
/**
|
|
1773
|
+
* Delete Member in Account
|
|
1774
|
+
* @description Delete Member in Account
|
|
1775
|
+
*/
|
|
1776
|
+
"member/remove": {
|
|
1777
|
+
parameters: {
|
|
1778
|
+
path: {
|
|
1779
|
+
member_id: string;
|
|
1780
|
+
};
|
|
1781
|
+
};
|
|
1782
|
+
responses: {
|
|
1783
|
+
/** @description Default Response */
|
|
1784
|
+
200: {
|
|
1785
|
+
content: never;
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
/**
|
|
1790
|
+
* List Webhooks in Account
|
|
1791
|
+
* @description List Webhooks in Account
|
|
1792
|
+
*/
|
|
1793
|
+
"webhook/list": {
|
|
1794
|
+
parameters: {
|
|
1795
|
+
query?: {
|
|
1796
|
+
/** @description Filter using a FaableQL query */
|
|
1797
|
+
query?: string;
|
|
1798
|
+
/** @description Start from this cursor */
|
|
1799
|
+
cursor?: string;
|
|
1800
|
+
/** @description Size of the results array */
|
|
1801
|
+
pageSize?: number;
|
|
1802
|
+
expand?: string[];
|
|
1803
|
+
};
|
|
1804
|
+
};
|
|
1805
|
+
responses: {
|
|
1806
|
+
/** @description Default Response */
|
|
1807
|
+
200: {
|
|
1808
|
+
content: {
|
|
1809
|
+
"application/json": components["schemas"]["WebhookPage"];
|
|
1810
|
+
};
|
|
1811
|
+
};
|
|
1812
|
+
};
|
|
1813
|
+
};
|
|
1814
|
+
/**
|
|
1815
|
+
* Get Webhook in Account
|
|
1816
|
+
* @description Get Webhook in Account
|
|
1817
|
+
*/
|
|
1818
|
+
"webhook/get": {
|
|
1819
|
+
parameters: {
|
|
1820
|
+
path: {
|
|
1821
|
+
webhook_id: string;
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
responses: {
|
|
1825
|
+
/** @description Default Response */
|
|
1826
|
+
200: {
|
|
1827
|
+
content: {
|
|
1828
|
+
"application/json": components["schemas"]["Webhook"];
|
|
1829
|
+
};
|
|
1830
|
+
};
|
|
1831
|
+
};
|
|
1832
|
+
};
|
|
1833
|
+
/**
|
|
1834
|
+
* Delete Webhook in Account
|
|
1835
|
+
* @description Delete Webhook in Account
|
|
1836
|
+
*/
|
|
1837
|
+
"webhook/remove": {
|
|
1838
|
+
parameters: {
|
|
1839
|
+
path: {
|
|
1840
|
+
webhook_id: string;
|
|
1841
|
+
};
|
|
1842
|
+
};
|
|
1843
|
+
responses: {
|
|
1844
|
+
/** @description Default Response */
|
|
1845
|
+
200: {
|
|
1846
|
+
content: never;
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
};
|
|
1850
|
+
/**
|
|
1851
|
+
* List Apis in Account
|
|
1852
|
+
* @description List Apis in Account
|
|
1853
|
+
*/
|
|
1854
|
+
"api/list": {
|
|
1855
|
+
parameters: {
|
|
1856
|
+
query?: {
|
|
1857
|
+
/** @description Filter using a FaableQL query */
|
|
1858
|
+
query?: string;
|
|
1859
|
+
/** @description Start from this cursor */
|
|
1860
|
+
cursor?: string;
|
|
1861
|
+
/** @description Size of the results array */
|
|
1862
|
+
pageSize?: number;
|
|
1863
|
+
expand?: string[];
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
responses: {
|
|
1867
|
+
/** @description Default Response */
|
|
1868
|
+
200: {
|
|
1869
|
+
content: {
|
|
1870
|
+
"application/json": components["schemas"]["ApiPage"];
|
|
1871
|
+
};
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
};
|
|
1875
|
+
/**
|
|
1876
|
+
* Get Api in Account
|
|
1877
|
+
* @description Get Api in Account
|
|
1878
|
+
*/
|
|
1879
|
+
"api/get": {
|
|
1880
|
+
parameters: {
|
|
1881
|
+
path: {
|
|
1882
|
+
api_id: string;
|
|
1883
|
+
};
|
|
1884
|
+
};
|
|
1885
|
+
responses: {
|
|
1886
|
+
/** @description Default Response */
|
|
1887
|
+
200: {
|
|
1888
|
+
content: {
|
|
1889
|
+
"application/json": components["schemas"]["Api"];
|
|
1890
|
+
};
|
|
1891
|
+
};
|
|
1892
|
+
};
|
|
1893
|
+
};
|
|
1894
|
+
/**
|
|
1895
|
+
* Delete Api in Account
|
|
1896
|
+
* @description Delete Api in Account
|
|
1897
|
+
*/
|
|
1898
|
+
"api/remove": {
|
|
1899
|
+
parameters: {
|
|
1900
|
+
path: {
|
|
1901
|
+
api_id: string;
|
|
1902
|
+
};
|
|
1903
|
+
};
|
|
1904
|
+
responses: {
|
|
1905
|
+
/** @description Default Response */
|
|
1906
|
+
200: {
|
|
1907
|
+
content: never;
|
|
1908
|
+
};
|
|
1909
|
+
};
|
|
1910
|
+
};
|
|
1911
|
+
}
|