@stable_sea/sdk 0.2.12 → 0.2.13
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/README.md +29 -5
- package/dist/gen/session-schema.d.ts +2670 -224
- package/package.json +1 -1
|
@@ -88,7 +88,7 @@ export interface paths {
|
|
|
88
88
|
patch?: never;
|
|
89
89
|
trace?: never;
|
|
90
90
|
};
|
|
91
|
-
"/
|
|
91
|
+
"/identity/account_security/report_unrecognized_login": {
|
|
92
92
|
parameters: {
|
|
93
93
|
query?: never;
|
|
94
94
|
header?: never;
|
|
@@ -98,17 +98,17 @@ export interface paths {
|
|
|
98
98
|
get?: never;
|
|
99
99
|
put?: never;
|
|
100
100
|
/**
|
|
101
|
-
*
|
|
102
|
-
* @description
|
|
101
|
+
* Report an unrecognized sign-in
|
|
102
|
+
* @description Use the account-security token from the alert email to revoke sessions, require a password reset and flag the account for review.
|
|
103
103
|
*/
|
|
104
|
-
post: operations["
|
|
104
|
+
post: operations["identity.account_security.report_unrecognized_login"];
|
|
105
105
|
delete?: never;
|
|
106
106
|
options?: never;
|
|
107
107
|
head?: never;
|
|
108
108
|
patch?: never;
|
|
109
109
|
trace?: never;
|
|
110
110
|
};
|
|
111
|
-
"/
|
|
111
|
+
"/identity/api_keys": {
|
|
112
112
|
parameters: {
|
|
113
113
|
query?: never;
|
|
114
114
|
header?: never;
|
|
@@ -116,10 +116,34 @@ export interface paths {
|
|
|
116
116
|
cookie?: never;
|
|
117
117
|
};
|
|
118
118
|
/**
|
|
119
|
-
* List
|
|
120
|
-
* @description
|
|
119
|
+
* List API keys
|
|
120
|
+
* @description Lists Live or Test key metadata for your current business. Requires api_keys_manage. Secrets are returned only when a key is created or rotated.
|
|
121
121
|
*/
|
|
122
|
-
get: operations["
|
|
122
|
+
get: operations["identity.api_keys.list"];
|
|
123
|
+
put?: never;
|
|
124
|
+
/**
|
|
125
|
+
* Create an API key
|
|
126
|
+
* @description Creates a named Live or Test key with explicit scopes and returns its secret. Requires api_keys_manage and an Idempotency-Key. Live keys also require a valid two-factor code; Test keys do not. Store the secret securely when it is returned.
|
|
127
|
+
*/
|
|
128
|
+
post: operations["identity.api_keys.create"];
|
|
129
|
+
delete?: never;
|
|
130
|
+
options?: never;
|
|
131
|
+
head?: never;
|
|
132
|
+
patch?: never;
|
|
133
|
+
trace?: never;
|
|
134
|
+
};
|
|
135
|
+
"/identity/api_keys/availability": {
|
|
136
|
+
parameters: {
|
|
137
|
+
query?: never;
|
|
138
|
+
header?: never;
|
|
139
|
+
path?: never;
|
|
140
|
+
cookie?: never;
|
|
141
|
+
};
|
|
142
|
+
/**
|
|
143
|
+
* Read API availability
|
|
144
|
+
* @description Returns API access status, capabilities and the Test API URL for your current business. One API enablement serves Live and Test. Requires api_keys_manage.
|
|
145
|
+
*/
|
|
146
|
+
get: operations["identity.api_keys.availability"];
|
|
123
147
|
put?: never;
|
|
124
148
|
post?: never;
|
|
125
149
|
delete?: never;
|
|
@@ -128,7 +152,7 @@ export interface paths {
|
|
|
128
152
|
patch?: never;
|
|
129
153
|
trace?: never;
|
|
130
154
|
};
|
|
131
|
-
"/
|
|
155
|
+
"/identity/api_keys/{id}/revoke": {
|
|
132
156
|
parameters: {
|
|
133
157
|
query?: never;
|
|
134
158
|
header?: never;
|
|
@@ -138,37 +162,57 @@ export interface paths {
|
|
|
138
162
|
get?: never;
|
|
139
163
|
put?: never;
|
|
140
164
|
/**
|
|
141
|
-
*
|
|
142
|
-
* @description
|
|
165
|
+
* Revoke an API key
|
|
166
|
+
* @description Revokes a key from your current business. Repeating a completed revocation is safe. Requires api_keys_manage. Live keys also require a valid two-factor code; Test keys do not.
|
|
143
167
|
*/
|
|
144
|
-
post: operations["
|
|
168
|
+
post: operations["identity.api_keys.revoke"];
|
|
145
169
|
delete?: never;
|
|
146
170
|
options?: never;
|
|
147
171
|
head?: never;
|
|
148
172
|
patch?: never;
|
|
149
173
|
trace?: never;
|
|
150
174
|
};
|
|
151
|
-
"/
|
|
175
|
+
"/identity/api_keys/{id}/rotate": {
|
|
152
176
|
parameters: {
|
|
153
177
|
query?: never;
|
|
154
178
|
header?: never;
|
|
155
179
|
path?: never;
|
|
156
180
|
cookie?: never;
|
|
157
181
|
};
|
|
182
|
+
get?: never;
|
|
183
|
+
put?: never;
|
|
158
184
|
/**
|
|
159
|
-
*
|
|
160
|
-
* @description
|
|
185
|
+
* Rotate an API key
|
|
186
|
+
* @description Atomically replaces a key from your current business and revokes its predecessor. Supply the replacement name and scopes explicitly. Requires api_keys_manage and an Idempotency-Key. Live keys also require a valid two-factor code; Test keys do not. Store the returned secret securely.
|
|
161
187
|
*/
|
|
162
|
-
|
|
188
|
+
post: operations["identity.api_keys.rotate"];
|
|
189
|
+
delete?: never;
|
|
190
|
+
options?: never;
|
|
191
|
+
head?: never;
|
|
192
|
+
patch?: never;
|
|
193
|
+
trace?: never;
|
|
194
|
+
};
|
|
195
|
+
"/identity/business_invites/{group_id}/step_2": {
|
|
196
|
+
parameters: {
|
|
197
|
+
query?: never;
|
|
198
|
+
header?: never;
|
|
199
|
+
path?: never;
|
|
200
|
+
cookie?: never;
|
|
201
|
+
};
|
|
202
|
+
get?: never;
|
|
163
203
|
put?: never;
|
|
164
|
-
|
|
204
|
+
/**
|
|
205
|
+
* Inspect an invitation
|
|
206
|
+
* @description Use the token and business ID from your invitation link to check its status and whether you already have an account. This does not accept the invitation.
|
|
207
|
+
*/
|
|
208
|
+
post: operations["identity.business_invites.step2"];
|
|
165
209
|
delete?: never;
|
|
166
210
|
options?: never;
|
|
167
211
|
head?: never;
|
|
168
212
|
patch?: never;
|
|
169
213
|
trace?: never;
|
|
170
214
|
};
|
|
171
|
-
"/
|
|
215
|
+
"/identity/business_invites/{group_id}/step_3": {
|
|
172
216
|
parameters: {
|
|
173
217
|
query?: never;
|
|
174
218
|
header?: never;
|
|
@@ -178,207 +222,2445 @@ export interface paths {
|
|
|
178
222
|
get?: never;
|
|
179
223
|
put?: never;
|
|
180
224
|
/**
|
|
181
|
-
*
|
|
182
|
-
* @description
|
|
225
|
+
* Accept an invitation
|
|
226
|
+
* @description Accept your own invitation using the email-link token and business ID. New members provide their name and password; existing members keep their credentials. Sign in with your own second factor afterward. This does not install session cookies.
|
|
183
227
|
*/
|
|
184
|
-
post: operations["
|
|
228
|
+
post: operations["identity.business_invites.step3"];
|
|
185
229
|
delete?: never;
|
|
186
230
|
options?: never;
|
|
187
231
|
head?: never;
|
|
188
232
|
patch?: never;
|
|
189
233
|
trace?: never;
|
|
190
234
|
};
|
|
191
|
-
"/
|
|
235
|
+
"/identity/change_password": {
|
|
192
236
|
parameters: {
|
|
193
237
|
query?: never;
|
|
194
238
|
header?: never;
|
|
195
239
|
path?: never;
|
|
196
240
|
cookie?: never;
|
|
197
241
|
};
|
|
242
|
+
get?: never;
|
|
243
|
+
put?: never;
|
|
198
244
|
/**
|
|
199
|
-
*
|
|
200
|
-
* @description
|
|
245
|
+
* Change your password
|
|
246
|
+
* @description Requires a business session, your current password and the existing second-factor verification. Changes only the signed-in member's password.
|
|
201
247
|
*/
|
|
202
|
-
|
|
248
|
+
post: operations["identity.password.change"];
|
|
249
|
+
delete?: never;
|
|
250
|
+
options?: never;
|
|
251
|
+
head?: never;
|
|
252
|
+
patch?: never;
|
|
253
|
+
trace?: never;
|
|
254
|
+
};
|
|
255
|
+
"/identity/forgot_password/step_1": {
|
|
256
|
+
parameters: {
|
|
257
|
+
query?: never;
|
|
258
|
+
header?: never;
|
|
259
|
+
path?: never;
|
|
260
|
+
cookie?: never;
|
|
261
|
+
};
|
|
262
|
+
get?: never;
|
|
203
263
|
put?: never;
|
|
204
264
|
/**
|
|
205
|
-
*
|
|
206
|
-
* @description
|
|
265
|
+
* Request a password reset
|
|
266
|
+
* @description Send a password-reset link if the email belongs to an account. The same acknowledgement is returned for an unknown address.
|
|
207
267
|
*/
|
|
208
|
-
post: operations["
|
|
268
|
+
post: operations["identity.forgot_password.step_1"];
|
|
209
269
|
delete?: never;
|
|
210
270
|
options?: never;
|
|
211
271
|
head?: never;
|
|
212
272
|
patch?: never;
|
|
213
273
|
trace?: never;
|
|
214
274
|
};
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
filename?: string;
|
|
222
|
-
mime_type?: string;
|
|
275
|
+
"/identity/forgot_password/step_2": {
|
|
276
|
+
parameters: {
|
|
277
|
+
query?: never;
|
|
278
|
+
header?: never;
|
|
279
|
+
path?: never;
|
|
280
|
+
cookie?: never;
|
|
223
281
|
};
|
|
224
|
-
|
|
225
|
-
|
|
282
|
+
get?: never;
|
|
283
|
+
put?: never;
|
|
284
|
+
/**
|
|
285
|
+
* Reset a password
|
|
286
|
+
* @description Use the token from the password-reset email to set a new password. Continue through the returned sign-in challenge and second factor.
|
|
287
|
+
*/
|
|
288
|
+
post: operations["identity.forgot_password.step_2"];
|
|
289
|
+
delete?: never;
|
|
290
|
+
options?: never;
|
|
291
|
+
head?: never;
|
|
292
|
+
patch?: never;
|
|
293
|
+
trace?: never;
|
|
294
|
+
};
|
|
295
|
+
"/identity/individuals/me": {
|
|
296
|
+
parameters: {
|
|
297
|
+
query?: never;
|
|
298
|
+
header?: never;
|
|
299
|
+
path?: never;
|
|
300
|
+
cookie?: never;
|
|
226
301
|
};
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
type?: "invalid_request_error" | "authentication_error" | "permission_error" | "idempotency_error" | "rate_limit_error" | "api_error";
|
|
302
|
+
/**
|
|
303
|
+
* Retrieve your profile
|
|
304
|
+
* @description Read the signed-in member's name, email, status and active business. Self-service email changes are unavailable; use the supported contact workflow.
|
|
305
|
+
*/
|
|
306
|
+
get: operations["identity.individuals.me.get"];
|
|
307
|
+
put?: never;
|
|
308
|
+
post?: never;
|
|
309
|
+
delete?: never;
|
|
310
|
+
options?: never;
|
|
311
|
+
head?: never;
|
|
312
|
+
patch?: never;
|
|
313
|
+
trace?: never;
|
|
314
|
+
};
|
|
315
|
+
"/identity/members": {
|
|
316
|
+
parameters: {
|
|
317
|
+
query?: never;
|
|
318
|
+
header?: never;
|
|
319
|
+
path?: never;
|
|
320
|
+
cookie?: never;
|
|
247
321
|
};
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
322
|
+
/**
|
|
323
|
+
* List business members
|
|
324
|
+
* @description Lists members of your current business. Use status to select active, inactive or all memberships, and next_cursor for the following page. Requires a signed-in business session.
|
|
325
|
+
*/
|
|
326
|
+
get: operations["identity.members.list"];
|
|
327
|
+
put?: never;
|
|
328
|
+
post?: never;
|
|
329
|
+
delete?: never;
|
|
330
|
+
options?: never;
|
|
331
|
+
head?: never;
|
|
332
|
+
patch?: never;
|
|
333
|
+
trace?: never;
|
|
334
|
+
};
|
|
335
|
+
"/identity/members/invites": {
|
|
336
|
+
parameters: {
|
|
337
|
+
query?: never;
|
|
338
|
+
header?: never;
|
|
339
|
+
path?: never;
|
|
340
|
+
cookie?: never;
|
|
255
341
|
};
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
342
|
+
/**
|
|
343
|
+
* List invitations
|
|
344
|
+
* @description Lists outstanding invitations for your current business, including their expiry and status. Requires a signed-in business session and accepted business terms.
|
|
345
|
+
*/
|
|
346
|
+
get: operations["identity.members.invites.list"];
|
|
347
|
+
put?: never;
|
|
348
|
+
/**
|
|
349
|
+
* Create an invitation
|
|
350
|
+
* @description Invites a person to your current business and returns the invitation resource. The redemption link is sent to the invitee. Requires members_invite, and permissions_manage when selecting permissions. Creation does not automatically retry after an uncertain response; check pending invitations before resending.
|
|
351
|
+
*/
|
|
352
|
+
post: operations["identity.members.invites.create"];
|
|
353
|
+
delete?: never;
|
|
354
|
+
options?: never;
|
|
355
|
+
head?: never;
|
|
356
|
+
patch?: never;
|
|
357
|
+
trace?: never;
|
|
358
|
+
};
|
|
359
|
+
"/identity/members/invites/{id}": {
|
|
360
|
+
parameters: {
|
|
361
|
+
query?: never;
|
|
362
|
+
header?: never;
|
|
363
|
+
path?: never;
|
|
364
|
+
cookie?: never;
|
|
261
365
|
};
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
366
|
+
get?: never;
|
|
367
|
+
put?: never;
|
|
368
|
+
post?: never;
|
|
369
|
+
/**
|
|
370
|
+
* Cancel an invitation
|
|
371
|
+
* @description Cancels an outstanding invitation in your current business. Related pending links for the same address are revoked. Requires members_invite. Unknown or foreign invitation IDs return 404.
|
|
372
|
+
*/
|
|
373
|
+
delete: operations["identity.members.invites.delete"];
|
|
374
|
+
options?: never;
|
|
375
|
+
head?: never;
|
|
376
|
+
patch?: never;
|
|
377
|
+
trace?: never;
|
|
378
|
+
};
|
|
379
|
+
"/identity/members/invites/{id}/refresh": {
|
|
380
|
+
parameters: {
|
|
381
|
+
query?: never;
|
|
382
|
+
header?: never;
|
|
383
|
+
path?: never;
|
|
384
|
+
cookie?: never;
|
|
271
385
|
};
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
386
|
+
get?: never;
|
|
387
|
+
put?: never;
|
|
388
|
+
/**
|
|
389
|
+
* Resend an invitation
|
|
390
|
+
* @description Sends a fresh invitation link and returns the newly issued invitation resource. Preserves the original permission selection. Requires members_invite. Unknown, foreign, canceled or accepted invitations return 404. Do not automatically retry after an uncertain response; check pending invitations first.
|
|
391
|
+
*/
|
|
392
|
+
post: operations["identity.members.invites.refresh_by_id"];
|
|
393
|
+
delete?: never;
|
|
394
|
+
options?: never;
|
|
395
|
+
head?: never;
|
|
396
|
+
patch?: never;
|
|
397
|
+
trace?: never;
|
|
398
|
+
};
|
|
399
|
+
"/identity/members/{id}": {
|
|
400
|
+
parameters: {
|
|
401
|
+
query?: never;
|
|
402
|
+
header?: never;
|
|
403
|
+
path?: never;
|
|
404
|
+
cookie?: never;
|
|
278
405
|
};
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
406
|
+
/**
|
|
407
|
+
* Retrieve a business member
|
|
408
|
+
* @description Returns a member of your current business. An unknown member or a person outside this business returns 404. Requires a signed-in business session.
|
|
409
|
+
*/
|
|
410
|
+
get: operations["identity.members.get"];
|
|
411
|
+
put?: never;
|
|
412
|
+
post?: never;
|
|
413
|
+
delete?: never;
|
|
414
|
+
options?: never;
|
|
415
|
+
head?: never;
|
|
416
|
+
patch?: never;
|
|
417
|
+
trace?: never;
|
|
418
|
+
};
|
|
419
|
+
"/identity/members/{id}/deactivate": {
|
|
420
|
+
parameters: {
|
|
421
|
+
query?: never;
|
|
422
|
+
header?: never;
|
|
423
|
+
path?: never;
|
|
424
|
+
cookie?: never;
|
|
283
425
|
};
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
426
|
+
get?: never;
|
|
427
|
+
put?: never;
|
|
428
|
+
/**
|
|
429
|
+
* Deactivate a member
|
|
430
|
+
* @description Suspends a member's access to your current business and revokes their existing sessions. Requires permissions_manage. You cannot deactivate yourself; existing administrator and membership safeguards apply.
|
|
431
|
+
*/
|
|
432
|
+
post: operations["identity.members.deactivate"];
|
|
433
|
+
delete?: never;
|
|
434
|
+
options?: never;
|
|
435
|
+
head?: never;
|
|
436
|
+
patch?: never;
|
|
437
|
+
trace?: never;
|
|
438
|
+
};
|
|
439
|
+
"/identity/members/{id}/reactivate": {
|
|
440
|
+
parameters: {
|
|
441
|
+
query?: never;
|
|
442
|
+
header?: never;
|
|
443
|
+
path?: never;
|
|
444
|
+
cookie?: never;
|
|
445
|
+
};
|
|
446
|
+
get?: never;
|
|
447
|
+
put?: never;
|
|
448
|
+
/**
|
|
449
|
+
* Reactivate a member
|
|
450
|
+
* @description Restores a suspended membership with its existing permissions. Revoked sessions remain invalid; the member must sign in again. Requires permissions_manage. Removed memberships need a new invitation.
|
|
451
|
+
*/
|
|
452
|
+
post: operations["identity.members.reactivate"];
|
|
453
|
+
delete?: never;
|
|
454
|
+
options?: never;
|
|
455
|
+
head?: never;
|
|
456
|
+
patch?: never;
|
|
457
|
+
trace?: never;
|
|
458
|
+
};
|
|
459
|
+
"/identity/members/{individual_id}/rbac": {
|
|
460
|
+
parameters: {
|
|
461
|
+
query?: never;
|
|
462
|
+
header?: never;
|
|
463
|
+
path?: never;
|
|
464
|
+
cookie?: never;
|
|
465
|
+
};
|
|
466
|
+
/**
|
|
467
|
+
* Read member permissions
|
|
468
|
+
* @description Returns the current permissions of a member in your business. An unknown member or a person outside this business returns 404. Requires a signed-in business session.
|
|
469
|
+
*/
|
|
470
|
+
get: operations["identity.members.rbac.get"];
|
|
471
|
+
put?: never;
|
|
472
|
+
/**
|
|
473
|
+
* Update a member permission
|
|
474
|
+
* @description Sets one permission for a member of your current business and returns the updated permission matrix. Supply rbac_type and enabled. Requires permissions_manage; existing member and grant safeguards still apply.
|
|
475
|
+
*/
|
|
476
|
+
post: operations["identity.members.rbac.set"];
|
|
477
|
+
delete?: never;
|
|
478
|
+
options?: never;
|
|
479
|
+
head?: never;
|
|
480
|
+
patch?: never;
|
|
481
|
+
trace?: never;
|
|
482
|
+
};
|
|
483
|
+
"/identity/sign_in/step_1": {
|
|
484
|
+
parameters: {
|
|
485
|
+
query?: never;
|
|
486
|
+
header?: never;
|
|
487
|
+
path?: never;
|
|
488
|
+
cookie?: never;
|
|
489
|
+
};
|
|
490
|
+
get?: never;
|
|
491
|
+
put?: never;
|
|
492
|
+
/**
|
|
493
|
+
* Start a business sign-in
|
|
494
|
+
* @description Verify your email and password. Continue with the returned session_token and the account's second factor, then select one of your available businesses.
|
|
495
|
+
*/
|
|
496
|
+
post: operations["identity.sign_in.step_1"];
|
|
497
|
+
delete?: never;
|
|
498
|
+
options?: never;
|
|
499
|
+
head?: never;
|
|
500
|
+
patch?: never;
|
|
501
|
+
trace?: never;
|
|
502
|
+
};
|
|
503
|
+
"/identity/sign_in/step_2": {
|
|
504
|
+
parameters: {
|
|
505
|
+
query?: never;
|
|
506
|
+
header?: never;
|
|
507
|
+
path?: never;
|
|
508
|
+
cookie?: never;
|
|
509
|
+
};
|
|
510
|
+
get?: never;
|
|
511
|
+
put?: never;
|
|
512
|
+
/**
|
|
513
|
+
* Verify a sign-in code
|
|
514
|
+
* @description Verify the second factor using the session_token from password sign-in. Returns the short-lived business-selection token and the member's available businesses.
|
|
515
|
+
*/
|
|
516
|
+
post: operations["identity.sign_in.step_2"];
|
|
517
|
+
delete?: never;
|
|
518
|
+
options?: never;
|
|
519
|
+
head?: never;
|
|
520
|
+
patch?: never;
|
|
521
|
+
trace?: never;
|
|
522
|
+
};
|
|
523
|
+
"/identity/sign_in/step_3": {
|
|
524
|
+
parameters: {
|
|
525
|
+
query?: never;
|
|
526
|
+
header?: never;
|
|
527
|
+
path?: never;
|
|
528
|
+
cookie?: never;
|
|
529
|
+
};
|
|
530
|
+
get?: never;
|
|
531
|
+
put?: never;
|
|
532
|
+
/**
|
|
533
|
+
* Finish a business sign-in
|
|
534
|
+
* @description Select a business returned by second-factor verification using its short-lived session_token. Installs HttpOnly access and refresh cookies on the requested host. Keep the complete cookie jar for subsequent requests; no API key is used.
|
|
535
|
+
*/
|
|
536
|
+
post: operations["identity.sign_in.step_3"];
|
|
537
|
+
delete?: never;
|
|
538
|
+
options?: never;
|
|
539
|
+
head?: never;
|
|
540
|
+
patch?: never;
|
|
541
|
+
trace?: never;
|
|
542
|
+
};
|
|
543
|
+
"/identity/sms2fa/request": {
|
|
544
|
+
parameters: {
|
|
545
|
+
query?: never;
|
|
546
|
+
header?: never;
|
|
547
|
+
path?: never;
|
|
548
|
+
cookie?: never;
|
|
549
|
+
};
|
|
550
|
+
get?: never;
|
|
551
|
+
put?: never;
|
|
552
|
+
/**
|
|
553
|
+
* Send a sign-in SMS code
|
|
554
|
+
* @description Request an SMS code using the sign-in session_token. The account must already support SMS authentication.
|
|
555
|
+
*/
|
|
556
|
+
post: operations["identity.sms2fa.request"];
|
|
557
|
+
delete?: never;
|
|
558
|
+
options?: never;
|
|
559
|
+
head?: never;
|
|
560
|
+
patch?: never;
|
|
561
|
+
trace?: never;
|
|
562
|
+
};
|
|
563
|
+
"/identity/sms2fa/verify": {
|
|
564
|
+
parameters: {
|
|
565
|
+
query?: never;
|
|
566
|
+
header?: never;
|
|
567
|
+
path?: never;
|
|
568
|
+
cookie?: never;
|
|
569
|
+
};
|
|
570
|
+
get?: never;
|
|
571
|
+
put?: never;
|
|
572
|
+
/**
|
|
573
|
+
* Verify a sign-in SMS code
|
|
574
|
+
* @description Verify the SMS code using the sign-in session_token, then select a returned business to finish signing in.
|
|
575
|
+
*/
|
|
576
|
+
post: operations["identity.sms2fa.verify"];
|
|
577
|
+
delete?: never;
|
|
578
|
+
options?: never;
|
|
579
|
+
head?: never;
|
|
580
|
+
patch?: never;
|
|
581
|
+
trace?: never;
|
|
582
|
+
};
|
|
583
|
+
"/identity/step_ups": {
|
|
584
|
+
parameters: {
|
|
585
|
+
query?: never;
|
|
586
|
+
header?: never;
|
|
587
|
+
path?: never;
|
|
588
|
+
cookie?: never;
|
|
589
|
+
};
|
|
590
|
+
get?: never;
|
|
591
|
+
put?: never;
|
|
592
|
+
/**
|
|
593
|
+
* Verify a fresh second factor
|
|
594
|
+
* @description Record a fresh second-factor proof for your current business session where an existing action requires it.
|
|
595
|
+
*/
|
|
596
|
+
post: operations["identity.step_ups.create"];
|
|
597
|
+
delete?: never;
|
|
598
|
+
options?: never;
|
|
599
|
+
head?: never;
|
|
600
|
+
patch?: never;
|
|
601
|
+
trace?: never;
|
|
602
|
+
};
|
|
603
|
+
"/identity/two_factor_settings": {
|
|
604
|
+
parameters: {
|
|
605
|
+
query?: never;
|
|
606
|
+
header?: never;
|
|
607
|
+
path?: never;
|
|
608
|
+
cookie?: never;
|
|
609
|
+
};
|
|
610
|
+
/**
|
|
611
|
+
* Retrieve your authentication method
|
|
612
|
+
* @description Read the signed-in business member's current second-factor method.
|
|
613
|
+
*/
|
|
614
|
+
get: operations["identity.twofa.current"];
|
|
615
|
+
put?: never;
|
|
616
|
+
post?: never;
|
|
617
|
+
delete?: never;
|
|
618
|
+
options?: never;
|
|
619
|
+
head?: never;
|
|
620
|
+
patch?: never;
|
|
621
|
+
trace?: never;
|
|
622
|
+
};
|
|
623
|
+
"/identity/two_factor_settings/confirm_totp": {
|
|
624
|
+
parameters: {
|
|
625
|
+
query?: never;
|
|
626
|
+
header?: never;
|
|
627
|
+
path?: never;
|
|
628
|
+
cookie?: never;
|
|
629
|
+
};
|
|
630
|
+
get?: never;
|
|
631
|
+
put?: never;
|
|
632
|
+
/**
|
|
633
|
+
* Activate your authenticator
|
|
634
|
+
* @description Confirm the SMS-to-authenticator switch using its setup token and a code from the prepared authenticator. Requires the same signed-in business member.
|
|
635
|
+
*/
|
|
636
|
+
post: operations["identity.twofa.confirmtotp"];
|
|
637
|
+
delete?: never;
|
|
638
|
+
options?: never;
|
|
639
|
+
head?: never;
|
|
640
|
+
patch?: never;
|
|
641
|
+
trace?: never;
|
|
642
|
+
};
|
|
643
|
+
"/identity/two_factor_settings/send_sms": {
|
|
644
|
+
parameters: {
|
|
645
|
+
query?: never;
|
|
646
|
+
header?: never;
|
|
647
|
+
path?: never;
|
|
648
|
+
cookie?: never;
|
|
649
|
+
};
|
|
650
|
+
get?: never;
|
|
651
|
+
put?: never;
|
|
652
|
+
/**
|
|
653
|
+
* Send a security verification SMS
|
|
654
|
+
* @description Request a code for an existing SMS method and the specified verification purpose. Requires a business session.
|
|
655
|
+
*/
|
|
656
|
+
post: operations["identity.twofa.requeststepupsms"];
|
|
657
|
+
delete?: never;
|
|
658
|
+
options?: never;
|
|
659
|
+
head?: never;
|
|
660
|
+
patch?: never;
|
|
661
|
+
trace?: never;
|
|
662
|
+
};
|
|
663
|
+
"/identity/two_factor_settings/verify_totp_setup": {
|
|
664
|
+
parameters: {
|
|
665
|
+
query?: never;
|
|
666
|
+
header?: never;
|
|
667
|
+
path?: never;
|
|
668
|
+
cookie?: never;
|
|
669
|
+
};
|
|
670
|
+
get?: never;
|
|
671
|
+
put?: never;
|
|
672
|
+
/**
|
|
673
|
+
* Prepare a switch from SMS to an authenticator
|
|
674
|
+
* @description Available to members currently using SMS authentication. Request an SMS code with purpose=totp_setup, then submit that code and your current password. Save the returned setup token privately and confirm a code from the new authenticator to activate it.
|
|
675
|
+
*/
|
|
676
|
+
post: operations["identity.twofa.enrolltotp"];
|
|
677
|
+
delete?: never;
|
|
678
|
+
options?: never;
|
|
679
|
+
head?: never;
|
|
680
|
+
patch?: never;
|
|
681
|
+
trace?: never;
|
|
682
|
+
};
|
|
683
|
+
"/misc/contact_us": {
|
|
684
|
+
parameters: {
|
|
685
|
+
query?: never;
|
|
686
|
+
header?: never;
|
|
687
|
+
path?: never;
|
|
688
|
+
cookie?: never;
|
|
689
|
+
};
|
|
690
|
+
get?: never;
|
|
691
|
+
put?: never;
|
|
692
|
+
/**
|
|
693
|
+
* Contact support
|
|
694
|
+
* @description Records your contact request and sends it to support. Requires a signed-in business session. This submission has no idempotency key: do not automatically retry an uncertain response, because it can send another email.
|
|
695
|
+
*/
|
|
696
|
+
post: operations["misc.contact.submit"];
|
|
697
|
+
delete?: never;
|
|
698
|
+
options?: never;
|
|
699
|
+
head?: never;
|
|
700
|
+
patch?: never;
|
|
701
|
+
trace?: never;
|
|
702
|
+
};
|
|
703
|
+
"/notifications/member_notifications": {
|
|
704
|
+
parameters: {
|
|
705
|
+
query?: never;
|
|
706
|
+
header?: never;
|
|
707
|
+
path?: never;
|
|
708
|
+
cookie?: never;
|
|
709
|
+
};
|
|
710
|
+
/**
|
|
711
|
+
* List your notifications
|
|
712
|
+
* @description Returns your supported notifications for the current business, newest first. Use next_cursor for the following page. Includes registered notification types except QuickBooks. Requires a signed-in business session; account and member locks still apply.
|
|
713
|
+
*/
|
|
714
|
+
get: operations["notifications.member_notifications.list"];
|
|
715
|
+
put?: never;
|
|
716
|
+
post?: never;
|
|
717
|
+
delete?: never;
|
|
718
|
+
options?: never;
|
|
719
|
+
head?: never;
|
|
720
|
+
patch?: never;
|
|
721
|
+
trace?: never;
|
|
722
|
+
};
|
|
723
|
+
"/notifications/member_notifications/mark_seen": {
|
|
724
|
+
parameters: {
|
|
725
|
+
query?: never;
|
|
726
|
+
header?: never;
|
|
727
|
+
path?: never;
|
|
728
|
+
cookie?: never;
|
|
729
|
+
};
|
|
730
|
+
get?: never;
|
|
731
|
+
put?: never;
|
|
732
|
+
/**
|
|
733
|
+
* Mark your feed seen
|
|
734
|
+
* @description Marks supported notifications seen for your current business. Other businesses, people and excluded product categories are unchanged. Requires a signed-in business session.
|
|
735
|
+
*/
|
|
736
|
+
post: operations["notifications.member_notifications.mark_seen"];
|
|
737
|
+
delete?: never;
|
|
738
|
+
options?: never;
|
|
739
|
+
head?: never;
|
|
740
|
+
patch?: never;
|
|
741
|
+
trace?: never;
|
|
742
|
+
};
|
|
743
|
+
"/notifications/member_notifications/unseen": {
|
|
744
|
+
parameters: {
|
|
745
|
+
query?: never;
|
|
746
|
+
header?: never;
|
|
747
|
+
path?: never;
|
|
748
|
+
cookie?: never;
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* Count your unseen notifications
|
|
752
|
+
* @description Counts unseen, unarchived notifications in your supported feed for the current business. Requires a signed-in business session.
|
|
753
|
+
*/
|
|
754
|
+
get: operations["notifications.member_notifications.unseen"];
|
|
755
|
+
put?: never;
|
|
756
|
+
post?: never;
|
|
757
|
+
delete?: never;
|
|
758
|
+
options?: never;
|
|
759
|
+
head?: never;
|
|
760
|
+
patch?: never;
|
|
761
|
+
trace?: never;
|
|
762
|
+
};
|
|
763
|
+
"/notifications/member_notifications/{id}": {
|
|
764
|
+
parameters: {
|
|
765
|
+
query?: never;
|
|
766
|
+
header?: never;
|
|
767
|
+
path?: never;
|
|
768
|
+
cookie?: never;
|
|
769
|
+
};
|
|
770
|
+
get?: never;
|
|
771
|
+
put?: never;
|
|
772
|
+
/**
|
|
773
|
+
* Update a notification
|
|
774
|
+
* @description Marks one of your notifications seen, archived or restored and returns its updated state. Send seen=true or an archived flag; omitted fields stay unchanged. Notifications outside your current business or supported feed return 404. Requires a signed-in business session.
|
|
775
|
+
*/
|
|
776
|
+
post: operations["notifications.member_notifications.update"];
|
|
777
|
+
delete?: never;
|
|
778
|
+
options?: never;
|
|
779
|
+
head?: never;
|
|
780
|
+
patch?: never;
|
|
781
|
+
trace?: never;
|
|
782
|
+
};
|
|
783
|
+
"/notifications/member_preferences": {
|
|
784
|
+
parameters: {
|
|
785
|
+
query?: never;
|
|
786
|
+
header?: never;
|
|
787
|
+
path?: never;
|
|
788
|
+
cookie?: never;
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
791
|
+
* Get your notification preferences
|
|
792
|
+
* @description Returns your supported email and desktop preferences for the current business. Security and other mandatory notices cannot be disabled. Requires a signed-in business session.
|
|
793
|
+
*/
|
|
794
|
+
get: operations["notifications.member_preferences.get"];
|
|
795
|
+
put?: never;
|
|
796
|
+
/**
|
|
797
|
+
* Update your notification preferences
|
|
798
|
+
* @description Updates your supplied email or desktop preferences for the current business and returns the supported preference list. Omitted channels stay unchanged. Mandatory notices and unsupported categories cannot be changed. Requires a signed-in business session.
|
|
799
|
+
*/
|
|
800
|
+
post: operations["notifications.member_preferences.update"];
|
|
801
|
+
delete?: never;
|
|
802
|
+
options?: never;
|
|
803
|
+
head?: never;
|
|
804
|
+
patch?: never;
|
|
805
|
+
trace?: never;
|
|
806
|
+
};
|
|
807
|
+
"/platform_identity_api/auth/token": {
|
|
808
|
+
parameters: {
|
|
809
|
+
query?: never;
|
|
810
|
+
header?: never;
|
|
811
|
+
path?: never;
|
|
812
|
+
cookie?: never;
|
|
813
|
+
};
|
|
814
|
+
get?: never;
|
|
815
|
+
put?: never;
|
|
816
|
+
post?: never;
|
|
817
|
+
/**
|
|
818
|
+
* Sign out
|
|
819
|
+
* @description Revokes the session family identified by a valid refresh or access cookie, then clears both cookies. No-cookie sign-out is idempotent. The existing native response is HTTP 200 with an empty body. On a revocation failure, keep the cookies and retry sign-out; HTTP 500 returns Success=false and Message.
|
|
820
|
+
*/
|
|
821
|
+
delete: operations["identity.tokens.delete"];
|
|
822
|
+
options?: never;
|
|
823
|
+
head?: never;
|
|
824
|
+
patch?: never;
|
|
825
|
+
trace?: never;
|
|
826
|
+
};
|
|
827
|
+
"/platform_identity_api/auth/token/extend": {
|
|
828
|
+
parameters: {
|
|
829
|
+
query?: never;
|
|
830
|
+
header?: never;
|
|
831
|
+
path?: never;
|
|
832
|
+
cookie?: never;
|
|
833
|
+
};
|
|
834
|
+
get?: never;
|
|
835
|
+
put?: never;
|
|
836
|
+
/**
|
|
837
|
+
* Extend your session
|
|
838
|
+
* @description Requires both access and refresh cookies. The existing session duration cap still applies. Check Success, not only HTTP status: a refused extension can return HTTP 200 with Success=false. An absent or invalid access cookie returns a plain-text 401. Response keys retain their native PascalCase spelling.
|
|
839
|
+
*/
|
|
840
|
+
post: operations["identity.tokens.extend"];
|
|
841
|
+
delete?: never;
|
|
842
|
+
options?: never;
|
|
843
|
+
head?: never;
|
|
844
|
+
patch?: never;
|
|
845
|
+
trace?: never;
|
|
846
|
+
};
|
|
847
|
+
"/platform_identity_api/auth/token/refresh": {
|
|
848
|
+
parameters: {
|
|
849
|
+
query?: never;
|
|
850
|
+
header?: never;
|
|
851
|
+
path?: never;
|
|
852
|
+
cookie?: never;
|
|
853
|
+
};
|
|
854
|
+
get?: never;
|
|
855
|
+
put?: never;
|
|
856
|
+
/**
|
|
857
|
+
* Refresh your access cookie
|
|
858
|
+
* @description Send the native refresh cookie using the same cookie jar and host as sign-in. Success=true rotates the cookie pair; HTTP 200 with Success=false refuses refresh and requires sign-in again. The PascalCase response keys and cookie path are the existing native contract.
|
|
859
|
+
*/
|
|
860
|
+
post: operations["identity.tokens.refresh"];
|
|
861
|
+
delete?: never;
|
|
862
|
+
options?: never;
|
|
863
|
+
head?: never;
|
|
864
|
+
patch?: never;
|
|
865
|
+
trace?: never;
|
|
866
|
+
};
|
|
867
|
+
"/platform_identity_api/auth/token/session-time-remaining": {
|
|
868
|
+
parameters: {
|
|
869
|
+
query?: never;
|
|
870
|
+
header?: never;
|
|
871
|
+
path?: never;
|
|
872
|
+
cookie?: never;
|
|
873
|
+
};
|
|
874
|
+
/**
|
|
875
|
+
* Read your session countdown
|
|
876
|
+
* @description Reads the refresh cookie's expiry for the native session countdown. Missing or unreadable cookies return Success=false. The countdown decodes the cookie without authenticating it; it is advisory and never evidence of authorization. Response keys retain their native PascalCase spelling.
|
|
877
|
+
*/
|
|
878
|
+
get: operations["identity.tokens.remaining"];
|
|
879
|
+
put?: never;
|
|
880
|
+
post?: never;
|
|
881
|
+
delete?: never;
|
|
882
|
+
options?: never;
|
|
883
|
+
head?: never;
|
|
884
|
+
patch?: never;
|
|
885
|
+
trace?: never;
|
|
886
|
+
};
|
|
887
|
+
}
|
|
888
|
+
export type webhooks = Record<string, never>;
|
|
889
|
+
export interface components {
|
|
890
|
+
schemas: {
|
|
891
|
+
DocumentsDownloadB64Output: {
|
|
892
|
+
content_b64?: string;
|
|
893
|
+
filename?: string;
|
|
894
|
+
mime_type?: string;
|
|
895
|
+
};
|
|
896
|
+
HttputilAPIError: {
|
|
897
|
+
error?: components["schemas"]["HttputilAPIErrorBody"];
|
|
898
|
+
};
|
|
899
|
+
HttputilAPIErrorBody: {
|
|
900
|
+
/** @description Legal values/transitions on an illegal-transition conflict. */
|
|
901
|
+
allowed?: string[];
|
|
902
|
+
/** @description Credential ID issued by a duplicate credential-mint request. */
|
|
903
|
+
api_client_id?: string;
|
|
904
|
+
/** @description Stable machine-readable error code when supplied; use error.type for uncoded errors. */
|
|
905
|
+
code?: string;
|
|
906
|
+
/** @description Per-field validation breakdown. */
|
|
907
|
+
errors?: components["schemas"]["HttputilAPIFieldError"][];
|
|
908
|
+
/** @description Human-readable explanation. Use code or type for programmatic handling. */
|
|
909
|
+
message?: string;
|
|
910
|
+
/** @description RFC 6901 JSON Pointer to the first offending field, on a validation error or a coded error about one field. */
|
|
911
|
+
param?: string;
|
|
912
|
+
/** @description Correlates with the Request-Id response header. */
|
|
913
|
+
request_id?: string;
|
|
914
|
+
/**
|
|
915
|
+
* @description Error class. One of a closed enum.
|
|
916
|
+
* @enum {string}
|
|
917
|
+
*/
|
|
918
|
+
type?: "invalid_request_error" | "authentication_error" | "permission_error" | "idempotency_error" | "rate_limit_error" | "api_error";
|
|
919
|
+
};
|
|
920
|
+
HttputilAPIFieldError: {
|
|
921
|
+
/** @description Field-level error code. */
|
|
922
|
+
code?: string;
|
|
923
|
+
/** @description Human-readable detail for this field. */
|
|
924
|
+
detail?: string;
|
|
925
|
+
/** @description RFC 6901 JSON Pointer to the offending field. */
|
|
926
|
+
pointer?: string;
|
|
927
|
+
};
|
|
928
|
+
Page_MessagesView: {
|
|
929
|
+
data: components["schemas"]["MessagesView"][] | null;
|
|
930
|
+
has_more: boolean;
|
|
931
|
+
next_cursor: string | null;
|
|
932
|
+
total_count?: number | null;
|
|
933
|
+
};
|
|
934
|
+
MessagesView: {
|
|
935
|
+
content_doc_ids?: string[];
|
|
936
|
+
content_docs?: components["schemas"]["MessagesContentDoc"][];
|
|
937
|
+
content_text_b64?: string;
|
|
938
|
+
created_by?: string;
|
|
939
|
+
/** Format: date-time */
|
|
940
|
+
created_ts?: string;
|
|
941
|
+
group_id?: string;
|
|
942
|
+
id?: string;
|
|
943
|
+
};
|
|
944
|
+
MessagesContentDoc: {
|
|
945
|
+
document_id?: string;
|
|
946
|
+
file_name?: string;
|
|
947
|
+
/** Format: int64 */
|
|
948
|
+
file_size?: number;
|
|
949
|
+
file_type?: string;
|
|
950
|
+
};
|
|
951
|
+
MessagesSendBusinessInput: {
|
|
952
|
+
body?: string;
|
|
953
|
+
content_docs?: components["schemas"]["MessagesSendInputContent"][];
|
|
954
|
+
message_id: string;
|
|
955
|
+
};
|
|
956
|
+
MessagesSendInputContent: {
|
|
957
|
+
document_id: string;
|
|
958
|
+
file_contents_b64: string;
|
|
959
|
+
file_name: string;
|
|
960
|
+
/** Format: int64 */
|
|
961
|
+
file_size?: number;
|
|
962
|
+
file_type?: string;
|
|
963
|
+
};
|
|
964
|
+
MessagesAck: {
|
|
965
|
+
ok?: boolean;
|
|
966
|
+
};
|
|
967
|
+
MessagesUnreadCountOutput: {
|
|
968
|
+
/** Format: int64 */
|
|
969
|
+
count?: number;
|
|
970
|
+
};
|
|
971
|
+
IdentityReportUnrecognizedLoginInput: {
|
|
972
|
+
token?: string;
|
|
973
|
+
};
|
|
974
|
+
AuthAck: {
|
|
975
|
+
ok?: boolean;
|
|
976
|
+
};
|
|
977
|
+
/** @enum {string} */
|
|
978
|
+
CustomerEnvironment: "live" | "test";
|
|
979
|
+
Page_CustomerAPIKey: {
|
|
980
|
+
data: components["schemas"]["CustomerAPIKey"][] | null;
|
|
981
|
+
has_more: boolean;
|
|
982
|
+
next_cursor: string | null;
|
|
983
|
+
total_count?: number | null;
|
|
984
|
+
};
|
|
985
|
+
CustomerAPIKey: {
|
|
986
|
+
api_version?: string;
|
|
987
|
+
/** Format: date-time */
|
|
988
|
+
created_ts?: string;
|
|
989
|
+
id?: string;
|
|
990
|
+
key_prefix?: string;
|
|
991
|
+
key_suffix?: string;
|
|
992
|
+
name?: string;
|
|
993
|
+
/** Format: date-time */
|
|
994
|
+
revoked_ts?: string | null;
|
|
995
|
+
scopes?: string[] | null;
|
|
996
|
+
};
|
|
997
|
+
CustomerCreateInput: {
|
|
998
|
+
environment?: components["schemas"]["CustomerEnvironment"];
|
|
999
|
+
name: string;
|
|
1000
|
+
scopes?: string[] | null;
|
|
1001
|
+
/** @description Required for Live keys; omitted for Test keys */
|
|
1002
|
+
totp_code?: string;
|
|
1003
|
+
};
|
|
1004
|
+
CustomerSecretOutput: {
|
|
1005
|
+
api_key?: components["schemas"]["CustomerAPIKey"];
|
|
1006
|
+
secret?: string;
|
|
1007
|
+
};
|
|
1008
|
+
CustomerAvailabilityOutput: {
|
|
1009
|
+
api_version?: string;
|
|
1010
|
+
capabilities: string[] | null;
|
|
1011
|
+
status: components["schemas"]["CustomerAvailabilityStatus"];
|
|
1012
|
+
test_base_url?: string;
|
|
1013
|
+
};
|
|
1014
|
+
/** @enum {string} */
|
|
1015
|
+
CustomerAvailabilityStatus: "unconfigured" | "draft" | "review" | "active" | "suspended" | "closed";
|
|
1016
|
+
CustomerRevokeInput: {
|
|
1017
|
+
environment?: components["schemas"]["CustomerEnvironment"];
|
|
1018
|
+
/** @description Required for Live keys; omitted for Test keys */
|
|
1019
|
+
totp_code?: string;
|
|
1020
|
+
};
|
|
1021
|
+
CustomerAck: {
|
|
1022
|
+
ok?: boolean;
|
|
1023
|
+
};
|
|
1024
|
+
CustomerRotateInput: {
|
|
1025
|
+
environment?: components["schemas"]["CustomerEnvironment"];
|
|
1026
|
+
name: string;
|
|
1027
|
+
scopes?: string[] | null;
|
|
1028
|
+
/** @description Required for Live keys; omitted for Test keys */
|
|
1029
|
+
totp_code?: string;
|
|
1030
|
+
};
|
|
1031
|
+
IdentityInviteStep2Input: {
|
|
1032
|
+
session_token?: string;
|
|
1033
|
+
};
|
|
1034
|
+
IdentityInviteStep2Output: {
|
|
1035
|
+
pre_existing?: boolean;
|
|
1036
|
+
status?: string;
|
|
1037
|
+
};
|
|
1038
|
+
IdentityInviteStep3Input: {
|
|
1039
|
+
first_name?: string;
|
|
1040
|
+
last_name?: string;
|
|
1041
|
+
password?: string;
|
|
1042
|
+
session_token?: string;
|
|
1043
|
+
};
|
|
1044
|
+
IdentityInviteStep3Output: {
|
|
1045
|
+
activated?: boolean;
|
|
1046
|
+
email?: string;
|
|
1047
|
+
group_id?: string;
|
|
1048
|
+
individual_id?: string;
|
|
1049
|
+
pre_existing?: boolean;
|
|
1050
|
+
};
|
|
1051
|
+
IdentityChangePasswordInput: {
|
|
1052
|
+
current_password?: string;
|
|
1053
|
+
new_password?: string;
|
|
1054
|
+
totp_code?: string;
|
|
1055
|
+
};
|
|
1056
|
+
IdentityForgotPasswordStep1Input: {
|
|
1057
|
+
application?: components["schemas"]["AuthApplicationType"];
|
|
1058
|
+
email?: string;
|
|
1059
|
+
};
|
|
1060
|
+
/** @enum {string} */
|
|
1061
|
+
AuthApplicationType: "business" | "opsdash";
|
|
1062
|
+
IdentityForgotPasswordStep2Input: {
|
|
1063
|
+
new_password?: string;
|
|
1064
|
+
session_token?: string;
|
|
1065
|
+
};
|
|
1066
|
+
IdentitySignInStep1Output: {
|
|
1067
|
+
masked_phone_number?: string;
|
|
1068
|
+
session_token?: string;
|
|
1069
|
+
totp_secret?: components["schemas"]["IdentityTOTPSecretOutput"];
|
|
1070
|
+
twofa_method?: string;
|
|
1071
|
+
};
|
|
1072
|
+
IdentityTOTPSecretOutput: {
|
|
1073
|
+
secret?: string;
|
|
1074
|
+
url?: string;
|
|
1075
|
+
};
|
|
1076
|
+
IndividualsMeOutput: {
|
|
1077
|
+
application?: string;
|
|
1078
|
+
email?: string;
|
|
1079
|
+
first_name?: string;
|
|
1080
|
+
group_id?: string;
|
|
1081
|
+
individual_id?: string;
|
|
1082
|
+
last_name?: string;
|
|
1083
|
+
status?: string;
|
|
1084
|
+
};
|
|
1085
|
+
Page_MembersView: {
|
|
1086
|
+
data: components["schemas"]["MembersView"][] | null;
|
|
1087
|
+
has_more: boolean;
|
|
1088
|
+
next_cursor: string | null;
|
|
1089
|
+
total_count?: number | null;
|
|
1090
|
+
};
|
|
1091
|
+
MembersView: {
|
|
1092
|
+
created_by?: string;
|
|
1093
|
+
/** Format: date-time */
|
|
1094
|
+
created_ts?: string;
|
|
1095
|
+
/** Format: date-time */
|
|
1096
|
+
disabled_ts?: string;
|
|
1097
|
+
email?: string;
|
|
1098
|
+
first_name?: string;
|
|
1099
|
+
group_id?: string;
|
|
1100
|
+
individual_id?: string;
|
|
1101
|
+
last_name?: string;
|
|
1102
|
+
membership_reason?: string;
|
|
1103
|
+
/** @enum {string} */
|
|
1104
|
+
membership_status?: "active" | "inactive";
|
|
1105
|
+
relationship?: string;
|
|
1106
|
+
/** Format: date-time */
|
|
1107
|
+
removed_ts?: string;
|
|
1108
|
+
status?: string;
|
|
1109
|
+
updated_by?: string;
|
|
1110
|
+
/** Format: date-time */
|
|
1111
|
+
updated_ts?: string;
|
|
1112
|
+
};
|
|
1113
|
+
Page_MembersPendingInviteView: {
|
|
1114
|
+
data: components["schemas"]["MembersPendingInviteView"][] | null;
|
|
1115
|
+
has_more: boolean;
|
|
1116
|
+
next_cursor: string | null;
|
|
1117
|
+
total_count?: number | null;
|
|
1118
|
+
};
|
|
1119
|
+
MembersPendingInviteView: {
|
|
1120
|
+
email?: string;
|
|
1121
|
+
/** Format: date-time */
|
|
1122
|
+
expires_ts?: string;
|
|
1123
|
+
first_name?: string;
|
|
1124
|
+
group_id?: string;
|
|
1125
|
+
id?: string;
|
|
1126
|
+
last_name?: string;
|
|
1127
|
+
permissions?: components["schemas"]["IdentityBusinessPermission"][];
|
|
1128
|
+
relationship?: string;
|
|
1129
|
+
status?: components["schemas"]["IdentityInviteStatus"];
|
|
1130
|
+
};
|
|
1131
|
+
/** @enum {string} */
|
|
1132
|
+
IdentityBusinessPermission: "bank_account_add" | "bank_account_remove" | "assets_buy" | "assets_sell" | "funds_deposit" | "funds_withdraw" | "members_invite" | "permissions_manage" | "api_keys_manage" | "transfers_approve";
|
|
1133
|
+
/** @enum {string} */
|
|
1134
|
+
IdentityInviteStatus: "pending" | "expired";
|
|
1135
|
+
MembersCreateInviteInput: {
|
|
1136
|
+
email: string;
|
|
1137
|
+
first_name?: string;
|
|
1138
|
+
last_name?: string;
|
|
1139
|
+
permissions?: components["schemas"]["IdentityBusinessPermission"][];
|
|
1140
|
+
relationship?: string;
|
|
1141
|
+
signer_intent?: components["schemas"]["IdentitySignerIntentInput"];
|
|
1142
|
+
};
|
|
1143
|
+
IdentitySignerIntentInput: {
|
|
1144
|
+
document_id?: string;
|
|
1145
|
+
/** @enum {string} */
|
|
1146
|
+
purpose: "msa" | "kyb_authority" | "service_agreement";
|
|
1147
|
+
};
|
|
1148
|
+
MembersDeleteInviteOutput: {
|
|
1149
|
+
deleted?: boolean;
|
|
1150
|
+
id?: string;
|
|
1151
|
+
};
|
|
1152
|
+
MembersMemberAccessInput: {
|
|
1153
|
+
reason?: string;
|
|
1154
|
+
};
|
|
1155
|
+
MembersGetMemberRBACPoliciesOutput: {
|
|
1156
|
+
api_keys_manage?: boolean;
|
|
1157
|
+
assets_buy?: boolean;
|
|
1158
|
+
assets_sell?: boolean;
|
|
1159
|
+
bank_account_add?: boolean;
|
|
1160
|
+
bank_account_remove?: boolean;
|
|
1161
|
+
funds_deposit?: boolean;
|
|
1162
|
+
funds_withdraw?: boolean;
|
|
1163
|
+
members_invite?: boolean;
|
|
1164
|
+
permissions_manage?: boolean;
|
|
1165
|
+
transfers_approve?: boolean;
|
|
1166
|
+
};
|
|
1167
|
+
MembersSetMemberRBACPolicyInput: {
|
|
1168
|
+
enabled?: boolean;
|
|
1169
|
+
rbac_type: string;
|
|
1170
|
+
};
|
|
1171
|
+
IdentitySignInStep1Input: {
|
|
1172
|
+
email?: string;
|
|
1173
|
+
ip_address?: string;
|
|
1174
|
+
password?: string;
|
|
1175
|
+
required_group_id?: string;
|
|
1176
|
+
};
|
|
1177
|
+
IdentitySignInStep2Input: {
|
|
1178
|
+
ip_address?: string;
|
|
1179
|
+
session_token?: string;
|
|
1180
|
+
totp_code?: string;
|
|
1181
|
+
};
|
|
1182
|
+
IdentitySignInStep2Output: {
|
|
1183
|
+
groups?: components["schemas"]["IdentitySignInStep2GroupOutput"][] | null;
|
|
1184
|
+
session_token?: string;
|
|
1185
|
+
success?: boolean;
|
|
1186
|
+
};
|
|
1187
|
+
IdentitySignInStep2GroupOutput: {
|
|
1188
|
+
business_eligible?: boolean;
|
|
1189
|
+
group_id?: string;
|
|
1190
|
+
individual?: components["schemas"]["IdentitySignInStep2IndividualOutput"];
|
|
1191
|
+
relationship?: string;
|
|
1192
|
+
};
|
|
1193
|
+
IdentitySignInStep2IndividualOutput: {
|
|
1194
|
+
email?: string;
|
|
1195
|
+
first_name?: string;
|
|
1196
|
+
id?: string;
|
|
1197
|
+
last_name?: string;
|
|
1198
|
+
status?: string;
|
|
1199
|
+
};
|
|
1200
|
+
AuthSignInStep3Input: {
|
|
1201
|
+
group_id: string;
|
|
1202
|
+
session_token: string;
|
|
1203
|
+
};
|
|
1204
|
+
AuthSignInStep3Output: {
|
|
1205
|
+
success?: boolean;
|
|
1206
|
+
};
|
|
1207
|
+
IdentityRequestSms2faInput: {
|
|
1208
|
+
phone_number?: string;
|
|
1209
|
+
session_token?: string;
|
|
1210
|
+
};
|
|
1211
|
+
IdentityVerifySms2faInput: {
|
|
1212
|
+
code?: string;
|
|
1213
|
+
ip_address?: string;
|
|
1214
|
+
session_token?: string;
|
|
1215
|
+
};
|
|
1216
|
+
IdentityStepUpCreateInput: {
|
|
1217
|
+
/** @description Current authenticator code. */
|
|
1218
|
+
code: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* @description Second factor to prove. Only totp.
|
|
1221
|
+
* @enum {string}
|
|
1222
|
+
*/
|
|
1223
|
+
method: "totp";
|
|
1224
|
+
};
|
|
1225
|
+
IdentityStepUpCreateOutput: {
|
|
1226
|
+
/**
|
|
1227
|
+
* Format: date-time
|
|
1228
|
+
* @description When the code was verified and recorded.
|
|
1229
|
+
*/
|
|
1230
|
+
verified_ts: string;
|
|
1231
|
+
};
|
|
1232
|
+
IdentityTwofaOutput: {
|
|
1233
|
+
/** @enum {string} */
|
|
1234
|
+
method?: "sms" | "totp";
|
|
1235
|
+
};
|
|
1236
|
+
IdentityTOTPConfirmInput: {
|
|
1237
|
+
code: string;
|
|
1238
|
+
session_token: string;
|
|
1239
|
+
};
|
|
1240
|
+
IdentityStepUpSMSInput: {
|
|
1241
|
+
/** @enum {string} */
|
|
1242
|
+
purpose: "api_keys" | "totp_setup";
|
|
1243
|
+
};
|
|
1244
|
+
IdentityTOTPEnrollInput: {
|
|
1245
|
+
code: string;
|
|
1246
|
+
current_password: string;
|
|
1247
|
+
};
|
|
1248
|
+
IdentityTOTPEnrollOutput: {
|
|
1249
|
+
secret?: string;
|
|
1250
|
+
session_token?: string;
|
|
1251
|
+
url?: string;
|
|
1252
|
+
};
|
|
1253
|
+
MiscContactUsInput: {
|
|
1254
|
+
email?: string;
|
|
1255
|
+
message?: string;
|
|
1256
|
+
name?: string;
|
|
1257
|
+
subject?: string;
|
|
1258
|
+
};
|
|
1259
|
+
MiscAck: {
|
|
1260
|
+
ok?: boolean;
|
|
1261
|
+
};
|
|
1262
|
+
Page_InappNotificationView: {
|
|
1263
|
+
data: components["schemas"]["InappNotificationView"][] | null;
|
|
1264
|
+
has_more: boolean;
|
|
1265
|
+
next_cursor: string | null;
|
|
1266
|
+
total_count?: number | null;
|
|
1267
|
+
};
|
|
1268
|
+
InappNotificationView: {
|
|
1269
|
+
amount_display?: string;
|
|
1270
|
+
archived?: boolean;
|
|
1271
|
+
body?: string;
|
|
1272
|
+
/** Format: date-time */
|
|
1273
|
+
created_ts?: string;
|
|
1274
|
+
group_id?: string;
|
|
1275
|
+
id?: string;
|
|
1276
|
+
individual_id?: string;
|
|
1277
|
+
link?: string;
|
|
1278
|
+
notification_type?: string;
|
|
1279
|
+
seen?: boolean;
|
|
1280
|
+
title?: string;
|
|
1281
|
+
};
|
|
1282
|
+
InappAck: {
|
|
1283
|
+
ok?: boolean;
|
|
1284
|
+
};
|
|
1285
|
+
InappUnseenCountOutput: {
|
|
1286
|
+
/** Format: int64 */
|
|
1287
|
+
count?: number;
|
|
1288
|
+
};
|
|
1289
|
+
InappMemberUpdateInput: {
|
|
1290
|
+
/** @description Set to true to archive or false to restore. Omission preserves its state. */
|
|
1291
|
+
archived?: boolean;
|
|
1292
|
+
/** @description Set to true to mark the notification seen. Omission preserves its state. */
|
|
1293
|
+
seen?: boolean;
|
|
1294
|
+
};
|
|
1295
|
+
PreferencesGetPreferencesOutput: {
|
|
1296
|
+
data?: components["schemas"]["PreferencesView"][] | null;
|
|
1297
|
+
};
|
|
1298
|
+
PreferencesView: {
|
|
1299
|
+
channels?: components["schemas"]["PreferencesChannelStates"];
|
|
1300
|
+
type?: string;
|
|
1301
|
+
};
|
|
1302
|
+
PreferencesChannelStates: {
|
|
1303
|
+
desktop?: boolean;
|
|
1304
|
+
email?: boolean;
|
|
1305
|
+
};
|
|
1306
|
+
PreferencesSetPreferencesInput: {
|
|
1307
|
+
preferences: components["schemas"]["PreferencesTypePreferenceUpdate"][] | null;
|
|
1308
|
+
};
|
|
1309
|
+
PreferencesTypePreferenceUpdate: {
|
|
1310
|
+
channels?: components["schemas"]["PreferencesChannelUpdate"];
|
|
1311
|
+
type: string;
|
|
1312
|
+
};
|
|
1313
|
+
PreferencesChannelUpdate: {
|
|
1314
|
+
desktop?: boolean | null;
|
|
1315
|
+
email?: boolean | null;
|
|
1316
|
+
};
|
|
1317
|
+
IdentitySessionTokenOutput: {
|
|
1318
|
+
Message?: string;
|
|
1319
|
+
Success?: boolean;
|
|
1320
|
+
};
|
|
1321
|
+
IdentitySessionTimeRemainingOutput: {
|
|
1322
|
+
SecondsRemaining?: number;
|
|
1323
|
+
Success?: boolean;
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
responses: never;
|
|
1327
|
+
parameters: never;
|
|
1328
|
+
requestBodies: never;
|
|
1329
|
+
headers: never;
|
|
1330
|
+
pathItems: never;
|
|
1331
|
+
}
|
|
1332
|
+
export type $defs = Record<string, never>;
|
|
1333
|
+
export interface operations {
|
|
1334
|
+
"compliance.documents.download": {
|
|
1335
|
+
parameters: {
|
|
1336
|
+
query?: never;
|
|
1337
|
+
header?: never;
|
|
1338
|
+
path: {
|
|
1339
|
+
id: string;
|
|
1340
|
+
};
|
|
1341
|
+
cookie?: never;
|
|
1342
|
+
};
|
|
1343
|
+
requestBody?: never;
|
|
1344
|
+
responses: {
|
|
1345
|
+
/** @description OK */
|
|
1346
|
+
200: {
|
|
1347
|
+
headers: {
|
|
1348
|
+
[name: string]: unknown;
|
|
1349
|
+
};
|
|
1350
|
+
content: {
|
|
1351
|
+
"application/json": components["schemas"]["DocumentsDownloadB64Output"];
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
/** @description Unauthorized */
|
|
1355
|
+
401: {
|
|
1356
|
+
headers: {
|
|
1357
|
+
[name: string]: unknown;
|
|
1358
|
+
};
|
|
1359
|
+
content: {
|
|
1360
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
/** @description Forbidden */
|
|
1364
|
+
403: {
|
|
1365
|
+
headers: {
|
|
1366
|
+
[name: string]: unknown;
|
|
1367
|
+
};
|
|
1368
|
+
content: {
|
|
1369
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1370
|
+
};
|
|
1371
|
+
};
|
|
1372
|
+
/** @description Not Found */
|
|
1373
|
+
404: {
|
|
1374
|
+
headers: {
|
|
1375
|
+
[name: string]: unknown;
|
|
1376
|
+
};
|
|
1377
|
+
content: {
|
|
1378
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1379
|
+
};
|
|
1380
|
+
};
|
|
1381
|
+
/** @description Error response. */
|
|
1382
|
+
default: {
|
|
1383
|
+
headers: {
|
|
1384
|
+
[name: string]: unknown;
|
|
1385
|
+
};
|
|
1386
|
+
content: {
|
|
1387
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1388
|
+
};
|
|
1389
|
+
};
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
"compliance.messages.list": {
|
|
1393
|
+
parameters: {
|
|
1394
|
+
query?: {
|
|
1395
|
+
limit?: number;
|
|
1396
|
+
cursor?: string;
|
|
1397
|
+
};
|
|
1398
|
+
header?: never;
|
|
1399
|
+
path?: never;
|
|
1400
|
+
cookie?: never;
|
|
1401
|
+
};
|
|
1402
|
+
requestBody?: never;
|
|
1403
|
+
responses: {
|
|
1404
|
+
/** @description OK */
|
|
1405
|
+
200: {
|
|
1406
|
+
headers: {
|
|
1407
|
+
[name: string]: unknown;
|
|
1408
|
+
};
|
|
1409
|
+
content: {
|
|
1410
|
+
"application/json": components["schemas"]["Page_MessagesView"];
|
|
1411
|
+
};
|
|
1412
|
+
};
|
|
1413
|
+
/** @description Bad Request */
|
|
1414
|
+
400: {
|
|
1415
|
+
headers: {
|
|
1416
|
+
[name: string]: unknown;
|
|
1417
|
+
};
|
|
1418
|
+
content: {
|
|
1419
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1420
|
+
};
|
|
1421
|
+
};
|
|
1422
|
+
/** @description Unauthorized */
|
|
1423
|
+
401: {
|
|
1424
|
+
headers: {
|
|
1425
|
+
[name: string]: unknown;
|
|
1426
|
+
};
|
|
1427
|
+
content: {
|
|
1428
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1429
|
+
};
|
|
1430
|
+
};
|
|
1431
|
+
/** @description Forbidden */
|
|
1432
|
+
403: {
|
|
1433
|
+
headers: {
|
|
1434
|
+
[name: string]: unknown;
|
|
1435
|
+
};
|
|
1436
|
+
content: {
|
|
1437
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1438
|
+
};
|
|
1439
|
+
};
|
|
1440
|
+
/** @description Error response. */
|
|
1441
|
+
default: {
|
|
1442
|
+
headers: {
|
|
1443
|
+
[name: string]: unknown;
|
|
1444
|
+
};
|
|
1445
|
+
content: {
|
|
1446
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1447
|
+
};
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
};
|
|
1451
|
+
"compliance.messages.send": {
|
|
1452
|
+
parameters: {
|
|
1453
|
+
query?: never;
|
|
1454
|
+
header?: never;
|
|
1455
|
+
path?: never;
|
|
1456
|
+
cookie?: never;
|
|
1457
|
+
};
|
|
1458
|
+
requestBody?: {
|
|
1459
|
+
content: {
|
|
1460
|
+
"application/json": components["schemas"]["MessagesSendBusinessInput"];
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
responses: {
|
|
1464
|
+
/** @description OK */
|
|
1465
|
+
200: {
|
|
1466
|
+
headers: {
|
|
1467
|
+
[name: string]: unknown;
|
|
1468
|
+
};
|
|
1469
|
+
content: {
|
|
1470
|
+
"application/json": components["schemas"]["MessagesAck"];
|
|
1471
|
+
};
|
|
1472
|
+
};
|
|
1473
|
+
/** @description Bad Request */
|
|
1474
|
+
400: {
|
|
1475
|
+
headers: {
|
|
1476
|
+
[name: string]: unknown;
|
|
1477
|
+
};
|
|
1478
|
+
content: {
|
|
1479
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1480
|
+
};
|
|
1481
|
+
};
|
|
1482
|
+
/** @description Unauthorized */
|
|
1483
|
+
401: {
|
|
1484
|
+
headers: {
|
|
1485
|
+
[name: string]: unknown;
|
|
1486
|
+
};
|
|
1487
|
+
content: {
|
|
1488
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1489
|
+
};
|
|
1490
|
+
};
|
|
1491
|
+
/** @description Forbidden */
|
|
1492
|
+
403: {
|
|
1493
|
+
headers: {
|
|
1494
|
+
[name: string]: unknown;
|
|
1495
|
+
};
|
|
1496
|
+
content: {
|
|
1497
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1498
|
+
};
|
|
1499
|
+
};
|
|
1500
|
+
/** @description Error response. */
|
|
1501
|
+
default: {
|
|
1502
|
+
headers: {
|
|
1503
|
+
[name: string]: unknown;
|
|
1504
|
+
};
|
|
1505
|
+
content: {
|
|
1506
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1507
|
+
};
|
|
1508
|
+
};
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
"compliance.messages.read": {
|
|
1512
|
+
parameters: {
|
|
1513
|
+
query?: never;
|
|
1514
|
+
header?: never;
|
|
1515
|
+
path?: never;
|
|
1516
|
+
cookie?: never;
|
|
1517
|
+
};
|
|
1518
|
+
requestBody?: never;
|
|
1519
|
+
responses: {
|
|
1520
|
+
/** @description OK */
|
|
1521
|
+
200: {
|
|
1522
|
+
headers: {
|
|
1523
|
+
[name: string]: unknown;
|
|
1524
|
+
};
|
|
1525
|
+
content: {
|
|
1526
|
+
"application/json": components["schemas"]["MessagesAck"];
|
|
1527
|
+
};
|
|
1528
|
+
};
|
|
1529
|
+
/** @description Bad Request */
|
|
1530
|
+
400: {
|
|
1531
|
+
headers: {
|
|
1532
|
+
[name: string]: unknown;
|
|
1533
|
+
};
|
|
1534
|
+
content: {
|
|
1535
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
/** @description Unauthorized */
|
|
1539
|
+
401: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1547
|
+
/** @description Forbidden */
|
|
1548
|
+
403: {
|
|
1549
|
+
headers: {
|
|
1550
|
+
[name: string]: unknown;
|
|
1551
|
+
};
|
|
1552
|
+
content: {
|
|
1553
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1554
|
+
};
|
|
1555
|
+
};
|
|
1556
|
+
/** @description Error response. */
|
|
1557
|
+
default: {
|
|
1558
|
+
headers: {
|
|
1559
|
+
[name: string]: unknown;
|
|
1560
|
+
};
|
|
1561
|
+
content: {
|
|
1562
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1563
|
+
};
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
};
|
|
1567
|
+
"compliance.messages.unread.get": {
|
|
1568
|
+
parameters: {
|
|
1569
|
+
query?: never;
|
|
1570
|
+
header?: never;
|
|
1571
|
+
path?: never;
|
|
1572
|
+
cookie?: never;
|
|
1573
|
+
};
|
|
1574
|
+
requestBody?: never;
|
|
1575
|
+
responses: {
|
|
1576
|
+
/** @description OK */
|
|
1577
|
+
200: {
|
|
1578
|
+
headers: {
|
|
1579
|
+
[name: string]: unknown;
|
|
1580
|
+
};
|
|
1581
|
+
content: {
|
|
1582
|
+
"application/json": components["schemas"]["MessagesUnreadCountOutput"];
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
/** @description Bad Request */
|
|
1586
|
+
400: {
|
|
1587
|
+
headers: {
|
|
1588
|
+
[name: string]: unknown;
|
|
1589
|
+
};
|
|
1590
|
+
content: {
|
|
1591
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1592
|
+
};
|
|
1593
|
+
};
|
|
1594
|
+
/** @description Unauthorized */
|
|
1595
|
+
401: {
|
|
1596
|
+
headers: {
|
|
1597
|
+
[name: string]: unknown;
|
|
1598
|
+
};
|
|
1599
|
+
content: {
|
|
1600
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1601
|
+
};
|
|
1602
|
+
};
|
|
1603
|
+
/** @description Forbidden */
|
|
1604
|
+
403: {
|
|
1605
|
+
headers: {
|
|
1606
|
+
[name: string]: unknown;
|
|
1607
|
+
};
|
|
1608
|
+
content: {
|
|
1609
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1610
|
+
};
|
|
1611
|
+
};
|
|
1612
|
+
/** @description Error response. */
|
|
1613
|
+
default: {
|
|
1614
|
+
headers: {
|
|
1615
|
+
[name: string]: unknown;
|
|
1616
|
+
};
|
|
1617
|
+
content: {
|
|
1618
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
};
|
|
1622
|
+
};
|
|
1623
|
+
"identity.account_security.report_unrecognized_login": {
|
|
1624
|
+
parameters: {
|
|
1625
|
+
query?: never;
|
|
1626
|
+
header?: never;
|
|
1627
|
+
path?: never;
|
|
1628
|
+
cookie?: never;
|
|
1629
|
+
};
|
|
1630
|
+
requestBody?: {
|
|
1631
|
+
content: {
|
|
1632
|
+
"application/json": components["schemas"]["IdentityReportUnrecognizedLoginInput"];
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
responses: {
|
|
1636
|
+
/** @description OK */
|
|
1637
|
+
200: {
|
|
1638
|
+
headers: {
|
|
1639
|
+
[name: string]: unknown;
|
|
1640
|
+
};
|
|
1641
|
+
content: {
|
|
1642
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
1643
|
+
};
|
|
1644
|
+
};
|
|
1645
|
+
/** @description Error response. */
|
|
1646
|
+
default: {
|
|
1647
|
+
headers: {
|
|
1648
|
+
[name: string]: unknown;
|
|
1649
|
+
};
|
|
1650
|
+
content: {
|
|
1651
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1652
|
+
};
|
|
1653
|
+
};
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
"identity.api_keys.list": {
|
|
1657
|
+
parameters: {
|
|
1658
|
+
query?: {
|
|
1659
|
+
limit?: number;
|
|
1660
|
+
cursor?: string;
|
|
1661
|
+
environment?: components["schemas"]["CustomerEnvironment"];
|
|
1662
|
+
};
|
|
1663
|
+
header?: never;
|
|
1664
|
+
path?: never;
|
|
1665
|
+
cookie?: never;
|
|
1666
|
+
};
|
|
1667
|
+
requestBody?: never;
|
|
1668
|
+
responses: {
|
|
1669
|
+
/** @description OK */
|
|
1670
|
+
200: {
|
|
1671
|
+
headers: {
|
|
1672
|
+
[name: string]: unknown;
|
|
1673
|
+
};
|
|
1674
|
+
content: {
|
|
1675
|
+
"application/json": components["schemas"]["Page_CustomerAPIKey"];
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
/** @description Error response. */
|
|
1679
|
+
default: {
|
|
1680
|
+
headers: {
|
|
1681
|
+
[name: string]: unknown;
|
|
1682
|
+
};
|
|
1683
|
+
content: {
|
|
1684
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1685
|
+
};
|
|
1686
|
+
};
|
|
1687
|
+
};
|
|
1688
|
+
};
|
|
1689
|
+
"identity.api_keys.create": {
|
|
1690
|
+
parameters: {
|
|
1691
|
+
query?: never;
|
|
1692
|
+
header: {
|
|
1693
|
+
"Idempotency-Key": string;
|
|
1694
|
+
};
|
|
1695
|
+
path?: never;
|
|
1696
|
+
cookie?: never;
|
|
1697
|
+
};
|
|
1698
|
+
requestBody?: {
|
|
1699
|
+
content: {
|
|
1700
|
+
"application/json": components["schemas"]["CustomerCreateInput"];
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
responses: {
|
|
1704
|
+
/** @description OK */
|
|
1705
|
+
200: {
|
|
1706
|
+
headers: {
|
|
1707
|
+
[name: string]: unknown;
|
|
1708
|
+
};
|
|
1709
|
+
content: {
|
|
1710
|
+
"application/json": components["schemas"]["CustomerSecretOutput"];
|
|
1711
|
+
};
|
|
1712
|
+
};
|
|
1713
|
+
/** @description Error response. */
|
|
1714
|
+
default: {
|
|
1715
|
+
headers: {
|
|
1716
|
+
[name: string]: unknown;
|
|
1717
|
+
};
|
|
1718
|
+
content: {
|
|
1719
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1720
|
+
};
|
|
1721
|
+
};
|
|
1722
|
+
};
|
|
1723
|
+
};
|
|
1724
|
+
"identity.api_keys.availability": {
|
|
1725
|
+
parameters: {
|
|
1726
|
+
query?: {
|
|
1727
|
+
environment?: components["schemas"]["CustomerEnvironment"];
|
|
1728
|
+
};
|
|
1729
|
+
header?: never;
|
|
1730
|
+
path?: never;
|
|
1731
|
+
cookie?: never;
|
|
1732
|
+
};
|
|
1733
|
+
requestBody?: never;
|
|
1734
|
+
responses: {
|
|
1735
|
+
/** @description OK */
|
|
1736
|
+
200: {
|
|
1737
|
+
headers: {
|
|
1738
|
+
[name: string]: unknown;
|
|
1739
|
+
};
|
|
1740
|
+
content: {
|
|
1741
|
+
"application/json": components["schemas"]["CustomerAvailabilityOutput"];
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
/** @description Error response. */
|
|
1745
|
+
default: {
|
|
1746
|
+
headers: {
|
|
1747
|
+
[name: string]: unknown;
|
|
1748
|
+
};
|
|
1749
|
+
content: {
|
|
1750
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1751
|
+
};
|
|
1752
|
+
};
|
|
1753
|
+
};
|
|
1754
|
+
};
|
|
1755
|
+
"identity.api_keys.revoke": {
|
|
1756
|
+
parameters: {
|
|
1757
|
+
query?: never;
|
|
1758
|
+
header?: never;
|
|
1759
|
+
path: {
|
|
1760
|
+
id: string;
|
|
1761
|
+
};
|
|
1762
|
+
cookie?: never;
|
|
1763
|
+
};
|
|
1764
|
+
requestBody?: {
|
|
1765
|
+
content: {
|
|
1766
|
+
"application/json": components["schemas"]["CustomerRevokeInput"];
|
|
1767
|
+
};
|
|
1768
|
+
};
|
|
1769
|
+
responses: {
|
|
1770
|
+
/** @description OK */
|
|
1771
|
+
200: {
|
|
1772
|
+
headers: {
|
|
1773
|
+
[name: string]: unknown;
|
|
1774
|
+
};
|
|
1775
|
+
content: {
|
|
1776
|
+
"application/json": components["schemas"]["CustomerAck"];
|
|
1777
|
+
};
|
|
1778
|
+
};
|
|
1779
|
+
/** @description Error response. */
|
|
1780
|
+
default: {
|
|
1781
|
+
headers: {
|
|
1782
|
+
[name: string]: unknown;
|
|
1783
|
+
};
|
|
1784
|
+
content: {
|
|
1785
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
};
|
|
1790
|
+
"identity.api_keys.rotate": {
|
|
1791
|
+
parameters: {
|
|
1792
|
+
query?: never;
|
|
1793
|
+
header: {
|
|
1794
|
+
"Idempotency-Key": string;
|
|
1795
|
+
};
|
|
1796
|
+
path: {
|
|
1797
|
+
id: string;
|
|
1798
|
+
};
|
|
1799
|
+
cookie?: never;
|
|
1800
|
+
};
|
|
1801
|
+
requestBody?: {
|
|
1802
|
+
content: {
|
|
1803
|
+
"application/json": components["schemas"]["CustomerRotateInput"];
|
|
1804
|
+
};
|
|
1805
|
+
};
|
|
1806
|
+
responses: {
|
|
1807
|
+
/** @description OK */
|
|
1808
|
+
200: {
|
|
1809
|
+
headers: {
|
|
1810
|
+
[name: string]: unknown;
|
|
1811
|
+
};
|
|
1812
|
+
content: {
|
|
1813
|
+
"application/json": components["schemas"]["CustomerSecretOutput"];
|
|
1814
|
+
};
|
|
1815
|
+
};
|
|
1816
|
+
/** @description Error response. */
|
|
1817
|
+
default: {
|
|
1818
|
+
headers: {
|
|
1819
|
+
[name: string]: unknown;
|
|
1820
|
+
};
|
|
1821
|
+
content: {
|
|
1822
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1823
|
+
};
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1826
|
+
};
|
|
1827
|
+
"identity.business_invites.step2": {
|
|
1828
|
+
parameters: {
|
|
1829
|
+
query?: never;
|
|
1830
|
+
header?: never;
|
|
1831
|
+
path: {
|
|
1832
|
+
group_id: string;
|
|
1833
|
+
};
|
|
1834
|
+
cookie?: never;
|
|
1835
|
+
};
|
|
1836
|
+
requestBody?: {
|
|
1837
|
+
content: {
|
|
1838
|
+
"application/json": components["schemas"]["IdentityInviteStep2Input"];
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
responses: {
|
|
1842
|
+
/** @description OK */
|
|
1843
|
+
200: {
|
|
1844
|
+
headers: {
|
|
1845
|
+
[name: string]: unknown;
|
|
1846
|
+
};
|
|
1847
|
+
content: {
|
|
1848
|
+
"application/json": components["schemas"]["IdentityInviteStep2Output"];
|
|
1849
|
+
};
|
|
1850
|
+
};
|
|
1851
|
+
/** @description Error response. */
|
|
1852
|
+
default: {
|
|
1853
|
+
headers: {
|
|
1854
|
+
[name: string]: unknown;
|
|
1855
|
+
};
|
|
1856
|
+
content: {
|
|
1857
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1858
|
+
};
|
|
1859
|
+
};
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
"identity.business_invites.step3": {
|
|
1863
|
+
parameters: {
|
|
1864
|
+
query?: never;
|
|
1865
|
+
header?: never;
|
|
1866
|
+
path: {
|
|
1867
|
+
group_id: string;
|
|
1868
|
+
};
|
|
1869
|
+
cookie?: never;
|
|
1870
|
+
};
|
|
1871
|
+
requestBody?: {
|
|
1872
|
+
content: {
|
|
1873
|
+
"application/json": components["schemas"]["IdentityInviteStep3Input"];
|
|
1874
|
+
};
|
|
1875
|
+
};
|
|
1876
|
+
responses: {
|
|
1877
|
+
/** @description OK */
|
|
1878
|
+
200: {
|
|
1879
|
+
headers: {
|
|
1880
|
+
[name: string]: unknown;
|
|
1881
|
+
};
|
|
1882
|
+
content: {
|
|
1883
|
+
"application/json": components["schemas"]["IdentityInviteStep3Output"];
|
|
1884
|
+
};
|
|
1885
|
+
};
|
|
1886
|
+
/** @description Error response. */
|
|
1887
|
+
default: {
|
|
1888
|
+
headers: {
|
|
1889
|
+
[name: string]: unknown;
|
|
1890
|
+
};
|
|
1891
|
+
content: {
|
|
1892
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1893
|
+
};
|
|
1894
|
+
};
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
"identity.password.change": {
|
|
1898
|
+
parameters: {
|
|
1899
|
+
query?: never;
|
|
1900
|
+
header?: never;
|
|
1901
|
+
path?: never;
|
|
1902
|
+
cookie?: never;
|
|
1903
|
+
};
|
|
1904
|
+
requestBody?: {
|
|
1905
|
+
content: {
|
|
1906
|
+
"application/json": components["schemas"]["IdentityChangePasswordInput"];
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
responses: {
|
|
1910
|
+
/** @description OK */
|
|
1911
|
+
200: {
|
|
1912
|
+
headers: {
|
|
1913
|
+
[name: string]: unknown;
|
|
1914
|
+
};
|
|
1915
|
+
content: {
|
|
1916
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
1917
|
+
};
|
|
1918
|
+
};
|
|
1919
|
+
/** @description Error response. */
|
|
1920
|
+
default: {
|
|
1921
|
+
headers: {
|
|
1922
|
+
[name: string]: unknown;
|
|
1923
|
+
};
|
|
1924
|
+
content: {
|
|
1925
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1926
|
+
};
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
};
|
|
1930
|
+
"identity.forgot_password.step_1": {
|
|
1931
|
+
parameters: {
|
|
1932
|
+
query?: never;
|
|
1933
|
+
header?: never;
|
|
1934
|
+
path?: never;
|
|
1935
|
+
cookie?: never;
|
|
1936
|
+
};
|
|
1937
|
+
requestBody?: {
|
|
1938
|
+
content: {
|
|
1939
|
+
"application/json": components["schemas"]["IdentityForgotPasswordStep1Input"];
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
responses: {
|
|
1943
|
+
/** @description OK */
|
|
1944
|
+
200: {
|
|
1945
|
+
headers: {
|
|
1946
|
+
[name: string]: unknown;
|
|
1947
|
+
};
|
|
1948
|
+
content: {
|
|
1949
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
1950
|
+
};
|
|
1951
|
+
};
|
|
1952
|
+
/** @description Error response. */
|
|
1953
|
+
default: {
|
|
1954
|
+
headers: {
|
|
1955
|
+
[name: string]: unknown;
|
|
1956
|
+
};
|
|
1957
|
+
content: {
|
|
1958
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
"identity.forgot_password.step_2": {
|
|
1964
|
+
parameters: {
|
|
1965
|
+
query?: never;
|
|
1966
|
+
header?: never;
|
|
1967
|
+
path?: never;
|
|
1968
|
+
cookie?: never;
|
|
1969
|
+
};
|
|
1970
|
+
requestBody?: {
|
|
1971
|
+
content: {
|
|
1972
|
+
"application/json": components["schemas"]["IdentityForgotPasswordStep2Input"];
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
responses: {
|
|
1976
|
+
/** @description OK */
|
|
1977
|
+
200: {
|
|
1978
|
+
headers: {
|
|
1979
|
+
[name: string]: unknown;
|
|
1980
|
+
};
|
|
1981
|
+
content: {
|
|
1982
|
+
"application/json": components["schemas"]["IdentitySignInStep1Output"];
|
|
1983
|
+
};
|
|
1984
|
+
};
|
|
1985
|
+
/** @description Error response. */
|
|
1986
|
+
default: {
|
|
1987
|
+
headers: {
|
|
1988
|
+
[name: string]: unknown;
|
|
1989
|
+
};
|
|
1990
|
+
content: {
|
|
1991
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
1992
|
+
};
|
|
1993
|
+
};
|
|
1994
|
+
};
|
|
1995
|
+
};
|
|
1996
|
+
"identity.individuals.me.get": {
|
|
1997
|
+
parameters: {
|
|
1998
|
+
query?: never;
|
|
1999
|
+
header?: never;
|
|
2000
|
+
path?: never;
|
|
2001
|
+
cookie?: never;
|
|
2002
|
+
};
|
|
2003
|
+
requestBody?: never;
|
|
2004
|
+
responses: {
|
|
2005
|
+
/** @description OK */
|
|
2006
|
+
200: {
|
|
2007
|
+
headers: {
|
|
2008
|
+
[name: string]: unknown;
|
|
2009
|
+
};
|
|
2010
|
+
content: {
|
|
2011
|
+
"application/json": components["schemas"]["IndividualsMeOutput"];
|
|
2012
|
+
};
|
|
2013
|
+
};
|
|
2014
|
+
/** @description Error response. */
|
|
2015
|
+
default: {
|
|
2016
|
+
headers: {
|
|
2017
|
+
[name: string]: unknown;
|
|
2018
|
+
};
|
|
2019
|
+
content: {
|
|
2020
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
"identity.members.list": {
|
|
2026
|
+
parameters: {
|
|
2027
|
+
query?: {
|
|
2028
|
+
limit?: number;
|
|
2029
|
+
cursor?: string;
|
|
2030
|
+
status?: "active" | "inactive" | "all";
|
|
2031
|
+
};
|
|
2032
|
+
header?: never;
|
|
2033
|
+
path?: never;
|
|
2034
|
+
cookie?: never;
|
|
2035
|
+
};
|
|
2036
|
+
requestBody?: never;
|
|
2037
|
+
responses: {
|
|
2038
|
+
/** @description OK */
|
|
2039
|
+
200: {
|
|
2040
|
+
headers: {
|
|
2041
|
+
[name: string]: unknown;
|
|
2042
|
+
};
|
|
2043
|
+
content: {
|
|
2044
|
+
"application/json": components["schemas"]["Page_MembersView"];
|
|
2045
|
+
};
|
|
2046
|
+
};
|
|
2047
|
+
/** @description Bad Request */
|
|
2048
|
+
400: {
|
|
2049
|
+
headers: {
|
|
2050
|
+
[name: string]: unknown;
|
|
2051
|
+
};
|
|
2052
|
+
content: {
|
|
2053
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2054
|
+
};
|
|
2055
|
+
};
|
|
2056
|
+
/** @description Unauthorized */
|
|
2057
|
+
401: {
|
|
2058
|
+
headers: {
|
|
2059
|
+
[name: string]: unknown;
|
|
2060
|
+
};
|
|
2061
|
+
content: {
|
|
2062
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2063
|
+
};
|
|
2064
|
+
};
|
|
2065
|
+
/** @description Forbidden */
|
|
2066
|
+
403: {
|
|
2067
|
+
headers: {
|
|
2068
|
+
[name: string]: unknown;
|
|
2069
|
+
};
|
|
2070
|
+
content: {
|
|
2071
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2072
|
+
};
|
|
2073
|
+
};
|
|
2074
|
+
/** @description Error response. */
|
|
2075
|
+
default: {
|
|
2076
|
+
headers: {
|
|
2077
|
+
[name: string]: unknown;
|
|
2078
|
+
};
|
|
2079
|
+
content: {
|
|
2080
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
"identity.members.invites.list": {
|
|
2086
|
+
parameters: {
|
|
2087
|
+
query?: {
|
|
2088
|
+
limit?: number;
|
|
2089
|
+
cursor?: string;
|
|
2090
|
+
};
|
|
2091
|
+
header?: never;
|
|
2092
|
+
path?: never;
|
|
2093
|
+
cookie?: never;
|
|
2094
|
+
};
|
|
2095
|
+
requestBody?: never;
|
|
2096
|
+
responses: {
|
|
2097
|
+
/** @description OK */
|
|
2098
|
+
200: {
|
|
2099
|
+
headers: {
|
|
2100
|
+
[name: string]: unknown;
|
|
2101
|
+
};
|
|
2102
|
+
content: {
|
|
2103
|
+
"application/json": components["schemas"]["Page_MembersPendingInviteView"];
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
/** @description Bad Request */
|
|
2107
|
+
400: {
|
|
2108
|
+
headers: {
|
|
2109
|
+
[name: string]: unknown;
|
|
2110
|
+
};
|
|
2111
|
+
content: {
|
|
2112
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2113
|
+
};
|
|
2114
|
+
};
|
|
2115
|
+
/** @description Unauthorized */
|
|
2116
|
+
401: {
|
|
2117
|
+
headers: {
|
|
2118
|
+
[name: string]: unknown;
|
|
2119
|
+
};
|
|
2120
|
+
content: {
|
|
2121
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
/** @description Forbidden */
|
|
2125
|
+
403: {
|
|
2126
|
+
headers: {
|
|
2127
|
+
[name: string]: unknown;
|
|
2128
|
+
};
|
|
2129
|
+
content: {
|
|
2130
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2131
|
+
};
|
|
2132
|
+
};
|
|
2133
|
+
/** @description Error response. */
|
|
2134
|
+
default: {
|
|
2135
|
+
headers: {
|
|
2136
|
+
[name: string]: unknown;
|
|
2137
|
+
};
|
|
2138
|
+
content: {
|
|
2139
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2140
|
+
};
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2143
|
+
};
|
|
2144
|
+
"identity.members.invites.create": {
|
|
2145
|
+
parameters: {
|
|
2146
|
+
query?: never;
|
|
2147
|
+
header?: never;
|
|
2148
|
+
path?: never;
|
|
2149
|
+
cookie?: never;
|
|
2150
|
+
};
|
|
2151
|
+
requestBody?: {
|
|
2152
|
+
content: {
|
|
2153
|
+
"application/json": components["schemas"]["MembersCreateInviteInput"];
|
|
2154
|
+
};
|
|
291
2155
|
};
|
|
292
|
-
|
|
293
|
-
|
|
2156
|
+
responses: {
|
|
2157
|
+
/** @description OK */
|
|
2158
|
+
200: {
|
|
2159
|
+
headers: {
|
|
2160
|
+
[name: string]: unknown;
|
|
2161
|
+
};
|
|
2162
|
+
content: {
|
|
2163
|
+
"application/json": components["schemas"]["MembersPendingInviteView"];
|
|
2164
|
+
};
|
|
2165
|
+
};
|
|
2166
|
+
/** @description Error response. */
|
|
2167
|
+
default: {
|
|
2168
|
+
headers: {
|
|
2169
|
+
[name: string]: unknown;
|
|
2170
|
+
};
|
|
2171
|
+
content: {
|
|
2172
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2173
|
+
};
|
|
2174
|
+
};
|
|
2175
|
+
};
|
|
2176
|
+
};
|
|
2177
|
+
"identity.members.invites.delete": {
|
|
2178
|
+
parameters: {
|
|
2179
|
+
query?: never;
|
|
2180
|
+
header?: never;
|
|
2181
|
+
path: {
|
|
2182
|
+
id: string;
|
|
2183
|
+
};
|
|
2184
|
+
cookie?: never;
|
|
2185
|
+
};
|
|
2186
|
+
requestBody?: never;
|
|
2187
|
+
responses: {
|
|
2188
|
+
/** @description OK */
|
|
2189
|
+
200: {
|
|
2190
|
+
headers: {
|
|
2191
|
+
[name: string]: unknown;
|
|
2192
|
+
};
|
|
2193
|
+
content: {
|
|
2194
|
+
"application/json": components["schemas"]["MembersDeleteInviteOutput"];
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2197
|
+
/** @description Unauthorized */
|
|
2198
|
+
401: {
|
|
2199
|
+
headers: {
|
|
2200
|
+
[name: string]: unknown;
|
|
2201
|
+
};
|
|
2202
|
+
content: {
|
|
2203
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2204
|
+
};
|
|
2205
|
+
};
|
|
2206
|
+
/** @description Forbidden */
|
|
2207
|
+
403: {
|
|
2208
|
+
headers: {
|
|
2209
|
+
[name: string]: unknown;
|
|
2210
|
+
};
|
|
2211
|
+
content: {
|
|
2212
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2213
|
+
};
|
|
2214
|
+
};
|
|
2215
|
+
/** @description Not Found */
|
|
2216
|
+
404: {
|
|
2217
|
+
headers: {
|
|
2218
|
+
[name: string]: unknown;
|
|
2219
|
+
};
|
|
2220
|
+
content: {
|
|
2221
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2222
|
+
};
|
|
2223
|
+
};
|
|
2224
|
+
/** @description Error response. */
|
|
2225
|
+
default: {
|
|
2226
|
+
headers: {
|
|
2227
|
+
[name: string]: unknown;
|
|
2228
|
+
};
|
|
2229
|
+
content: {
|
|
2230
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2231
|
+
};
|
|
2232
|
+
};
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
"identity.members.invites.refresh_by_id": {
|
|
2236
|
+
parameters: {
|
|
2237
|
+
query?: never;
|
|
2238
|
+
header?: never;
|
|
2239
|
+
path: {
|
|
2240
|
+
id: string;
|
|
2241
|
+
};
|
|
2242
|
+
cookie?: never;
|
|
2243
|
+
};
|
|
2244
|
+
requestBody?: never;
|
|
2245
|
+
responses: {
|
|
2246
|
+
/** @description OK */
|
|
2247
|
+
200: {
|
|
2248
|
+
headers: {
|
|
2249
|
+
[name: string]: unknown;
|
|
2250
|
+
};
|
|
2251
|
+
content: {
|
|
2252
|
+
"application/json": components["schemas"]["MembersPendingInviteView"];
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
/** @description Unauthorized */
|
|
2256
|
+
401: {
|
|
2257
|
+
headers: {
|
|
2258
|
+
[name: string]: unknown;
|
|
2259
|
+
};
|
|
2260
|
+
content: {
|
|
2261
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2262
|
+
};
|
|
2263
|
+
};
|
|
2264
|
+
/** @description Forbidden */
|
|
2265
|
+
403: {
|
|
2266
|
+
headers: {
|
|
2267
|
+
[name: string]: unknown;
|
|
2268
|
+
};
|
|
2269
|
+
content: {
|
|
2270
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
/** @description Not Found */
|
|
2274
|
+
404: {
|
|
2275
|
+
headers: {
|
|
2276
|
+
[name: string]: unknown;
|
|
2277
|
+
};
|
|
2278
|
+
content: {
|
|
2279
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2280
|
+
};
|
|
2281
|
+
};
|
|
2282
|
+
/** @description Error response. */
|
|
2283
|
+
default: {
|
|
2284
|
+
headers: {
|
|
2285
|
+
[name: string]: unknown;
|
|
2286
|
+
};
|
|
2287
|
+
content: {
|
|
2288
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2289
|
+
};
|
|
2290
|
+
};
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
2293
|
+
"identity.members.get": {
|
|
2294
|
+
parameters: {
|
|
2295
|
+
query?: never;
|
|
2296
|
+
header?: never;
|
|
2297
|
+
path: {
|
|
2298
|
+
id: string;
|
|
2299
|
+
};
|
|
2300
|
+
cookie?: never;
|
|
2301
|
+
};
|
|
2302
|
+
requestBody?: never;
|
|
2303
|
+
responses: {
|
|
2304
|
+
/** @description OK */
|
|
2305
|
+
200: {
|
|
2306
|
+
headers: {
|
|
2307
|
+
[name: string]: unknown;
|
|
2308
|
+
};
|
|
2309
|
+
content: {
|
|
2310
|
+
"application/json": components["schemas"]["MembersView"];
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
/** @description Unauthorized */
|
|
2314
|
+
401: {
|
|
2315
|
+
headers: {
|
|
2316
|
+
[name: string]: unknown;
|
|
2317
|
+
};
|
|
2318
|
+
content: {
|
|
2319
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2320
|
+
};
|
|
2321
|
+
};
|
|
2322
|
+
/** @description Forbidden */
|
|
2323
|
+
403: {
|
|
2324
|
+
headers: {
|
|
2325
|
+
[name: string]: unknown;
|
|
2326
|
+
};
|
|
2327
|
+
content: {
|
|
2328
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
/** @description Not Found */
|
|
2332
|
+
404: {
|
|
2333
|
+
headers: {
|
|
2334
|
+
[name: string]: unknown;
|
|
2335
|
+
};
|
|
2336
|
+
content: {
|
|
2337
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2338
|
+
};
|
|
2339
|
+
};
|
|
2340
|
+
/** @description Error response. */
|
|
2341
|
+
default: {
|
|
2342
|
+
headers: {
|
|
2343
|
+
[name: string]: unknown;
|
|
2344
|
+
};
|
|
2345
|
+
content: {
|
|
2346
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2347
|
+
};
|
|
2348
|
+
};
|
|
2349
|
+
};
|
|
2350
|
+
};
|
|
2351
|
+
"identity.members.deactivate": {
|
|
2352
|
+
parameters: {
|
|
2353
|
+
query?: never;
|
|
2354
|
+
header?: never;
|
|
2355
|
+
path: {
|
|
2356
|
+
id: string;
|
|
2357
|
+
};
|
|
2358
|
+
cookie?: never;
|
|
2359
|
+
};
|
|
2360
|
+
requestBody?: {
|
|
2361
|
+
content: {
|
|
2362
|
+
"application/json": components["schemas"]["MembersMemberAccessInput"];
|
|
2363
|
+
};
|
|
2364
|
+
};
|
|
2365
|
+
responses: {
|
|
2366
|
+
/** @description OK */
|
|
2367
|
+
200: {
|
|
2368
|
+
headers: {
|
|
2369
|
+
[name: string]: unknown;
|
|
2370
|
+
};
|
|
2371
|
+
content: {
|
|
2372
|
+
"application/json": components["schemas"]["MembersView"];
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
/** @description Bad Request */
|
|
2376
|
+
400: {
|
|
2377
|
+
headers: {
|
|
2378
|
+
[name: string]: unknown;
|
|
2379
|
+
};
|
|
2380
|
+
content: {
|
|
2381
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2382
|
+
};
|
|
2383
|
+
};
|
|
2384
|
+
/** @description Unauthorized */
|
|
2385
|
+
401: {
|
|
2386
|
+
headers: {
|
|
2387
|
+
[name: string]: unknown;
|
|
2388
|
+
};
|
|
2389
|
+
content: {
|
|
2390
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
/** @description Forbidden */
|
|
2394
|
+
403: {
|
|
2395
|
+
headers: {
|
|
2396
|
+
[name: string]: unknown;
|
|
2397
|
+
};
|
|
2398
|
+
content: {
|
|
2399
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2400
|
+
};
|
|
2401
|
+
};
|
|
2402
|
+
/** @description Not Found */
|
|
2403
|
+
404: {
|
|
2404
|
+
headers: {
|
|
2405
|
+
[name: string]: unknown;
|
|
2406
|
+
};
|
|
2407
|
+
content: {
|
|
2408
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2409
|
+
};
|
|
2410
|
+
};
|
|
2411
|
+
/** @description Error response. */
|
|
2412
|
+
default: {
|
|
2413
|
+
headers: {
|
|
2414
|
+
[name: string]: unknown;
|
|
2415
|
+
};
|
|
2416
|
+
content: {
|
|
2417
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
294
2420
|
};
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
2421
|
+
};
|
|
2422
|
+
"identity.members.reactivate": {
|
|
2423
|
+
parameters: {
|
|
2424
|
+
query?: never;
|
|
2425
|
+
header?: never;
|
|
2426
|
+
path: {
|
|
2427
|
+
id: string;
|
|
2428
|
+
};
|
|
2429
|
+
cookie?: never;
|
|
298
2430
|
};
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
subject?: string;
|
|
2431
|
+
requestBody?: {
|
|
2432
|
+
content: {
|
|
2433
|
+
"application/json": components["schemas"]["MembersMemberAccessInput"];
|
|
2434
|
+
};
|
|
304
2435
|
};
|
|
305
|
-
|
|
306
|
-
|
|
2436
|
+
responses: {
|
|
2437
|
+
/** @description OK */
|
|
2438
|
+
200: {
|
|
2439
|
+
headers: {
|
|
2440
|
+
[name: string]: unknown;
|
|
2441
|
+
};
|
|
2442
|
+
content: {
|
|
2443
|
+
"application/json": components["schemas"]["MembersView"];
|
|
2444
|
+
};
|
|
2445
|
+
};
|
|
2446
|
+
/** @description Bad Request */
|
|
2447
|
+
400: {
|
|
2448
|
+
headers: {
|
|
2449
|
+
[name: string]: unknown;
|
|
2450
|
+
};
|
|
2451
|
+
content: {
|
|
2452
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
/** @description Unauthorized */
|
|
2456
|
+
401: {
|
|
2457
|
+
headers: {
|
|
2458
|
+
[name: string]: unknown;
|
|
2459
|
+
};
|
|
2460
|
+
content: {
|
|
2461
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
/** @description Forbidden */
|
|
2465
|
+
403: {
|
|
2466
|
+
headers: {
|
|
2467
|
+
[name: string]: unknown;
|
|
2468
|
+
};
|
|
2469
|
+
content: {
|
|
2470
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2471
|
+
};
|
|
2472
|
+
};
|
|
2473
|
+
/** @description Not Found */
|
|
2474
|
+
404: {
|
|
2475
|
+
headers: {
|
|
2476
|
+
[name: string]: unknown;
|
|
2477
|
+
};
|
|
2478
|
+
content: {
|
|
2479
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2480
|
+
};
|
|
2481
|
+
};
|
|
2482
|
+
/** @description Error response. */
|
|
2483
|
+
default: {
|
|
2484
|
+
headers: {
|
|
2485
|
+
[name: string]: unknown;
|
|
2486
|
+
};
|
|
2487
|
+
content: {
|
|
2488
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2489
|
+
};
|
|
2490
|
+
};
|
|
307
2491
|
};
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
2492
|
+
};
|
|
2493
|
+
"identity.members.rbac.get": {
|
|
2494
|
+
parameters: {
|
|
2495
|
+
query?: never;
|
|
2496
|
+
header?: never;
|
|
2497
|
+
path: {
|
|
2498
|
+
individual_id: string;
|
|
2499
|
+
};
|
|
2500
|
+
cookie?: never;
|
|
313
2501
|
};
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
2502
|
+
requestBody?: never;
|
|
2503
|
+
responses: {
|
|
2504
|
+
/** @description OK */
|
|
2505
|
+
200: {
|
|
2506
|
+
headers: {
|
|
2507
|
+
[name: string]: unknown;
|
|
2508
|
+
};
|
|
2509
|
+
content: {
|
|
2510
|
+
"application/json": components["schemas"]["MembersGetMemberRBACPoliciesOutput"];
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
/** @description Unauthorized */
|
|
2514
|
+
401: {
|
|
2515
|
+
headers: {
|
|
2516
|
+
[name: string]: unknown;
|
|
2517
|
+
};
|
|
2518
|
+
content: {
|
|
2519
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2520
|
+
};
|
|
2521
|
+
};
|
|
2522
|
+
/** @description Forbidden */
|
|
2523
|
+
403: {
|
|
2524
|
+
headers: {
|
|
2525
|
+
[name: string]: unknown;
|
|
2526
|
+
};
|
|
2527
|
+
content: {
|
|
2528
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2529
|
+
};
|
|
2530
|
+
};
|
|
2531
|
+
/** @description Not Found */
|
|
2532
|
+
404: {
|
|
2533
|
+
headers: {
|
|
2534
|
+
[name: string]: unknown;
|
|
2535
|
+
};
|
|
2536
|
+
content: {
|
|
2537
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2538
|
+
};
|
|
2539
|
+
};
|
|
2540
|
+
/** @description Error response. */
|
|
2541
|
+
default: {
|
|
2542
|
+
headers: {
|
|
2543
|
+
[name: string]: unknown;
|
|
2544
|
+
};
|
|
2545
|
+
content: {
|
|
2546
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
327
2549
|
};
|
|
328
|
-
|
|
329
|
-
|
|
2550
|
+
};
|
|
2551
|
+
"identity.members.rbac.set": {
|
|
2552
|
+
parameters: {
|
|
2553
|
+
query?: never;
|
|
2554
|
+
header?: never;
|
|
2555
|
+
path: {
|
|
2556
|
+
individual_id: string;
|
|
2557
|
+
};
|
|
2558
|
+
cookie?: never;
|
|
330
2559
|
};
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
2560
|
+
requestBody?: {
|
|
2561
|
+
content: {
|
|
2562
|
+
"application/json": components["schemas"]["MembersSetMemberRBACPolicyInput"];
|
|
2563
|
+
};
|
|
334
2564
|
};
|
|
335
|
-
|
|
336
|
-
/** @description
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
2565
|
+
responses: {
|
|
2566
|
+
/** @description OK */
|
|
2567
|
+
200: {
|
|
2568
|
+
headers: {
|
|
2569
|
+
[name: string]: unknown;
|
|
2570
|
+
};
|
|
2571
|
+
content: {
|
|
2572
|
+
"application/json": components["schemas"]["MembersGetMemberRBACPoliciesOutput"];
|
|
2573
|
+
};
|
|
2574
|
+
};
|
|
2575
|
+
/** @description Error response. */
|
|
2576
|
+
default: {
|
|
2577
|
+
headers: {
|
|
2578
|
+
[name: string]: unknown;
|
|
2579
|
+
};
|
|
2580
|
+
content: {
|
|
2581
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2582
|
+
};
|
|
2583
|
+
};
|
|
340
2584
|
};
|
|
341
|
-
|
|
342
|
-
|
|
2585
|
+
};
|
|
2586
|
+
"identity.sign_in.step_1": {
|
|
2587
|
+
parameters: {
|
|
2588
|
+
query?: never;
|
|
2589
|
+
header?: never;
|
|
2590
|
+
path?: never;
|
|
2591
|
+
cookie?: never;
|
|
343
2592
|
};
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
2593
|
+
requestBody?: {
|
|
2594
|
+
content: {
|
|
2595
|
+
"application/json": components["schemas"]["IdentitySignInStep1Input"];
|
|
2596
|
+
};
|
|
347
2597
|
};
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
2598
|
+
responses: {
|
|
2599
|
+
/** @description OK */
|
|
2600
|
+
200: {
|
|
2601
|
+
headers: {
|
|
2602
|
+
[name: string]: unknown;
|
|
2603
|
+
};
|
|
2604
|
+
content: {
|
|
2605
|
+
"application/json": components["schemas"]["IdentitySignInStep1Output"];
|
|
2606
|
+
};
|
|
2607
|
+
};
|
|
2608
|
+
/** @description Error response. */
|
|
2609
|
+
default: {
|
|
2610
|
+
headers: {
|
|
2611
|
+
[name: string]: unknown;
|
|
2612
|
+
};
|
|
2613
|
+
content: {
|
|
2614
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2615
|
+
};
|
|
2616
|
+
};
|
|
351
2617
|
};
|
|
352
|
-
|
|
353
|
-
|
|
2618
|
+
};
|
|
2619
|
+
"identity.sign_in.step_2": {
|
|
2620
|
+
parameters: {
|
|
2621
|
+
query?: never;
|
|
2622
|
+
header?: never;
|
|
2623
|
+
path?: never;
|
|
2624
|
+
cookie?: never;
|
|
354
2625
|
};
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
2626
|
+
requestBody?: {
|
|
2627
|
+
content: {
|
|
2628
|
+
"application/json": components["schemas"]["IdentitySignInStep2Input"];
|
|
2629
|
+
};
|
|
358
2630
|
};
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
2631
|
+
responses: {
|
|
2632
|
+
/** @description OK */
|
|
2633
|
+
200: {
|
|
2634
|
+
headers: {
|
|
2635
|
+
[name: string]: unknown;
|
|
2636
|
+
};
|
|
2637
|
+
content: {
|
|
2638
|
+
"application/json": components["schemas"]["IdentitySignInStep2Output"];
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2641
|
+
/** @description Error response. */
|
|
2642
|
+
default: {
|
|
2643
|
+
headers: {
|
|
2644
|
+
[name: string]: unknown;
|
|
2645
|
+
};
|
|
2646
|
+
content: {
|
|
2647
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
362
2650
|
};
|
|
363
2651
|
};
|
|
364
|
-
|
|
365
|
-
parameters: never;
|
|
366
|
-
requestBodies: never;
|
|
367
|
-
headers: never;
|
|
368
|
-
pathItems: never;
|
|
369
|
-
}
|
|
370
|
-
export type $defs = Record<string, never>;
|
|
371
|
-
export interface operations {
|
|
372
|
-
"compliance.documents.download": {
|
|
2652
|
+
"identity.sign_in.step_3": {
|
|
373
2653
|
parameters: {
|
|
374
2654
|
query?: never;
|
|
375
2655
|
header?: never;
|
|
376
|
-
path
|
|
377
|
-
id: string;
|
|
378
|
-
};
|
|
2656
|
+
path?: never;
|
|
379
2657
|
cookie?: never;
|
|
380
2658
|
};
|
|
381
|
-
requestBody?:
|
|
2659
|
+
requestBody?: {
|
|
2660
|
+
content: {
|
|
2661
|
+
"application/json": components["schemas"]["AuthSignInStep3Input"];
|
|
2662
|
+
};
|
|
2663
|
+
};
|
|
382
2664
|
responses: {
|
|
383
2665
|
/** @description OK */
|
|
384
2666
|
200: {
|
|
@@ -386,7 +2668,16 @@ export interface operations {
|
|
|
386
2668
|
[name: string]: unknown;
|
|
387
2669
|
};
|
|
388
2670
|
content: {
|
|
389
|
-
"application/json": components["schemas"]["
|
|
2671
|
+
"application/json": components["schemas"]["AuthSignInStep3Output"];
|
|
2672
|
+
};
|
|
2673
|
+
};
|
|
2674
|
+
/** @description Bad Request */
|
|
2675
|
+
400: {
|
|
2676
|
+
headers: {
|
|
2677
|
+
[name: string]: unknown;
|
|
2678
|
+
};
|
|
2679
|
+
content: {
|
|
2680
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
390
2681
|
};
|
|
391
2682
|
};
|
|
392
2683
|
/** @description Unauthorized */
|
|
@@ -407,8 +2698,8 @@ export interface operations {
|
|
|
407
2698
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
408
2699
|
};
|
|
409
2700
|
};
|
|
410
|
-
/** @description
|
|
411
|
-
|
|
2701
|
+
/** @description Conflict */
|
|
2702
|
+
409: {
|
|
412
2703
|
headers: {
|
|
413
2704
|
[name: string]: unknown;
|
|
414
2705
|
};
|
|
@@ -416,8 +2707,26 @@ export interface operations {
|
|
|
416
2707
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
417
2708
|
};
|
|
418
2709
|
};
|
|
419
|
-
/** @description
|
|
420
|
-
|
|
2710
|
+
/** @description Too Many Requests */
|
|
2711
|
+
429: {
|
|
2712
|
+
headers: {
|
|
2713
|
+
[name: string]: unknown;
|
|
2714
|
+
};
|
|
2715
|
+
content: {
|
|
2716
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2717
|
+
};
|
|
2718
|
+
};
|
|
2719
|
+
/** @description Internal Server Error */
|
|
2720
|
+
500: {
|
|
2721
|
+
headers: {
|
|
2722
|
+
[name: string]: unknown;
|
|
2723
|
+
};
|
|
2724
|
+
content: {
|
|
2725
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2726
|
+
};
|
|
2727
|
+
};
|
|
2728
|
+
/** @description Service Unavailable */
|
|
2729
|
+
503: {
|
|
421
2730
|
headers: {
|
|
422
2731
|
[name: string]: unknown;
|
|
423
2732
|
};
|
|
@@ -427,17 +2736,18 @@ export interface operations {
|
|
|
427
2736
|
};
|
|
428
2737
|
};
|
|
429
2738
|
};
|
|
430
|
-
"
|
|
2739
|
+
"identity.sms2fa.request": {
|
|
431
2740
|
parameters: {
|
|
432
|
-
query?:
|
|
433
|
-
limit?: number;
|
|
434
|
-
cursor?: string;
|
|
435
|
-
};
|
|
2741
|
+
query?: never;
|
|
436
2742
|
header?: never;
|
|
437
2743
|
path?: never;
|
|
438
2744
|
cookie?: never;
|
|
439
2745
|
};
|
|
440
|
-
requestBody?:
|
|
2746
|
+
requestBody?: {
|
|
2747
|
+
content: {
|
|
2748
|
+
"application/json": components["schemas"]["IdentityRequestSms2faInput"];
|
|
2749
|
+
};
|
|
2750
|
+
};
|
|
441
2751
|
responses: {
|
|
442
2752
|
/** @description OK */
|
|
443
2753
|
200: {
|
|
@@ -445,11 +2755,11 @@ export interface operations {
|
|
|
445
2755
|
[name: string]: unknown;
|
|
446
2756
|
};
|
|
447
2757
|
content: {
|
|
448
|
-
"application/json": components["schemas"]["
|
|
2758
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
449
2759
|
};
|
|
450
2760
|
};
|
|
451
|
-
/** @description
|
|
452
|
-
|
|
2761
|
+
/** @description Error response. */
|
|
2762
|
+
default: {
|
|
453
2763
|
headers: {
|
|
454
2764
|
[name: string]: unknown;
|
|
455
2765
|
};
|
|
@@ -457,22 +2767,28 @@ export interface operations {
|
|
|
457
2767
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
458
2768
|
};
|
|
459
2769
|
};
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
2770
|
+
};
|
|
2771
|
+
};
|
|
2772
|
+
"identity.sms2fa.verify": {
|
|
2773
|
+
parameters: {
|
|
2774
|
+
query?: never;
|
|
2775
|
+
header?: never;
|
|
2776
|
+
path?: never;
|
|
2777
|
+
cookie?: never;
|
|
2778
|
+
};
|
|
2779
|
+
requestBody?: {
|
|
2780
|
+
content: {
|
|
2781
|
+
"application/json": components["schemas"]["IdentityVerifySms2faInput"];
|
|
468
2782
|
};
|
|
469
|
-
|
|
470
|
-
|
|
2783
|
+
};
|
|
2784
|
+
responses: {
|
|
2785
|
+
/** @description OK */
|
|
2786
|
+
200: {
|
|
471
2787
|
headers: {
|
|
472
2788
|
[name: string]: unknown;
|
|
473
2789
|
};
|
|
474
2790
|
content: {
|
|
475
|
-
"application/json": components["schemas"]["
|
|
2791
|
+
"application/json": components["schemas"]["IdentitySignInStep2Output"];
|
|
476
2792
|
};
|
|
477
2793
|
};
|
|
478
2794
|
/** @description Error response. */
|
|
@@ -486,7 +2802,7 @@ export interface operations {
|
|
|
486
2802
|
};
|
|
487
2803
|
};
|
|
488
2804
|
};
|
|
489
|
-
"
|
|
2805
|
+
"identity.step_ups.create": {
|
|
490
2806
|
parameters: {
|
|
491
2807
|
query?: never;
|
|
492
2808
|
header?: never;
|
|
@@ -495,7 +2811,7 @@ export interface operations {
|
|
|
495
2811
|
};
|
|
496
2812
|
requestBody?: {
|
|
497
2813
|
content: {
|
|
498
|
-
"application/json": components["schemas"]["
|
|
2814
|
+
"application/json": components["schemas"]["IdentityStepUpCreateInput"];
|
|
499
2815
|
};
|
|
500
2816
|
};
|
|
501
2817
|
responses: {
|
|
@@ -505,7 +2821,7 @@ export interface operations {
|
|
|
505
2821
|
[name: string]: unknown;
|
|
506
2822
|
};
|
|
507
2823
|
content: {
|
|
508
|
-
"application/json": components["schemas"]["
|
|
2824
|
+
"application/json": components["schemas"]["IdentityStepUpCreateOutput"];
|
|
509
2825
|
};
|
|
510
2826
|
};
|
|
511
2827
|
/** @description Bad Request */
|
|
@@ -535,6 +2851,24 @@ export interface operations {
|
|
|
535
2851
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
536
2852
|
};
|
|
537
2853
|
};
|
|
2854
|
+
/** @description Conflict */
|
|
2855
|
+
409: {
|
|
2856
|
+
headers: {
|
|
2857
|
+
[name: string]: unknown;
|
|
2858
|
+
};
|
|
2859
|
+
content: {
|
|
2860
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2861
|
+
};
|
|
2862
|
+
};
|
|
2863
|
+
/** @description Too Many Requests */
|
|
2864
|
+
429: {
|
|
2865
|
+
headers: {
|
|
2866
|
+
[name: string]: unknown;
|
|
2867
|
+
};
|
|
2868
|
+
content: {
|
|
2869
|
+
"application/json": components["schemas"]["HttputilAPIError"];
|
|
2870
|
+
};
|
|
2871
|
+
};
|
|
538
2872
|
/** @description Error response. */
|
|
539
2873
|
default: {
|
|
540
2874
|
headers: {
|
|
@@ -546,7 +2880,7 @@ export interface operations {
|
|
|
546
2880
|
};
|
|
547
2881
|
};
|
|
548
2882
|
};
|
|
549
|
-
"
|
|
2883
|
+
"identity.twofa.current": {
|
|
550
2884
|
parameters: {
|
|
551
2885
|
query?: never;
|
|
552
2886
|
header?: never;
|
|
@@ -561,11 +2895,11 @@ export interface operations {
|
|
|
561
2895
|
[name: string]: unknown;
|
|
562
2896
|
};
|
|
563
2897
|
content: {
|
|
564
|
-
"application/json": components["schemas"]["
|
|
2898
|
+
"application/json": components["schemas"]["IdentityTwofaOutput"];
|
|
565
2899
|
};
|
|
566
2900
|
};
|
|
567
|
-
/** @description
|
|
568
|
-
|
|
2901
|
+
/** @description Error response. */
|
|
2902
|
+
default: {
|
|
569
2903
|
headers: {
|
|
570
2904
|
[name: string]: unknown;
|
|
571
2905
|
};
|
|
@@ -573,22 +2907,28 @@ export interface operations {
|
|
|
573
2907
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
574
2908
|
};
|
|
575
2909
|
};
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
"identity.twofa.confirmtotp": {
|
|
2913
|
+
parameters: {
|
|
2914
|
+
query?: never;
|
|
2915
|
+
header?: never;
|
|
2916
|
+
path?: never;
|
|
2917
|
+
cookie?: never;
|
|
2918
|
+
};
|
|
2919
|
+
requestBody?: {
|
|
2920
|
+
content: {
|
|
2921
|
+
"application/json": components["schemas"]["IdentityTOTPConfirmInput"];
|
|
584
2922
|
};
|
|
585
|
-
|
|
586
|
-
|
|
2923
|
+
};
|
|
2924
|
+
responses: {
|
|
2925
|
+
/** @description OK */
|
|
2926
|
+
200: {
|
|
587
2927
|
headers: {
|
|
588
2928
|
[name: string]: unknown;
|
|
589
2929
|
};
|
|
590
2930
|
content: {
|
|
591
|
-
"application/json": components["schemas"]["
|
|
2931
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
592
2932
|
};
|
|
593
2933
|
};
|
|
594
2934
|
/** @description Error response. */
|
|
@@ -602,14 +2942,18 @@ export interface operations {
|
|
|
602
2942
|
};
|
|
603
2943
|
};
|
|
604
2944
|
};
|
|
605
|
-
"
|
|
2945
|
+
"identity.twofa.requeststepupsms": {
|
|
606
2946
|
parameters: {
|
|
607
2947
|
query?: never;
|
|
608
2948
|
header?: never;
|
|
609
2949
|
path?: never;
|
|
610
2950
|
cookie?: never;
|
|
611
2951
|
};
|
|
612
|
-
requestBody?:
|
|
2952
|
+
requestBody?: {
|
|
2953
|
+
content: {
|
|
2954
|
+
"application/json": components["schemas"]["IdentityStepUpSMSInput"];
|
|
2955
|
+
};
|
|
2956
|
+
};
|
|
613
2957
|
responses: {
|
|
614
2958
|
/** @description OK */
|
|
615
2959
|
200: {
|
|
@@ -617,11 +2961,11 @@ export interface operations {
|
|
|
617
2961
|
[name: string]: unknown;
|
|
618
2962
|
};
|
|
619
2963
|
content: {
|
|
620
|
-
"application/json": components["schemas"]["
|
|
2964
|
+
"application/json": components["schemas"]["AuthAck"];
|
|
621
2965
|
};
|
|
622
2966
|
};
|
|
623
|
-
/** @description
|
|
624
|
-
|
|
2967
|
+
/** @description Error response. */
|
|
2968
|
+
default: {
|
|
625
2969
|
headers: {
|
|
626
2970
|
[name: string]: unknown;
|
|
627
2971
|
};
|
|
@@ -629,22 +2973,28 @@ export interface operations {
|
|
|
629
2973
|
"application/json": components["schemas"]["HttputilAPIError"];
|
|
630
2974
|
};
|
|
631
2975
|
};
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
2976
|
+
};
|
|
2977
|
+
};
|
|
2978
|
+
"identity.twofa.enrolltotp": {
|
|
2979
|
+
parameters: {
|
|
2980
|
+
query?: never;
|
|
2981
|
+
header?: never;
|
|
2982
|
+
path?: never;
|
|
2983
|
+
cookie?: never;
|
|
2984
|
+
};
|
|
2985
|
+
requestBody?: {
|
|
2986
|
+
content: {
|
|
2987
|
+
"application/json": components["schemas"]["IdentityTOTPEnrollInput"];
|
|
640
2988
|
};
|
|
641
|
-
|
|
642
|
-
|
|
2989
|
+
};
|
|
2990
|
+
responses: {
|
|
2991
|
+
/** @description OK */
|
|
2992
|
+
200: {
|
|
643
2993
|
headers: {
|
|
644
2994
|
[name: string]: unknown;
|
|
645
2995
|
};
|
|
646
2996
|
content: {
|
|
647
|
-
"application/json": components["schemas"]["
|
|
2997
|
+
"application/json": components["schemas"]["IdentityTOTPEnrollOutput"];
|
|
648
2998
|
};
|
|
649
2999
|
};
|
|
650
3000
|
/** @description Error response. */
|
|
@@ -1024,4 +3374,100 @@ export interface operations {
|
|
|
1024
3374
|
};
|
|
1025
3375
|
};
|
|
1026
3376
|
};
|
|
3377
|
+
"identity.tokens.delete": {
|
|
3378
|
+
parameters: {
|
|
3379
|
+
query?: never;
|
|
3380
|
+
header?: never;
|
|
3381
|
+
path?: never;
|
|
3382
|
+
cookie?: never;
|
|
3383
|
+
};
|
|
3384
|
+
requestBody?: never;
|
|
3385
|
+
responses: {
|
|
3386
|
+
/** @description OK */
|
|
3387
|
+
200: {
|
|
3388
|
+
headers: {
|
|
3389
|
+
[name: string]: unknown;
|
|
3390
|
+
};
|
|
3391
|
+
content?: never;
|
|
3392
|
+
};
|
|
3393
|
+
/** @description Internal Server Error */
|
|
3394
|
+
500: {
|
|
3395
|
+
headers: {
|
|
3396
|
+
[name: string]: unknown;
|
|
3397
|
+
};
|
|
3398
|
+
content: {
|
|
3399
|
+
"application/json": components["schemas"]["IdentitySessionTokenOutput"];
|
|
3400
|
+
};
|
|
3401
|
+
};
|
|
3402
|
+
};
|
|
3403
|
+
};
|
|
3404
|
+
"identity.tokens.extend": {
|
|
3405
|
+
parameters: {
|
|
3406
|
+
query?: never;
|
|
3407
|
+
header?: never;
|
|
3408
|
+
path?: never;
|
|
3409
|
+
cookie?: never;
|
|
3410
|
+
};
|
|
3411
|
+
requestBody?: never;
|
|
3412
|
+
responses: {
|
|
3413
|
+
/** @description OK */
|
|
3414
|
+
200: {
|
|
3415
|
+
headers: {
|
|
3416
|
+
[name: string]: unknown;
|
|
3417
|
+
};
|
|
3418
|
+
content: {
|
|
3419
|
+
"application/json": components["schemas"]["IdentitySessionTokenOutput"];
|
|
3420
|
+
};
|
|
3421
|
+
};
|
|
3422
|
+
/** @description Unauthorized */
|
|
3423
|
+
401: {
|
|
3424
|
+
headers: {
|
|
3425
|
+
[name: string]: unknown;
|
|
3426
|
+
};
|
|
3427
|
+
content: {
|
|
3428
|
+
"text/plain": string;
|
|
3429
|
+
};
|
|
3430
|
+
};
|
|
3431
|
+
};
|
|
3432
|
+
};
|
|
3433
|
+
"identity.tokens.refresh": {
|
|
3434
|
+
parameters: {
|
|
3435
|
+
query?: never;
|
|
3436
|
+
header?: never;
|
|
3437
|
+
path?: never;
|
|
3438
|
+
cookie?: never;
|
|
3439
|
+
};
|
|
3440
|
+
requestBody?: never;
|
|
3441
|
+
responses: {
|
|
3442
|
+
/** @description OK */
|
|
3443
|
+
200: {
|
|
3444
|
+
headers: {
|
|
3445
|
+
[name: string]: unknown;
|
|
3446
|
+
};
|
|
3447
|
+
content: {
|
|
3448
|
+
"application/json": components["schemas"]["IdentitySessionTokenOutput"];
|
|
3449
|
+
};
|
|
3450
|
+
};
|
|
3451
|
+
};
|
|
3452
|
+
};
|
|
3453
|
+
"identity.tokens.remaining": {
|
|
3454
|
+
parameters: {
|
|
3455
|
+
query?: never;
|
|
3456
|
+
header?: never;
|
|
3457
|
+
path?: never;
|
|
3458
|
+
cookie?: never;
|
|
3459
|
+
};
|
|
3460
|
+
requestBody?: never;
|
|
3461
|
+
responses: {
|
|
3462
|
+
/** @description OK */
|
|
3463
|
+
200: {
|
|
3464
|
+
headers: {
|
|
3465
|
+
[name: string]: unknown;
|
|
3466
|
+
};
|
|
3467
|
+
content: {
|
|
3468
|
+
"application/json": components["schemas"]["IdentitySessionTimeRemainingOutput"];
|
|
3469
|
+
};
|
|
3470
|
+
};
|
|
3471
|
+
};
|
|
3472
|
+
};
|
|
1027
3473
|
}
|