@nvisy/sdk 0.45.0 → 0.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +57 -0
- package/dist/{client-BSm-th0-.d.ts → client-pc1XUsBx.d.ts} +129 -17
- package/dist/client-pc1XUsBx.d.ts.map +1 -0
- package/dist/{config-BhUEqFOg.d.ts → config-BdAgnJlh.d.ts} +22 -12
- package/dist/config-BdAgnJlh.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{error-BxPIw06n.js → error-CPo0Jl05.js} +2 -2
- package/dist/error-CPo0Jl05.js.map +1 -0
- package/dist/{errors-B0aVjvsp.d.ts → errors-Cht3LbX5.d.ts} +2 -2
- package/dist/{errors-B0aVjvsp.d.ts.map → errors-Cht3LbX5.d.ts.map} +1 -1
- package/dist/{index-kr36ZsdV.d.ts → index-B-oR9rqQ.d.ts} +1033 -165
- package/dist/index-B-oR9rqQ.d.ts.map +1 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +32 -13
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +1 -1
- package/dist/services/index.js +1 -1
- package/dist/{services-Wl_lWB66.js → services-FV0hA89s.js} +140 -10
- package/dist/services-FV0hA89s.js.map +1 -0
- package/dist/standalone/index.d.ts +59 -32
- package/dist/standalone/index.d.ts.map +1 -1
- package/dist/standalone/index.js +63 -33
- package/dist/standalone/index.js.map +1 -1
- package/dist/webhooks/index.d.ts +9 -9
- package/dist/webhooks/index.d.ts.map +1 -1
- package/package.json +7 -7
- package/dist/client-BSm-th0-.d.ts.map +0 -1
- package/dist/config-BhUEqFOg.d.ts.map +0 -1
- package/dist/error-BxPIw06n.js.map +0 -1
- package/dist/index-kr36ZsdV.d.ts.map +0 -1
- package/dist/services-Wl_lWB66.js.map +0 -1
|
@@ -117,7 +117,13 @@ interface paths {
|
|
|
117
117
|
path?: never;
|
|
118
118
|
cookie?: never;
|
|
119
119
|
};
|
|
120
|
-
/**
|
|
120
|
+
/**
|
|
121
|
+
* @description Request payload to update an account's profile.
|
|
122
|
+
*
|
|
123
|
+
* Credentials are not profile fields — a password and any linked providers are
|
|
124
|
+
* managed through the account's identities (see the identity endpoints), never
|
|
125
|
+
* here.
|
|
126
|
+
*/
|
|
121
127
|
requestBody: {
|
|
122
128
|
content: {
|
|
123
129
|
"application/json": components["schemas"]["UpdateAccount"];
|
|
@@ -342,7 +348,395 @@ interface paths {
|
|
|
342
348
|
[name: string]: unknown;
|
|
343
349
|
};
|
|
344
350
|
content: {
|
|
345
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
351
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
352
|
+
};
|
|
353
|
+
};
|
|
354
|
+
/**
|
|
355
|
+
* @description HTTP error response representation with security-conscious design.
|
|
356
|
+
*
|
|
357
|
+
* This struct contains all the information needed to serialize an error
|
|
358
|
+
* response, including the error name, message, HTTP status code, resource
|
|
359
|
+
* information, and user-friendly messages.
|
|
360
|
+
*/
|
|
361
|
+
401: {
|
|
362
|
+
headers: {
|
|
363
|
+
[name: string]: unknown;
|
|
364
|
+
};
|
|
365
|
+
content: {
|
|
366
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* @description HTTP error response representation with security-conscious design.
|
|
371
|
+
*
|
|
372
|
+
* This struct contains all the information needed to serialize an error
|
|
373
|
+
* response, including the error name, message, HTTP status code, resource
|
|
374
|
+
* information, and user-friendly messages.
|
|
375
|
+
*/
|
|
376
|
+
403: {
|
|
377
|
+
headers: {
|
|
378
|
+
[name: string]: unknown;
|
|
379
|
+
};
|
|
380
|
+
content: {
|
|
381
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
/**
|
|
385
|
+
* @description HTTP error response representation with security-conscious design.
|
|
386
|
+
*
|
|
387
|
+
* This struct contains all the information needed to serialize an error
|
|
388
|
+
* response, including the error name, message, HTTP status code, resource
|
|
389
|
+
* information, and user-friendly messages.
|
|
390
|
+
*/
|
|
391
|
+
404: {
|
|
392
|
+
headers: {
|
|
393
|
+
[name: string]: unknown;
|
|
394
|
+
};
|
|
395
|
+
content: {
|
|
396
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
};
|
|
401
|
+
post?: never;
|
|
402
|
+
/**
|
|
403
|
+
* Delete account avatar
|
|
404
|
+
* @description Removes the account's avatar. Only the account itself may delete it.
|
|
405
|
+
*/
|
|
406
|
+
delete: {
|
|
407
|
+
parameters: {
|
|
408
|
+
query?: never;
|
|
409
|
+
header?: never;
|
|
410
|
+
path: {
|
|
411
|
+
/** @description Public handle of the account. */
|
|
412
|
+
username: components["schemas"]["Handle"];
|
|
413
|
+
};
|
|
414
|
+
cookie?: never;
|
|
415
|
+
};
|
|
416
|
+
requestBody?: never;
|
|
417
|
+
responses: {
|
|
418
|
+
/** @description no content */
|
|
419
|
+
204: {
|
|
420
|
+
headers: {
|
|
421
|
+
[name: string]: unknown;
|
|
422
|
+
};
|
|
423
|
+
content?: never;
|
|
424
|
+
};
|
|
425
|
+
/**
|
|
426
|
+
* @description HTTP error response representation with security-conscious design.
|
|
427
|
+
*
|
|
428
|
+
* This struct contains all the information needed to serialize an error
|
|
429
|
+
* response, including the error name, message, HTTP status code, resource
|
|
430
|
+
* information, and user-friendly messages.
|
|
431
|
+
*/
|
|
432
|
+
401: {
|
|
433
|
+
headers: {
|
|
434
|
+
[name: string]: unknown;
|
|
435
|
+
};
|
|
436
|
+
content: {
|
|
437
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
/**
|
|
441
|
+
* @description HTTP error response representation with security-conscious design.
|
|
442
|
+
*
|
|
443
|
+
* This struct contains all the information needed to serialize an error
|
|
444
|
+
* response, including the error name, message, HTTP status code, resource
|
|
445
|
+
* information, and user-friendly messages.
|
|
446
|
+
*/
|
|
447
|
+
403: {
|
|
448
|
+
headers: {
|
|
449
|
+
[name: string]: unknown;
|
|
450
|
+
};
|
|
451
|
+
content: {
|
|
452
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
/**
|
|
456
|
+
* @description HTTP error response representation with security-conscious design.
|
|
457
|
+
*
|
|
458
|
+
* This struct contains all the information needed to serialize an error
|
|
459
|
+
* response, including the error name, message, HTTP status code, resource
|
|
460
|
+
* information, and user-friendly messages.
|
|
461
|
+
*/
|
|
462
|
+
404: {
|
|
463
|
+
headers: {
|
|
464
|
+
[name: string]: unknown;
|
|
465
|
+
};
|
|
466
|
+
content: {
|
|
467
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
options?: never;
|
|
473
|
+
head?: never;
|
|
474
|
+
patch?: never;
|
|
475
|
+
trace?: never;
|
|
476
|
+
};
|
|
477
|
+
"/account/identities/": {
|
|
478
|
+
parameters: {
|
|
479
|
+
query?: never;
|
|
480
|
+
header?: never;
|
|
481
|
+
path?: never;
|
|
482
|
+
cookie?: never;
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* List sign-in methods
|
|
486
|
+
* @description Returns the authenticated account's identities: its password and any linked providers.
|
|
487
|
+
*/
|
|
488
|
+
get: {
|
|
489
|
+
parameters: {
|
|
490
|
+
query?: never;
|
|
491
|
+
header?: never;
|
|
492
|
+
path?: never;
|
|
493
|
+
cookie?: never;
|
|
494
|
+
};
|
|
495
|
+
requestBody?: never;
|
|
496
|
+
responses: {
|
|
497
|
+
/** @description The account's sign-in methods. */
|
|
498
|
+
200: {
|
|
499
|
+
headers: {
|
|
500
|
+
[name: string]: unknown;
|
|
501
|
+
};
|
|
502
|
+
content: {
|
|
503
|
+
"application/json": components["schemas"]["AccountIdentities"];
|
|
504
|
+
};
|
|
505
|
+
};
|
|
506
|
+
/**
|
|
507
|
+
* @description HTTP error response representation with security-conscious design.
|
|
508
|
+
*
|
|
509
|
+
* This struct contains all the information needed to serialize an error
|
|
510
|
+
* response, including the error name, message, HTTP status code, resource
|
|
511
|
+
* information, and user-friendly messages.
|
|
512
|
+
*/
|
|
513
|
+
401: {
|
|
514
|
+
headers: {
|
|
515
|
+
[name: string]: unknown;
|
|
516
|
+
};
|
|
517
|
+
content: {
|
|
518
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
};
|
|
523
|
+
put?: never;
|
|
524
|
+
post?: never;
|
|
525
|
+
delete?: never;
|
|
526
|
+
options?: never;
|
|
527
|
+
head?: never;
|
|
528
|
+
patch?: never;
|
|
529
|
+
trace?: never;
|
|
530
|
+
};
|
|
531
|
+
"/account/identities/password/": {
|
|
532
|
+
parameters: {
|
|
533
|
+
query?: never;
|
|
534
|
+
header?: never;
|
|
535
|
+
path?: never;
|
|
536
|
+
cookie?: never;
|
|
537
|
+
};
|
|
538
|
+
get?: never;
|
|
539
|
+
/**
|
|
540
|
+
* Set or change password
|
|
541
|
+
* @description Sets or changes the account's password. Changing an existing password requires the current password; setting a first password on an account that has none requires a step-up re-authentication proof.
|
|
542
|
+
*/
|
|
543
|
+
put: {
|
|
544
|
+
parameters: {
|
|
545
|
+
query?: never;
|
|
546
|
+
header?: never;
|
|
547
|
+
path?: never;
|
|
548
|
+
cookie?: never;
|
|
549
|
+
};
|
|
550
|
+
/**
|
|
551
|
+
* @description A password set or change.
|
|
552
|
+
*
|
|
553
|
+
* When the account already has a password, `current_password` is required and
|
|
554
|
+
* verified before the change is applied, so a hijacked session or CSRF cannot
|
|
555
|
+
* silently reset it (and lock out the real owner). When the account has no
|
|
556
|
+
* password yet (an SSO-only account setting its first one), there is nothing to
|
|
557
|
+
* re-authenticate against, so a fresh step-up `reauth_proof` is required instead
|
|
558
|
+
* — a live session alone must not mint a durable new credential.
|
|
559
|
+
*/
|
|
560
|
+
requestBody: {
|
|
561
|
+
content: {
|
|
562
|
+
"application/json": components["schemas"]["SetPassword"];
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
responses: {
|
|
566
|
+
/** @description Password set. */
|
|
567
|
+
204: {
|
|
568
|
+
headers: {
|
|
569
|
+
[name: string]: unknown;
|
|
570
|
+
};
|
|
571
|
+
content?: never;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* @description HTTP error response representation with security-conscious design.
|
|
575
|
+
*
|
|
576
|
+
* This struct contains all the information needed to serialize an error
|
|
577
|
+
* response, including the error name, message, HTTP status code, resource
|
|
578
|
+
* information, and user-friendly messages.
|
|
579
|
+
*/
|
|
580
|
+
400: {
|
|
581
|
+
headers: {
|
|
582
|
+
[name: string]: unknown;
|
|
583
|
+
};
|
|
584
|
+
content: {
|
|
585
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
/**
|
|
589
|
+
* @description HTTP error response representation with security-conscious design.
|
|
590
|
+
*
|
|
591
|
+
* This struct contains all the information needed to serialize an error
|
|
592
|
+
* response, including the error name, message, HTTP status code, resource
|
|
593
|
+
* information, and user-friendly messages.
|
|
594
|
+
*/
|
|
595
|
+
401: {
|
|
596
|
+
headers: {
|
|
597
|
+
[name: string]: unknown;
|
|
598
|
+
};
|
|
599
|
+
content: {
|
|
600
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
604
|
+
415: {
|
|
605
|
+
headers: {
|
|
606
|
+
[name: string]: unknown;
|
|
607
|
+
};
|
|
608
|
+
content: {
|
|
609
|
+
"text/plain": string;
|
|
610
|
+
};
|
|
611
|
+
};
|
|
612
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
613
|
+
422: {
|
|
614
|
+
headers: {
|
|
615
|
+
[name: string]: unknown;
|
|
616
|
+
};
|
|
617
|
+
content: {
|
|
618
|
+
"text/plain": string;
|
|
619
|
+
};
|
|
620
|
+
};
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
post?: never;
|
|
624
|
+
/**
|
|
625
|
+
* Remove password
|
|
626
|
+
* @description Removes the account's password, leaving it able to sign in only through its linked providers. Refused if the password is the account's only sign-in method.
|
|
627
|
+
*/
|
|
628
|
+
delete: {
|
|
629
|
+
parameters: {
|
|
630
|
+
query?: never;
|
|
631
|
+
header?: never;
|
|
632
|
+
path?: never;
|
|
633
|
+
cookie?: never;
|
|
634
|
+
};
|
|
635
|
+
requestBody?: never;
|
|
636
|
+
responses: {
|
|
637
|
+
/** @description Password removed. */
|
|
638
|
+
204: {
|
|
639
|
+
headers: {
|
|
640
|
+
[name: string]: unknown;
|
|
641
|
+
};
|
|
642
|
+
content?: never;
|
|
643
|
+
};
|
|
644
|
+
/**
|
|
645
|
+
* @description HTTP error response representation with security-conscious design.
|
|
646
|
+
*
|
|
647
|
+
* This struct contains all the information needed to serialize an error
|
|
648
|
+
* response, including the error name, message, HTTP status code, resource
|
|
649
|
+
* information, and user-friendly messages.
|
|
650
|
+
*/
|
|
651
|
+
401: {
|
|
652
|
+
headers: {
|
|
653
|
+
[name: string]: unknown;
|
|
654
|
+
};
|
|
655
|
+
content: {
|
|
656
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
/**
|
|
660
|
+
* @description HTTP error response representation with security-conscious design.
|
|
661
|
+
*
|
|
662
|
+
* This struct contains all the information needed to serialize an error
|
|
663
|
+
* response, including the error name, message, HTTP status code, resource
|
|
664
|
+
* information, and user-friendly messages.
|
|
665
|
+
*/
|
|
666
|
+
404: {
|
|
667
|
+
headers: {
|
|
668
|
+
[name: string]: unknown;
|
|
669
|
+
};
|
|
670
|
+
content: {
|
|
671
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
672
|
+
};
|
|
673
|
+
};
|
|
674
|
+
/**
|
|
675
|
+
* @description HTTP error response representation with security-conscious design.
|
|
676
|
+
*
|
|
677
|
+
* This struct contains all the information needed to serialize an error
|
|
678
|
+
* response, including the error name, message, HTTP status code, resource
|
|
679
|
+
* information, and user-friendly messages.
|
|
680
|
+
*/
|
|
681
|
+
409: {
|
|
682
|
+
headers: {
|
|
683
|
+
[name: string]: unknown;
|
|
684
|
+
};
|
|
685
|
+
content: {
|
|
686
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
687
|
+
};
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
options?: never;
|
|
692
|
+
head?: never;
|
|
693
|
+
patch?: never;
|
|
694
|
+
trace?: never;
|
|
695
|
+
};
|
|
696
|
+
"/account/identities/{provider}/": {
|
|
697
|
+
parameters: {
|
|
698
|
+
query?: never;
|
|
699
|
+
header?: never;
|
|
700
|
+
path?: never;
|
|
701
|
+
cookie?: never;
|
|
702
|
+
};
|
|
703
|
+
get?: never;
|
|
704
|
+
put?: never;
|
|
705
|
+
/**
|
|
706
|
+
* Link a provider
|
|
707
|
+
* @description Begins linking the given OpenID Connect provider to the authenticated account and returns the provider authorize URL. Requires a step-up re-authentication proof (`reauthProof`, from the reauth endpoint). On consent, the callback attaches the verified provider identity to the caller's account.
|
|
708
|
+
*/
|
|
709
|
+
post: {
|
|
710
|
+
parameters: {
|
|
711
|
+
query?: {
|
|
712
|
+
/**
|
|
713
|
+
* @description A step-up re-authentication proof. Required to start a *link* (adding a
|
|
714
|
+
* provider is a credential-adding action, so a live session alone is not
|
|
715
|
+
* enough); ignored for sign-in and reauth.
|
|
716
|
+
*/
|
|
717
|
+
reauthProof?: string;
|
|
718
|
+
/**
|
|
719
|
+
* @description Frontend URL to return to once done. Carried through the flow and used to
|
|
720
|
+
* build the callback's redirect.
|
|
721
|
+
*/
|
|
722
|
+
redirectUri?: string;
|
|
723
|
+
};
|
|
724
|
+
header?: never;
|
|
725
|
+
path: {
|
|
726
|
+
/** @description The identity provider to act on. */
|
|
727
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
728
|
+
};
|
|
729
|
+
cookie?: never;
|
|
730
|
+
};
|
|
731
|
+
requestBody?: never;
|
|
732
|
+
responses: {
|
|
733
|
+
/** @description The response to a successful sign-in start: where to send the user. */
|
|
734
|
+
200: {
|
|
735
|
+
headers: {
|
|
736
|
+
[name: string]: unknown;
|
|
737
|
+
};
|
|
738
|
+
content: {
|
|
739
|
+
"application/json": components["schemas"]["OidcStartResponse"];
|
|
346
740
|
};
|
|
347
741
|
};
|
|
348
742
|
/**
|
|
@@ -367,7 +761,7 @@ interface paths {
|
|
|
367
761
|
* response, including the error name, message, HTTP status code, resource
|
|
368
762
|
* information, and user-friendly messages.
|
|
369
763
|
*/
|
|
370
|
-
|
|
764
|
+
404: {
|
|
371
765
|
headers: {
|
|
372
766
|
[name: string]: unknown;
|
|
373
767
|
};
|
|
@@ -382,7 +776,7 @@ interface paths {
|
|
|
382
776
|
* response, including the error name, message, HTTP status code, resource
|
|
383
777
|
* information, and user-friendly messages.
|
|
384
778
|
*/
|
|
385
|
-
|
|
779
|
+
503: {
|
|
386
780
|
headers: {
|
|
387
781
|
[name: string]: unknown;
|
|
388
782
|
};
|
|
@@ -392,24 +786,23 @@ interface paths {
|
|
|
392
786
|
};
|
|
393
787
|
};
|
|
394
788
|
};
|
|
395
|
-
post?: never;
|
|
396
789
|
/**
|
|
397
|
-
*
|
|
398
|
-
* @description Removes the account
|
|
790
|
+
* Unlink a provider
|
|
791
|
+
* @description Removes a linked OIDC provider from the account. Refused if the provider is the account's only sign-in method.
|
|
399
792
|
*/
|
|
400
793
|
delete: {
|
|
401
794
|
parameters: {
|
|
402
795
|
query?: never;
|
|
403
796
|
header?: never;
|
|
404
797
|
path: {
|
|
405
|
-
/** @description
|
|
406
|
-
|
|
798
|
+
/** @description The identity provider to act on. */
|
|
799
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
407
800
|
};
|
|
408
801
|
cookie?: never;
|
|
409
802
|
};
|
|
410
803
|
requestBody?: never;
|
|
411
804
|
responses: {
|
|
412
|
-
/** @description
|
|
805
|
+
/** @description Provider unlinked. */
|
|
413
806
|
204: {
|
|
414
807
|
headers: {
|
|
415
808
|
[name: string]: unknown;
|
|
@@ -423,7 +816,7 @@ interface paths {
|
|
|
423
816
|
* response, including the error name, message, HTTP status code, resource
|
|
424
817
|
* information, and user-friendly messages.
|
|
425
818
|
*/
|
|
426
|
-
|
|
819
|
+
400: {
|
|
427
820
|
headers: {
|
|
428
821
|
[name: string]: unknown;
|
|
429
822
|
};
|
|
@@ -438,7 +831,7 @@ interface paths {
|
|
|
438
831
|
* response, including the error name, message, HTTP status code, resource
|
|
439
832
|
* information, and user-friendly messages.
|
|
440
833
|
*/
|
|
441
|
-
|
|
834
|
+
401: {
|
|
442
835
|
headers: {
|
|
443
836
|
[name: string]: unknown;
|
|
444
837
|
};
|
|
@@ -461,6 +854,21 @@ interface paths {
|
|
|
461
854
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
462
855
|
};
|
|
463
856
|
};
|
|
857
|
+
/**
|
|
858
|
+
* @description HTTP error response representation with security-conscious design.
|
|
859
|
+
*
|
|
860
|
+
* This struct contains all the information needed to serialize an error
|
|
861
|
+
* response, including the error name, message, HTTP status code, resource
|
|
862
|
+
* information, and user-friendly messages.
|
|
863
|
+
*/
|
|
864
|
+
409: {
|
|
865
|
+
headers: {
|
|
866
|
+
[name: string]: unknown;
|
|
867
|
+
};
|
|
868
|
+
content: {
|
|
869
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
870
|
+
};
|
|
871
|
+
};
|
|
464
872
|
};
|
|
465
873
|
};
|
|
466
874
|
options?: never;
|
|
@@ -2700,6 +3108,117 @@ interface paths {
|
|
|
2700
3108
|
patch?: never;
|
|
2701
3109
|
trace?: never;
|
|
2702
3110
|
};
|
|
3111
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/picker-token/": {
|
|
3112
|
+
parameters: {
|
|
3113
|
+
query?: never;
|
|
3114
|
+
header?: never;
|
|
3115
|
+
path?: never;
|
|
3116
|
+
cookie?: never;
|
|
3117
|
+
};
|
|
3118
|
+
get?: never;
|
|
3119
|
+
put?: never;
|
|
3120
|
+
/**
|
|
3121
|
+
* Mint picker token
|
|
3122
|
+
* @description Returns a short-lived provider access token for a browser file picker (file services with a token-based picker only). The refresh token is never returned.
|
|
3123
|
+
*/
|
|
3124
|
+
post: {
|
|
3125
|
+
parameters: {
|
|
3126
|
+
query?: never;
|
|
3127
|
+
header?: never;
|
|
3128
|
+
path: {
|
|
3129
|
+
/** @description URL-safe workspace identifier. */
|
|
3130
|
+
workspaceSlug: string;
|
|
3131
|
+
/** @description Opaque identifier of the connection. */
|
|
3132
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3133
|
+
};
|
|
3134
|
+
cookie?: never;
|
|
3135
|
+
};
|
|
3136
|
+
requestBody?: never;
|
|
3137
|
+
responses: {
|
|
3138
|
+
/**
|
|
3139
|
+
* @description A short-lived provider OAuth access token for a browser file picker.
|
|
3140
|
+
*
|
|
3141
|
+
* Carries only the access token and its expiry — never the refresh token, which
|
|
3142
|
+
* stays server-side. The token is minted from the connection's stored
|
|
3143
|
+
* credentials and is short-lived (the provider's access-token lifetime), so the
|
|
3144
|
+
* browser holds a narrow, expiring credential rather than a durable one.
|
|
3145
|
+
*/
|
|
3146
|
+
200: {
|
|
3147
|
+
headers: {
|
|
3148
|
+
[name: string]: unknown;
|
|
3149
|
+
};
|
|
3150
|
+
content: {
|
|
3151
|
+
"application/json": components["schemas"]["PickerToken"];
|
|
3152
|
+
};
|
|
3153
|
+
};
|
|
3154
|
+
/**
|
|
3155
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3156
|
+
*
|
|
3157
|
+
* This struct contains all the information needed to serialize an error
|
|
3158
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3159
|
+
* information, and user-friendly messages.
|
|
3160
|
+
*/
|
|
3161
|
+
400: {
|
|
3162
|
+
headers: {
|
|
3163
|
+
[name: string]: unknown;
|
|
3164
|
+
};
|
|
3165
|
+
content: {
|
|
3166
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3167
|
+
};
|
|
3168
|
+
};
|
|
3169
|
+
/**
|
|
3170
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3171
|
+
*
|
|
3172
|
+
* This struct contains all the information needed to serialize an error
|
|
3173
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3174
|
+
* information, and user-friendly messages.
|
|
3175
|
+
*/
|
|
3176
|
+
401: {
|
|
3177
|
+
headers: {
|
|
3178
|
+
[name: string]: unknown;
|
|
3179
|
+
};
|
|
3180
|
+
content: {
|
|
3181
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3182
|
+
};
|
|
3183
|
+
};
|
|
3184
|
+
/**
|
|
3185
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3186
|
+
*
|
|
3187
|
+
* This struct contains all the information needed to serialize an error
|
|
3188
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3189
|
+
* information, and user-friendly messages.
|
|
3190
|
+
*/
|
|
3191
|
+
403: {
|
|
3192
|
+
headers: {
|
|
3193
|
+
[name: string]: unknown;
|
|
3194
|
+
};
|
|
3195
|
+
content: {
|
|
3196
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3197
|
+
};
|
|
3198
|
+
};
|
|
3199
|
+
/**
|
|
3200
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3201
|
+
*
|
|
3202
|
+
* This struct contains all the information needed to serialize an error
|
|
3203
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3204
|
+
* information, and user-friendly messages.
|
|
3205
|
+
*/
|
|
3206
|
+
404: {
|
|
3207
|
+
headers: {
|
|
3208
|
+
[name: string]: unknown;
|
|
3209
|
+
};
|
|
3210
|
+
content: {
|
|
3211
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3212
|
+
};
|
|
3213
|
+
};
|
|
3214
|
+
};
|
|
3215
|
+
};
|
|
3216
|
+
delete?: never;
|
|
3217
|
+
options?: never;
|
|
3218
|
+
head?: never;
|
|
3219
|
+
patch?: never;
|
|
3220
|
+
trace?: never;
|
|
3221
|
+
};
|
|
2703
3222
|
"/workspaces/{workspaceSlug}/connections/oauth/{provider}/start/": {
|
|
2704
3223
|
parameters: {
|
|
2705
3224
|
query?: never;
|
|
@@ -9005,28 +9524,145 @@ interface paths {
|
|
|
9005
9524
|
};
|
|
9006
9525
|
};
|
|
9007
9526
|
responses: {
|
|
9008
|
-
/** @description Workspace webhook response. */
|
|
9527
|
+
/** @description Workspace webhook response. */
|
|
9528
|
+
200: {
|
|
9529
|
+
headers: {
|
|
9530
|
+
[name: string]: unknown;
|
|
9531
|
+
};
|
|
9532
|
+
content: {
|
|
9533
|
+
"application/json": components["schemas"]["Webhook"];
|
|
9534
|
+
};
|
|
9535
|
+
};
|
|
9536
|
+
/**
|
|
9537
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9538
|
+
*
|
|
9539
|
+
* This struct contains all the information needed to serialize an error
|
|
9540
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9541
|
+
* information, and user-friendly messages.
|
|
9542
|
+
*/
|
|
9543
|
+
400: {
|
|
9544
|
+
headers: {
|
|
9545
|
+
[name: string]: unknown;
|
|
9546
|
+
};
|
|
9547
|
+
content: {
|
|
9548
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9549
|
+
};
|
|
9550
|
+
};
|
|
9551
|
+
/**
|
|
9552
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9553
|
+
*
|
|
9554
|
+
* This struct contains all the information needed to serialize an error
|
|
9555
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9556
|
+
* information, and user-friendly messages.
|
|
9557
|
+
*/
|
|
9558
|
+
401: {
|
|
9559
|
+
headers: {
|
|
9560
|
+
[name: string]: unknown;
|
|
9561
|
+
};
|
|
9562
|
+
content: {
|
|
9563
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9564
|
+
};
|
|
9565
|
+
};
|
|
9566
|
+
/**
|
|
9567
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9568
|
+
*
|
|
9569
|
+
* This struct contains all the information needed to serialize an error
|
|
9570
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9571
|
+
* information, and user-friendly messages.
|
|
9572
|
+
*/
|
|
9573
|
+
403: {
|
|
9574
|
+
headers: {
|
|
9575
|
+
[name: string]: unknown;
|
|
9576
|
+
};
|
|
9577
|
+
content: {
|
|
9578
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9579
|
+
};
|
|
9580
|
+
};
|
|
9581
|
+
/**
|
|
9582
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9583
|
+
*
|
|
9584
|
+
* This struct contains all the information needed to serialize an error
|
|
9585
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9586
|
+
* information, and user-friendly messages.
|
|
9587
|
+
*/
|
|
9588
|
+
404: {
|
|
9589
|
+
headers: {
|
|
9590
|
+
[name: string]: unknown;
|
|
9591
|
+
};
|
|
9592
|
+
content: {
|
|
9593
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9594
|
+
};
|
|
9595
|
+
};
|
|
9596
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
9597
|
+
415: {
|
|
9598
|
+
headers: {
|
|
9599
|
+
[name: string]: unknown;
|
|
9600
|
+
};
|
|
9601
|
+
content: {
|
|
9602
|
+
"text/plain": string;
|
|
9603
|
+
};
|
|
9604
|
+
};
|
|
9605
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
9606
|
+
422: {
|
|
9607
|
+
headers: {
|
|
9608
|
+
[name: string]: unknown;
|
|
9609
|
+
};
|
|
9610
|
+
content: {
|
|
9611
|
+
"text/plain": string;
|
|
9612
|
+
};
|
|
9613
|
+
};
|
|
9614
|
+
};
|
|
9615
|
+
};
|
|
9616
|
+
trace?: never;
|
|
9617
|
+
};
|
|
9618
|
+
"/workspaces/{workspaceSlug}/webhooks/{webhookId}/test/": {
|
|
9619
|
+
parameters: {
|
|
9620
|
+
query?: never;
|
|
9621
|
+
header?: never;
|
|
9622
|
+
path?: never;
|
|
9623
|
+
cookie?: never;
|
|
9624
|
+
};
|
|
9625
|
+
get?: never;
|
|
9626
|
+
put?: never;
|
|
9627
|
+
/**
|
|
9628
|
+
* Test webhook
|
|
9629
|
+
* @description Sends a test payload to the webhook endpoint and returns the result.
|
|
9630
|
+
*/
|
|
9631
|
+
post: {
|
|
9632
|
+
parameters: {
|
|
9633
|
+
query?: never;
|
|
9634
|
+
header?: never;
|
|
9635
|
+
path: {
|
|
9636
|
+
/** @description URL-safe workspace identifier. */
|
|
9637
|
+
workspaceSlug: string;
|
|
9638
|
+
/** @description Opaque identifier of the webhook. */
|
|
9639
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
9640
|
+
};
|
|
9641
|
+
cookie?: never;
|
|
9642
|
+
};
|
|
9643
|
+
/** @description Request payload for testing a webhook. */
|
|
9644
|
+
requestBody: {
|
|
9645
|
+
content: {
|
|
9646
|
+
"application/json": components["schemas"]["TestWebhook"];
|
|
9647
|
+
};
|
|
9648
|
+
};
|
|
9649
|
+
responses: {
|
|
9650
|
+
/** @description Result of a webhook delivery attempt. */
|
|
9009
9651
|
200: {
|
|
9010
9652
|
headers: {
|
|
9011
9653
|
[name: string]: unknown;
|
|
9012
9654
|
};
|
|
9013
9655
|
content: {
|
|
9014
|
-
"application/json": components["schemas"]["
|
|
9656
|
+
"application/json": components["schemas"]["WebhookResult"];
|
|
9015
9657
|
};
|
|
9016
9658
|
};
|
|
9017
|
-
/**
|
|
9018
|
-
* @description HTTP error response representation with security-conscious design.
|
|
9019
|
-
*
|
|
9020
|
-
* This struct contains all the information needed to serialize an error
|
|
9021
|
-
* response, including the error name, message, HTTP status code, resource
|
|
9022
|
-
* information, and user-friendly messages.
|
|
9023
|
-
*/
|
|
9659
|
+
/** @description Failed to parse the request body as JSON */
|
|
9024
9660
|
400: {
|
|
9025
9661
|
headers: {
|
|
9026
9662
|
[name: string]: unknown;
|
|
9027
9663
|
};
|
|
9028
9664
|
content: {
|
|
9029
|
-
"
|
|
9665
|
+
"text/plain": string;
|
|
9030
9666
|
};
|
|
9031
9667
|
};
|
|
9032
9668
|
/**
|
|
@@ -9094,56 +9730,54 @@ interface paths {
|
|
|
9094
9730
|
};
|
|
9095
9731
|
};
|
|
9096
9732
|
};
|
|
9733
|
+
delete?: never;
|
|
9734
|
+
options?: never;
|
|
9735
|
+
head?: never;
|
|
9736
|
+
patch?: never;
|
|
9097
9737
|
trace?: never;
|
|
9098
9738
|
};
|
|
9099
|
-
"/
|
|
9739
|
+
"/auth/{provider}/reauth/": {
|
|
9100
9740
|
parameters: {
|
|
9101
9741
|
query?: never;
|
|
9102
9742
|
header?: never;
|
|
9103
9743
|
path?: never;
|
|
9104
9744
|
cookie?: never;
|
|
9105
9745
|
};
|
|
9106
|
-
get?: never;
|
|
9107
|
-
put?: never;
|
|
9108
9746
|
/**
|
|
9109
|
-
*
|
|
9110
|
-
* @description
|
|
9747
|
+
* Start OIDC step-up re-authentication
|
|
9748
|
+
* @description Begins a step-up re-authentication with a provider already linked to the authenticated account, and returns the provider authorize URL. On consent, the callback mints a short-lived, single-use proof required to add a credential (set a first password, or link a new provider).
|
|
9111
9749
|
*/
|
|
9112
|
-
|
|
9750
|
+
get: {
|
|
9113
9751
|
parameters: {
|
|
9114
|
-
query?:
|
|
9752
|
+
query?: {
|
|
9753
|
+
/**
|
|
9754
|
+
* @description A step-up re-authentication proof. Required to start a *link* (adding a
|
|
9755
|
+
* provider is a credential-adding action, so a live session alone is not
|
|
9756
|
+
* enough); ignored for sign-in and reauth.
|
|
9757
|
+
*/
|
|
9758
|
+
reauthProof?: string;
|
|
9759
|
+
/**
|
|
9760
|
+
* @description Frontend URL to return to once done. Carried through the flow and used to
|
|
9761
|
+
* build the callback's redirect.
|
|
9762
|
+
*/
|
|
9763
|
+
redirectUri?: string;
|
|
9764
|
+
};
|
|
9115
9765
|
header?: never;
|
|
9116
9766
|
path: {
|
|
9117
|
-
/** @description
|
|
9118
|
-
|
|
9119
|
-
/** @description Opaque identifier of the webhook. */
|
|
9120
|
-
webhookId: components["schemas"]["WebhookId"];
|
|
9767
|
+
/** @description The identity provider to act on. */
|
|
9768
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
9121
9769
|
};
|
|
9122
9770
|
cookie?: never;
|
|
9123
9771
|
};
|
|
9124
|
-
|
|
9125
|
-
requestBody: {
|
|
9126
|
-
content: {
|
|
9127
|
-
"application/json": components["schemas"]["TestWebhook"];
|
|
9128
|
-
};
|
|
9129
|
-
};
|
|
9772
|
+
requestBody?: never;
|
|
9130
9773
|
responses: {
|
|
9131
|
-
/** @description
|
|
9774
|
+
/** @description The response to a successful sign-in start: where to send the user. */
|
|
9132
9775
|
200: {
|
|
9133
9776
|
headers: {
|
|
9134
9777
|
[name: string]: unknown;
|
|
9135
9778
|
};
|
|
9136
9779
|
content: {
|
|
9137
|
-
"application/json": components["schemas"]["
|
|
9138
|
-
};
|
|
9139
|
-
};
|
|
9140
|
-
/** @description Failed to parse the request body as JSON */
|
|
9141
|
-
400: {
|
|
9142
|
-
headers: {
|
|
9143
|
-
[name: string]: unknown;
|
|
9144
|
-
};
|
|
9145
|
-
content: {
|
|
9146
|
-
"text/plain": string;
|
|
9780
|
+
"application/json": components["schemas"]["OidcStartResponse"];
|
|
9147
9781
|
};
|
|
9148
9782
|
};
|
|
9149
9783
|
/**
|
|
@@ -9168,7 +9802,7 @@ interface paths {
|
|
|
9168
9802
|
* response, including the error name, message, HTTP status code, resource
|
|
9169
9803
|
* information, and user-friendly messages.
|
|
9170
9804
|
*/
|
|
9171
|
-
|
|
9805
|
+
404: {
|
|
9172
9806
|
headers: {
|
|
9173
9807
|
[name: string]: unknown;
|
|
9174
9808
|
};
|
|
@@ -9183,7 +9817,7 @@ interface paths {
|
|
|
9183
9817
|
* response, including the error name, message, HTTP status code, resource
|
|
9184
9818
|
* information, and user-friendly messages.
|
|
9185
9819
|
*/
|
|
9186
|
-
|
|
9820
|
+
503: {
|
|
9187
9821
|
headers: {
|
|
9188
9822
|
[name: string]: unknown;
|
|
9189
9823
|
};
|
|
@@ -9191,26 +9825,10 @@ interface paths {
|
|
|
9191
9825
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
9192
9826
|
};
|
|
9193
9827
|
};
|
|
9194
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
9195
|
-
415: {
|
|
9196
|
-
headers: {
|
|
9197
|
-
[name: string]: unknown;
|
|
9198
|
-
};
|
|
9199
|
-
content: {
|
|
9200
|
-
"text/plain": string;
|
|
9201
|
-
};
|
|
9202
|
-
};
|
|
9203
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
9204
|
-
422: {
|
|
9205
|
-
headers: {
|
|
9206
|
-
[name: string]: unknown;
|
|
9207
|
-
};
|
|
9208
|
-
content: {
|
|
9209
|
-
"text/plain": string;
|
|
9210
|
-
};
|
|
9211
|
-
};
|
|
9212
9828
|
};
|
|
9213
9829
|
};
|
|
9830
|
+
put?: never;
|
|
9831
|
+
post?: never;
|
|
9214
9832
|
delete?: never;
|
|
9215
9833
|
options?: never;
|
|
9216
9834
|
head?: never;
|
|
@@ -9228,7 +9846,7 @@ interface paths {
|
|
|
9228
9846
|
put?: never;
|
|
9229
9847
|
/**
|
|
9230
9848
|
* Login
|
|
9231
|
-
* @description Authenticates a user and
|
|
9849
|
+
* @description Authenticates a user and starts a browser session: sets an HttpOnly session cookie and a CSRF cookie, returning no body. (Programmatic clients authenticate with an API token created via the tokens endpoint, not this one.)
|
|
9232
9850
|
*/
|
|
9233
9851
|
post: {
|
|
9234
9852
|
parameters: {
|
|
@@ -9244,14 +9862,12 @@ interface paths {
|
|
|
9244
9862
|
};
|
|
9245
9863
|
};
|
|
9246
9864
|
responses: {
|
|
9247
|
-
/** @description
|
|
9248
|
-
|
|
9865
|
+
/** @description no content */
|
|
9866
|
+
204: {
|
|
9249
9867
|
headers: {
|
|
9250
9868
|
[name: string]: unknown;
|
|
9251
9869
|
};
|
|
9252
|
-
content
|
|
9253
|
-
"application/json": components["schemas"]["AuthToken"];
|
|
9254
|
-
};
|
|
9870
|
+
content?: never;
|
|
9255
9871
|
};
|
|
9256
9872
|
/**
|
|
9257
9873
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -9320,7 +9936,7 @@ interface paths {
|
|
|
9320
9936
|
put?: never;
|
|
9321
9937
|
/**
|
|
9322
9938
|
* Signup
|
|
9323
|
-
* @description Creates a new account and
|
|
9939
|
+
* @description Creates a new account and starts a browser session: sets an HttpOnly session cookie and a CSRF cookie, returning no body.
|
|
9324
9940
|
*/
|
|
9325
9941
|
post: {
|
|
9326
9942
|
parameters: {
|
|
@@ -9336,14 +9952,12 @@ interface paths {
|
|
|
9336
9952
|
};
|
|
9337
9953
|
};
|
|
9338
9954
|
responses: {
|
|
9339
|
-
/** @description
|
|
9340
|
-
|
|
9955
|
+
/** @description no content */
|
|
9956
|
+
204: {
|
|
9341
9957
|
headers: {
|
|
9342
9958
|
[name: string]: unknown;
|
|
9343
9959
|
};
|
|
9344
|
-
content
|
|
9345
|
-
"application/json": components["schemas"]["AuthToken"];
|
|
9346
|
-
};
|
|
9960
|
+
content?: never;
|
|
9347
9961
|
};
|
|
9348
9962
|
/**
|
|
9349
9963
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -9412,7 +10026,7 @@ interface paths {
|
|
|
9412
10026
|
put?: never;
|
|
9413
10027
|
/**
|
|
9414
10028
|
* Logout
|
|
9415
|
-
* @description Invalidates the current
|
|
10029
|
+
* @description Invalidates the current session and clears session cookies.
|
|
9416
10030
|
*/
|
|
9417
10031
|
post: {
|
|
9418
10032
|
parameters: {
|
|
@@ -9453,6 +10067,90 @@ interface paths {
|
|
|
9453
10067
|
patch?: never;
|
|
9454
10068
|
trace?: never;
|
|
9455
10069
|
};
|
|
10070
|
+
"/auth/{provider}/start/": {
|
|
10071
|
+
parameters: {
|
|
10072
|
+
query?: never;
|
|
10073
|
+
header?: never;
|
|
10074
|
+
path?: never;
|
|
10075
|
+
cookie?: never;
|
|
10076
|
+
};
|
|
10077
|
+
/**
|
|
10078
|
+
* Start OIDC sign-in
|
|
10079
|
+
* @description Begins an OpenID Connect sign-in with the given provider and returns the provider authorize URL to redirect the user to. On consent, the provider redirects to the callback, which signs the user in.
|
|
10080
|
+
*/
|
|
10081
|
+
get: {
|
|
10082
|
+
parameters: {
|
|
10083
|
+
query?: {
|
|
10084
|
+
/**
|
|
10085
|
+
* @description A step-up re-authentication proof. Required to start a *link* (adding a
|
|
10086
|
+
* provider is a credential-adding action, so a live session alone is not
|
|
10087
|
+
* enough); ignored for sign-in and reauth.
|
|
10088
|
+
*/
|
|
10089
|
+
reauthProof?: string;
|
|
10090
|
+
/**
|
|
10091
|
+
* @description Frontend URL to return to once done. Carried through the flow and used to
|
|
10092
|
+
* build the callback's redirect.
|
|
10093
|
+
*/
|
|
10094
|
+
redirectUri?: string;
|
|
10095
|
+
};
|
|
10096
|
+
header?: never;
|
|
10097
|
+
path: {
|
|
10098
|
+
/** @description The identity provider to act on. */
|
|
10099
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
10100
|
+
};
|
|
10101
|
+
cookie?: never;
|
|
10102
|
+
};
|
|
10103
|
+
requestBody?: never;
|
|
10104
|
+
responses: {
|
|
10105
|
+
/** @description The response to a successful sign-in start: where to send the user. */
|
|
10106
|
+
200: {
|
|
10107
|
+
headers: {
|
|
10108
|
+
[name: string]: unknown;
|
|
10109
|
+
};
|
|
10110
|
+
content: {
|
|
10111
|
+
"application/json": components["schemas"]["OidcStartResponse"];
|
|
10112
|
+
};
|
|
10113
|
+
};
|
|
10114
|
+
/**
|
|
10115
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10116
|
+
*
|
|
10117
|
+
* This struct contains all the information needed to serialize an error
|
|
10118
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10119
|
+
* information, and user-friendly messages.
|
|
10120
|
+
*/
|
|
10121
|
+
404: {
|
|
10122
|
+
headers: {
|
|
10123
|
+
[name: string]: unknown;
|
|
10124
|
+
};
|
|
10125
|
+
content: {
|
|
10126
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10127
|
+
};
|
|
10128
|
+
};
|
|
10129
|
+
/**
|
|
10130
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10131
|
+
*
|
|
10132
|
+
* This struct contains all the information needed to serialize an error
|
|
10133
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10134
|
+
* information, and user-friendly messages.
|
|
10135
|
+
*/
|
|
10136
|
+
503: {
|
|
10137
|
+
headers: {
|
|
10138
|
+
[name: string]: unknown;
|
|
10139
|
+
};
|
|
10140
|
+
content: {
|
|
10141
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10142
|
+
};
|
|
10143
|
+
};
|
|
10144
|
+
};
|
|
10145
|
+
};
|
|
10146
|
+
put?: never;
|
|
10147
|
+
post?: never;
|
|
10148
|
+
delete?: never;
|
|
10149
|
+
options?: never;
|
|
10150
|
+
head?: never;
|
|
10151
|
+
patch?: never;
|
|
10152
|
+
trace?: never;
|
|
10153
|
+
};
|
|
9456
10154
|
"/health/": {
|
|
9457
10155
|
parameters: {
|
|
9458
10156
|
query?: never;
|
|
@@ -9634,6 +10332,33 @@ interface components {
|
|
|
9634
10332
|
/** @description Public handle of the account. */
|
|
9635
10333
|
username: components["schemas"]["Handle"];
|
|
9636
10334
|
};
|
|
10335
|
+
/** @description The account's sign-in methods. */
|
|
10336
|
+
AccountIdentities: {
|
|
10337
|
+
/** @description Every identity the account can sign in with. */
|
|
10338
|
+
identities: components["schemas"]["AccountIdentity"][];
|
|
10339
|
+
};
|
|
10340
|
+
/**
|
|
10341
|
+
* @description One of an account's sign-in methods, for the identities listing.
|
|
10342
|
+
*
|
|
10343
|
+
* Never exposes the credential itself (a password hash or a provider subject),
|
|
10344
|
+
* only which methods exist and metadata about them.
|
|
10345
|
+
*/
|
|
10346
|
+
AccountIdentity: {
|
|
10347
|
+
/**
|
|
10348
|
+
* Format: date-time
|
|
10349
|
+
* @description When the identity was created (the password set, or the provider linked).
|
|
10350
|
+
*/
|
|
10351
|
+
createdAt: string;
|
|
10352
|
+
/** @description The authentication method: `password` or an OIDC provider. */
|
|
10353
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
10354
|
+
/** @description The email the provider asserted at link time, for a linked provider. */
|
|
10355
|
+
providerEmail?: string;
|
|
10356
|
+
/**
|
|
10357
|
+
* Format: date-time
|
|
10358
|
+
* @description When the identity was last updated.
|
|
10359
|
+
*/
|
|
10360
|
+
updatedAt: string;
|
|
10361
|
+
};
|
|
9637
10362
|
/**
|
|
9638
10363
|
* @description Path parameters for account operations.
|
|
9639
10364
|
*
|
|
@@ -10044,15 +10769,20 @@ interface components {
|
|
|
10044
10769
|
* `word/document.xml` text belongs to the document part
|
|
10045
10770
|
* itself, not to a nested one.
|
|
10046
10771
|
*
|
|
10047
|
-
*
|
|
10048
|
-
*
|
|
10049
|
-
*
|
|
10050
|
-
*
|
|
10051
|
-
* reverse-resolves.
|
|
10052
|
-
*
|
|
10772
|
+
* Text carries either coordinate kind of [`TextCoord`]: a
|
|
10773
|
+
* [`Decoded`] span for a caller with an offset into the
|
|
10774
|
+
* decoded stream, or a [`Source`] one for a caller holding
|
|
10775
|
+
* only raw file bytes — a reviewer selecting rendered text,
|
|
10776
|
+
* say — which the engine reverse-resolves. Source-only is its
|
|
10777
|
+
* own kind rather than a decoded span left empty, so such a
|
|
10778
|
+
* selection is representable as itself.
|
|
10779
|
+
*
|
|
10780
|
+
* The other three media have no such alternative: their
|
|
10781
|
+
* coordinates are the only way in.
|
|
10053
10782
|
*
|
|
10054
|
-
* [`
|
|
10055
|
-
* [`
|
|
10783
|
+
* [`TextCoord`]: elide::modality::text::TextCoord
|
|
10784
|
+
* [`Decoded`]: elide::modality::text::TextCoord::Decoded
|
|
10785
|
+
* [`Source`]: elide::modality::text::TextCoord::Source
|
|
10056
10786
|
*/
|
|
10057
10787
|
location: components["schemas"]["AudioLocation"];
|
|
10058
10788
|
/**
|
|
@@ -10064,9 +10794,9 @@ interface components {
|
|
|
10064
10794
|
*
|
|
10065
10795
|
* Nested media needs this: the report holds an embedded image
|
|
10066
10796
|
* as its own part, and an addition to one has nowhere to go
|
|
10067
|
-
* without naming it. Text usually does not —
|
|
10068
|
-
*
|
|
10069
|
-
*
|
|
10797
|
+
* without naming it. Text usually does not — a source
|
|
10798
|
+
* reference already names the part it came from, alongside the
|
|
10799
|
+
* raw range.
|
|
10070
10800
|
*
|
|
10071
10801
|
* `None` is an error when the request carried several
|
|
10072
10802
|
* documents, since there is then no sole document to mean.
|
|
@@ -10631,23 +11361,6 @@ interface components {
|
|
|
10631
11361
|
* [`AuditEvent`]: crate::entity::audit::AuditEvent
|
|
10632
11362
|
*/
|
|
10633
11363
|
AuditHash: string;
|
|
10634
|
-
/** @description Response returned after successful authentication (login/signup). */
|
|
10635
|
-
AuthToken: {
|
|
10636
|
-
/** @description The JWT API token for authentication. */
|
|
10637
|
-
apiToken: string;
|
|
10638
|
-
/**
|
|
10639
|
-
* Format: date-time
|
|
10640
|
-
* @description Timestamp when the token expires.
|
|
10641
|
-
*/
|
|
10642
|
-
expiresAt: string;
|
|
10643
|
-
/**
|
|
10644
|
-
* Format: date-time
|
|
10645
|
-
* @description Timestamp when the token was issued.
|
|
10646
|
-
*/
|
|
10647
|
-
issuedAt: string;
|
|
10648
|
-
/** @description Handle of the authenticated account. */
|
|
10649
|
-
username: components["schemas"]["Handle"];
|
|
10650
|
-
};
|
|
10651
11364
|
/**
|
|
10652
11365
|
* @description Configuration for a provider reached with an API key (OpenAI, Anthropic).
|
|
10653
11366
|
*
|
|
@@ -11380,6 +12093,48 @@ interface components {
|
|
|
11380
12093
|
*/
|
|
11381
12094
|
limit?: number;
|
|
11382
12095
|
};
|
|
12096
|
+
/**
|
|
12097
|
+
* @description How to detect one caller-authored label.
|
|
12098
|
+
*
|
|
12099
|
+
* Names a label the same policy declares in [`custom`]. A matcher
|
|
12100
|
+
* for a shipped built-in is rejected: elide already detects those,
|
|
12101
|
+
* and two definitions for one label would race in reconciliation.
|
|
12102
|
+
*
|
|
12103
|
+
* [`custom`]: super::PolicyDefinition::custom
|
|
12104
|
+
*/
|
|
12105
|
+
CustomMatcher: {
|
|
12106
|
+
/**
|
|
12107
|
+
* Format: float
|
|
12108
|
+
* @description Score stamped on every match. Defaults to `0.6`.
|
|
12109
|
+
*
|
|
12110
|
+
* Reconciliation keeps the higher-confidence entity when two
|
|
12111
|
+
* detections overlap, so this is what decides whether a
|
|
12112
|
+
* custom match beats a built-in one covering the same span.
|
|
12113
|
+
* @default 0.6000000238418579
|
|
12114
|
+
*/
|
|
12115
|
+
confidence?: number;
|
|
12116
|
+
/**
|
|
12117
|
+
* @description The label this detects, which the policy must declare in
|
|
12118
|
+
* [`custom`](super::PolicyDefinition::custom).
|
|
12119
|
+
*/
|
|
12120
|
+
label: components["schemas"]["LabelRef"];
|
|
12121
|
+
/**
|
|
12122
|
+
* @description Human-readable name, recorded in the audit as the
|
|
12123
|
+
* recognizer that found the entity, so a trail distinguishes
|
|
12124
|
+
* a caller's matcher from a shipped pattern.
|
|
12125
|
+
*/
|
|
12126
|
+
name: string;
|
|
12127
|
+
} & ({
|
|
12128
|
+
/** @constant */
|
|
12129
|
+
kind: "pattern";
|
|
12130
|
+
/** @description The expression, in `regex` crate syntax. */
|
|
12131
|
+
pattern: string;
|
|
12132
|
+
} | {
|
|
12133
|
+
/** @constant */
|
|
12134
|
+
kind: "terms";
|
|
12135
|
+
/** @description The literals to scan for. */
|
|
12136
|
+
terms: string[];
|
|
12137
|
+
});
|
|
11383
12138
|
/**
|
|
11384
12139
|
* @description The coarseness a [`GeneralizeDate`] reduces a date/timestamp to.
|
|
11385
12140
|
*
|
|
@@ -12111,6 +12866,26 @@ interface components {
|
|
|
12111
12866
|
* as de-identified.
|
|
12112
12867
|
*/
|
|
12113
12868
|
HipaaDeidMethod: "safe_harbor" | "limited_data_set" | "expert_determination";
|
|
12869
|
+
/**
|
|
12870
|
+
* @description Path parameters for a provider-scoped identity operation: signing in with,
|
|
12871
|
+
* re-authenticating with, linking, or unlinking a provider. Named identically to
|
|
12872
|
+
* the stored [`IdentityProvider`], so the API and the account's identities name
|
|
12873
|
+
* each provider the same way.
|
|
12874
|
+
*/
|
|
12875
|
+
IdentityPathParams: {
|
|
12876
|
+
/** @description The identity provider to act on. */
|
|
12877
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
12878
|
+
};
|
|
12879
|
+
/**
|
|
12880
|
+
* @description How an account authenticates.
|
|
12881
|
+
*
|
|
12882
|
+
* Corresponds to the `IDENTITY_PROVIDER` PostgreSQL enum. [`Password`] is a
|
|
12883
|
+
* locally-held Argon2 secret; the rest are external OIDC providers keyed by the
|
|
12884
|
+
* provider's subject claim.
|
|
12885
|
+
*
|
|
12886
|
+
* [`Password`]: Self::Password
|
|
12887
|
+
*/
|
|
12888
|
+
IdentityProvider: "password" | "google" | "microsoft";
|
|
12114
12889
|
/**
|
|
12115
12890
|
* @description A detection recognition missed.
|
|
12116
12891
|
*
|
|
@@ -12137,15 +12912,20 @@ interface components {
|
|
|
12137
12912
|
* `word/document.xml` text belongs to the document part
|
|
12138
12913
|
* itself, not to a nested one.
|
|
12139
12914
|
*
|
|
12140
|
-
*
|
|
12141
|
-
*
|
|
12142
|
-
*
|
|
12143
|
-
*
|
|
12144
|
-
* reverse-resolves.
|
|
12145
|
-
*
|
|
12915
|
+
* Text carries either coordinate kind of [`TextCoord`]: a
|
|
12916
|
+
* [`Decoded`] span for a caller with an offset into the
|
|
12917
|
+
* decoded stream, or a [`Source`] one for a caller holding
|
|
12918
|
+
* only raw file bytes — a reviewer selecting rendered text,
|
|
12919
|
+
* say — which the engine reverse-resolves. Source-only is its
|
|
12920
|
+
* own kind rather than a decoded span left empty, so such a
|
|
12921
|
+
* selection is representable as itself.
|
|
12922
|
+
*
|
|
12923
|
+
* The other three media have no such alternative: their
|
|
12924
|
+
* coordinates are the only way in.
|
|
12146
12925
|
*
|
|
12147
|
-
* [`
|
|
12148
|
-
* [`
|
|
12926
|
+
* [`TextCoord`]: elide::modality::text::TextCoord
|
|
12927
|
+
* [`Decoded`]: elide::modality::text::TextCoord::Decoded
|
|
12928
|
+
* [`Source`]: elide::modality::text::TextCoord::Source
|
|
12149
12929
|
*/
|
|
12150
12930
|
location: components["schemas"]["ImageLocation"];
|
|
12151
12931
|
/**
|
|
@@ -12157,9 +12937,9 @@ interface components {
|
|
|
12157
12937
|
*
|
|
12158
12938
|
* Nested media needs this: the report holds an embedded image
|
|
12159
12939
|
* as its own part, and an addition to one has nowhere to go
|
|
12160
|
-
* without naming it. Text usually does not —
|
|
12161
|
-
*
|
|
12162
|
-
*
|
|
12940
|
+
* without naming it. Text usually does not — a source
|
|
12941
|
+
* reference already names the part it came from, alongside the
|
|
12942
|
+
* raw range.
|
|
12163
12943
|
*
|
|
12164
12944
|
* `None` is an error when the request carried several
|
|
12165
12945
|
* documents, since there is then no sole document to mean.
|
|
@@ -13468,6 +14248,25 @@ interface components {
|
|
|
13468
14248
|
*/
|
|
13469
14249
|
refresh_token?: string;
|
|
13470
14250
|
};
|
|
14251
|
+
/** @description Optional query parameters for starting a sign-in, link, or reauth. */
|
|
14252
|
+
OidcStartQuery: {
|
|
14253
|
+
/**
|
|
14254
|
+
* @description A step-up re-authentication proof. Required to start a *link* (adding a
|
|
14255
|
+
* provider is a credential-adding action, so a live session alone is not
|
|
14256
|
+
* enough); ignored for sign-in and reauth.
|
|
14257
|
+
*/
|
|
14258
|
+
reauthProof?: string;
|
|
14259
|
+
/**
|
|
14260
|
+
* @description Frontend URL to return to once done. Carried through the flow and used to
|
|
14261
|
+
* build the callback's redirect.
|
|
14262
|
+
*/
|
|
14263
|
+
redirectUri?: string;
|
|
14264
|
+
};
|
|
14265
|
+
/** @description The response to a successful sign-in start: where to send the user. */
|
|
14266
|
+
OidcStartResponse: {
|
|
14267
|
+
/** @description The provider authorize URL the client should redirect the user to. */
|
|
14268
|
+
authorizeUrl: string;
|
|
14269
|
+
};
|
|
13471
14270
|
/**
|
|
13472
14271
|
* @description Identifies a redaction operator, for the redaction audit a higher
|
|
13473
14272
|
* layer assembles.
|
|
@@ -13484,20 +14283,6 @@ interface components {
|
|
|
13484
14283
|
/** @description Operator's version at the time it was applied. */
|
|
13485
14284
|
version: string;
|
|
13486
14285
|
};
|
|
13487
|
-
/**
|
|
13488
|
-
* @description A re-authenticated password change: the new password plus the current one
|
|
13489
|
-
* that authorizes it.
|
|
13490
|
-
*
|
|
13491
|
-
* Coupling the two in one struct makes the invariant explicit — a password
|
|
13492
|
-
* change always carries the current password, so a hijacked session or CSRF
|
|
13493
|
-
* cannot silently reset it (and lock out the real owner).
|
|
13494
|
-
*/
|
|
13495
|
-
PasswordChange: {
|
|
13496
|
-
/** @description The account's current password, verified before the change is applied. */
|
|
13497
|
-
currentPassword: string;
|
|
13498
|
-
/** @description The new password (will be hashed before storage). */
|
|
13499
|
-
newPassword: string;
|
|
13500
|
-
};
|
|
13501
14286
|
/** @description Metadata of a pattern/dictionary recognition, carried by [`Pattern`]. */
|
|
13502
14287
|
PatternEvent: {
|
|
13503
14288
|
/**
|
|
@@ -13567,6 +14352,24 @@ interface components {
|
|
|
13567
14352
|
/** @description The file's display name, as the picker reported it. */
|
|
13568
14353
|
name: string;
|
|
13569
14354
|
};
|
|
14355
|
+
/**
|
|
14356
|
+
* @description A short-lived provider OAuth access token for a browser file picker.
|
|
14357
|
+
*
|
|
14358
|
+
* Carries only the access token and its expiry — never the refresh token, which
|
|
14359
|
+
* stays server-side. The token is minted from the connection's stored
|
|
14360
|
+
* credentials and is short-lived (the provider's access-token lifetime), so the
|
|
14361
|
+
* browser holds a narrow, expiring credential rather than a durable one.
|
|
14362
|
+
*/
|
|
14363
|
+
PickerToken: {
|
|
14364
|
+
/** @description The provider OAuth access token to hand to the browser picker. */
|
|
14365
|
+
accessToken: string;
|
|
14366
|
+
/**
|
|
14367
|
+
* Format: int64
|
|
14368
|
+
* @description Unix seconds at which the access token expires, if the provider reports
|
|
14369
|
+
* it. `None` means the provider did not return an expiry.
|
|
14370
|
+
*/
|
|
14371
|
+
expiresAt?: number;
|
|
14372
|
+
};
|
|
13570
14373
|
/** @description Pipeline response. */
|
|
13571
14374
|
Pipeline: {
|
|
13572
14375
|
/**
|
|
@@ -13814,6 +14617,21 @@ interface components {
|
|
|
13814
14617
|
* customer-supplied so re-submissions carry the same id.
|
|
13815
14618
|
*/
|
|
13816
14619
|
id: string;
|
|
14620
|
+
/**
|
|
14621
|
+
* @description How to detect the labels [`custom`] introduces.
|
|
14622
|
+
*
|
|
14623
|
+
* A custom label declares vocabulary and nothing more, so
|
|
14624
|
+
* without a matcher it is scoped, targeted by rules, and never
|
|
14625
|
+
* found. Each matcher names a label this policy declares;
|
|
14626
|
+
* naming a shipped built-in is rejected, since elide already
|
|
14627
|
+
* detects those.
|
|
14628
|
+
*
|
|
14629
|
+
* Compiled per request, so a policy declaring none costs
|
|
14630
|
+
* nothing.
|
|
14631
|
+
*
|
|
14632
|
+
* [`custom`]: Self::custom
|
|
14633
|
+
*/
|
|
14634
|
+
matchers?: components["schemas"]["CustomMatcher"][];
|
|
13817
14635
|
/**
|
|
13818
14636
|
* @description Human-readable name. Display-only. Does not key anything.
|
|
13819
14637
|
*
|
|
@@ -13873,6 +14691,11 @@ interface components {
|
|
|
13873
14691
|
description?: string;
|
|
13874
14692
|
/** @description Per-policy catch-all, fired when no rule matched. */
|
|
13875
14693
|
fallback?: components["schemas"]["ModalityRedactions"];
|
|
14694
|
+
/**
|
|
14695
|
+
* @description How to detect the custom labels this policy introduces. A custom label
|
|
14696
|
+
* without a matcher is declared but never found.
|
|
14697
|
+
*/
|
|
14698
|
+
matchers?: components["schemas"]["CustomMatcher"][];
|
|
13876
14699
|
/** @description Human-readable name. Display-only. */
|
|
13877
14700
|
name: string;
|
|
13878
14701
|
/** @description Ordered rules. First match wins within this policy. */
|
|
@@ -14647,6 +15470,32 @@ interface components {
|
|
|
14647
15470
|
*/
|
|
14648
15471
|
parentId?: string;
|
|
14649
15472
|
};
|
|
15473
|
+
/**
|
|
15474
|
+
* @description A password set or change.
|
|
15475
|
+
*
|
|
15476
|
+
* When the account already has a password, `current_password` is required and
|
|
15477
|
+
* verified before the change is applied, so a hijacked session or CSRF cannot
|
|
15478
|
+
* silently reset it (and lock out the real owner). When the account has no
|
|
15479
|
+
* password yet (an SSO-only account setting its first one), there is nothing to
|
|
15480
|
+
* re-authenticate against, so a fresh step-up `reauth_proof` is required instead
|
|
15481
|
+
* — a live session alone must not mint a durable new credential.
|
|
15482
|
+
*/
|
|
15483
|
+
SetPassword: {
|
|
15484
|
+
/**
|
|
15485
|
+
* @description The account's current password. Required when the account already has a
|
|
15486
|
+
* password; omitted when setting a first password on an account that has
|
|
15487
|
+
* none (supply `reauth_proof` instead).
|
|
15488
|
+
*/
|
|
15489
|
+
currentPassword?: string;
|
|
15490
|
+
/** @description The new password (will be hashed before storage). */
|
|
15491
|
+
newPassword: string;
|
|
15492
|
+
/**
|
|
15493
|
+
* @description A step-up re-authentication proof (from the OIDC reauth endpoint).
|
|
15494
|
+
* Required when *setting a first password* on an account that has none;
|
|
15495
|
+
* ignored when changing an existing password.
|
|
15496
|
+
*/
|
|
15497
|
+
reauthProof?: string;
|
|
15498
|
+
};
|
|
14650
15499
|
/**
|
|
14651
15500
|
* @description Which SHA-2 variant a hashing operator uses.
|
|
14652
15501
|
*
|
|
@@ -14909,15 +15758,20 @@ interface components {
|
|
|
14909
15758
|
* `word/document.xml` text belongs to the document part
|
|
14910
15759
|
* itself, not to a nested one.
|
|
14911
15760
|
*
|
|
14912
|
-
*
|
|
14913
|
-
*
|
|
14914
|
-
*
|
|
14915
|
-
*
|
|
14916
|
-
* reverse-resolves.
|
|
14917
|
-
*
|
|
15761
|
+
* Text carries either coordinate kind of [`TextCoord`]: a
|
|
15762
|
+
* [`Decoded`] span for a caller with an offset into the
|
|
15763
|
+
* decoded stream, or a [`Source`] one for a caller holding
|
|
15764
|
+
* only raw file bytes — a reviewer selecting rendered text,
|
|
15765
|
+
* say — which the engine reverse-resolves. Source-only is its
|
|
15766
|
+
* own kind rather than a decoded span left empty, so such a
|
|
15767
|
+
* selection is representable as itself.
|
|
15768
|
+
*
|
|
15769
|
+
* The other three media have no such alternative: their
|
|
15770
|
+
* coordinates are the only way in.
|
|
14918
15771
|
*
|
|
14919
|
-
* [`
|
|
14920
|
-
* [`
|
|
15772
|
+
* [`TextCoord`]: elide::modality::text::TextCoord
|
|
15773
|
+
* [`Decoded`]: elide::modality::text::TextCoord::Decoded
|
|
15774
|
+
* [`Source`]: elide::modality::text::TextCoord::Source
|
|
14921
15775
|
*/
|
|
14922
15776
|
location: components["schemas"]["TabularLocation"];
|
|
14923
15777
|
/**
|
|
@@ -14929,9 +15783,9 @@ interface components {
|
|
|
14929
15783
|
*
|
|
14930
15784
|
* Nested media needs this: the report holds an embedded image
|
|
14931
15785
|
* as its own part, and an addition to one has nowhere to go
|
|
14932
|
-
* without naming it. Text usually does not —
|
|
14933
|
-
*
|
|
14934
|
-
*
|
|
15786
|
+
* without naming it. Text usually does not — a source
|
|
15787
|
+
* reference already names the part it came from, alongside the
|
|
15788
|
+
* raw range.
|
|
14935
15789
|
*
|
|
14936
15790
|
* `None` is an error when the request carried several
|
|
14937
15791
|
* documents, since there is then no sole document to mean.
|
|
@@ -15514,15 +16368,20 @@ interface components {
|
|
|
15514
16368
|
* `word/document.xml` text belongs to the document part
|
|
15515
16369
|
* itself, not to a nested one.
|
|
15516
16370
|
*
|
|
15517
|
-
*
|
|
15518
|
-
*
|
|
15519
|
-
*
|
|
15520
|
-
*
|
|
15521
|
-
* reverse-resolves.
|
|
15522
|
-
*
|
|
16371
|
+
* Text carries either coordinate kind of [`TextCoord`]: a
|
|
16372
|
+
* [`Decoded`] span for a caller with an offset into the
|
|
16373
|
+
* decoded stream, or a [`Source`] one for a caller holding
|
|
16374
|
+
* only raw file bytes — a reviewer selecting rendered text,
|
|
16375
|
+
* say — which the engine reverse-resolves. Source-only is its
|
|
16376
|
+
* own kind rather than a decoded span left empty, so such a
|
|
16377
|
+
* selection is representable as itself.
|
|
15523
16378
|
*
|
|
15524
|
-
*
|
|
15525
|
-
*
|
|
16379
|
+
* The other three media have no such alternative: their
|
|
16380
|
+
* coordinates are the only way in.
|
|
16381
|
+
*
|
|
16382
|
+
* [`TextCoord`]: elide::modality::text::TextCoord
|
|
16383
|
+
* [`Decoded`]: elide::modality::text::TextCoord::Decoded
|
|
16384
|
+
* [`Source`]: elide::modality::text::TextCoord::Source
|
|
15526
16385
|
*/
|
|
15527
16386
|
location: components["schemas"]["TextLocation"];
|
|
15528
16387
|
/**
|
|
@@ -15534,9 +16393,9 @@ interface components {
|
|
|
15534
16393
|
*
|
|
15535
16394
|
* Nested media needs this: the report holds an embedded image
|
|
15536
16395
|
* as its own part, and an addition to one has nowhere to go
|
|
15537
|
-
* without naming it. Text usually does not —
|
|
15538
|
-
*
|
|
15539
|
-
*
|
|
16396
|
+
* without naming it. Text usually does not — a source
|
|
16397
|
+
* reference already names the part it came from, alongside the
|
|
16398
|
+
* raw range.
|
|
15540
16399
|
*
|
|
15541
16400
|
* `None` is an error when the request carried several
|
|
15542
16401
|
* documents, since there is then no sole document to mean.
|
|
@@ -16335,7 +17194,13 @@ interface components {
|
|
|
16335
17194
|
*/
|
|
16336
17195
|
unreadCount: number;
|
|
16337
17196
|
};
|
|
16338
|
-
/**
|
|
17197
|
+
/**
|
|
17198
|
+
* @description Request payload to update an account's profile.
|
|
17199
|
+
*
|
|
17200
|
+
* Credentials are not profile fields — a password and any linked providers are
|
|
17201
|
+
* managed through the account's identities (see the identity endpoints), never
|
|
17202
|
+
* here.
|
|
17203
|
+
*/
|
|
16339
17204
|
UpdateAccount: {
|
|
16340
17205
|
/** @description New display name (2-32 characters). */
|
|
16341
17206
|
displayName?: string;
|
|
@@ -16344,8 +17209,6 @@ interface components {
|
|
|
16344
17209
|
* @description New email address (must be valid email format).
|
|
16345
17210
|
*/
|
|
16346
17211
|
emailAddress?: string;
|
|
16347
|
-
/** @description A re-authenticated password change, when changing the password. */
|
|
16348
|
-
password?: components["schemas"]["PasswordChange"];
|
|
16349
17212
|
/** @description New account handle. */
|
|
16350
17213
|
username?: components["schemas"]["Handle"];
|
|
16351
17214
|
};
|
|
@@ -16883,8 +17746,12 @@ type Handle = Schemas$23["Handle"];
|
|
|
16883
17746
|
type Account = Schemas$23["Account"];
|
|
16884
17747
|
type PublicAccount = Schemas$23["PublicAccount"];
|
|
16885
17748
|
type UpdateAccount = Schemas$23["UpdateAccount"];
|
|
16886
|
-
type PasswordChange = Schemas$23["PasswordChange"];
|
|
16887
17749
|
type AccountRef = Schemas$23["AccountRef"];
|
|
17750
|
+
type AccountIdentities = Schemas$23["AccountIdentities"];
|
|
17751
|
+
type AccountIdentity = Schemas$23["AccountIdentity"];
|
|
17752
|
+
type IdentityProvider = Schemas$23["IdentityProvider"];
|
|
17753
|
+
type SetPassword = Schemas$23["SetPassword"];
|
|
17754
|
+
type OidcStartResponse = Schemas$23["OidcStartResponse"];
|
|
16888
17755
|
//#endregion
|
|
16889
17756
|
//#region src/datatypes/activity.d.ts
|
|
16890
17757
|
type Schemas$22 = components["schemas"];
|
|
@@ -17044,7 +17911,6 @@ type TabularRetag = Schemas$18["TabularRetag"];
|
|
|
17044
17911
|
type Schemas$17 = components["schemas"];
|
|
17045
17912
|
type Login = Schemas$17["Login"];
|
|
17046
17913
|
type Signup = Schemas$17["Signup"];
|
|
17047
|
-
type AuthToken = Schemas$17["AuthToken"];
|
|
17048
17914
|
//#endregion
|
|
17049
17915
|
//#region src/datatypes/catalog.d.ts
|
|
17050
17916
|
type Schemas$16 = components["schemas"];
|
|
@@ -17081,6 +17947,7 @@ type ConnectionVerification = Schemas$14["ConnectionVerification"];
|
|
|
17081
17947
|
type ImportFiles = Schemas$14["ImportFiles"];
|
|
17082
17948
|
type PickedFile = Schemas$14["PickedFile"];
|
|
17083
17949
|
type ExportFiles = Schemas$14["ExportFiles"];
|
|
17950
|
+
type PickerToken = Schemas$14["PickerToken"];
|
|
17084
17951
|
type SyncMode = Schemas$14["SyncMode"];
|
|
17085
17952
|
type SyncStatus = Schemas$14["SyncStatus"];
|
|
17086
17953
|
type SyncTriggerType = Schemas$14["SyncTriggerType"];
|
|
@@ -17216,6 +18083,7 @@ type PolicyDraft = Schemas$3["PolicyDraft"];
|
|
|
17216
18083
|
type CreatePolicy = Schemas$3["CreatePolicy"];
|
|
17217
18084
|
type UpdatePolicy = Schemas$3["UpdatePolicy"];
|
|
17218
18085
|
type PolicyRule = Schemas$3["PolicyRule"];
|
|
18086
|
+
type CustomMatcher = Schemas$3["CustomMatcher"];
|
|
17219
18087
|
type PolicyTemplate = Schemas$3["PolicyTemplate"];
|
|
17220
18088
|
type TemplateOrigin = Schemas$3["TemplateOrigin"];
|
|
17221
18089
|
type HipaaDeidMethod = Schemas$3["HipaaDeidMethod"];
|
|
@@ -17282,5 +18150,5 @@ type Retention = Schemas["Retention"];
|
|
|
17282
18150
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
17283
18151
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
17284
18152
|
//#endregion
|
|
17285
|
-
export {
|
|
17286
|
-
//# sourceMappingURL=index-
|
|
18153
|
+
export { PolicyDraft as $, WebhookActivityParams as $a, TextEntity as $i, Provider as $n, Dpi as $r, ListInvites as $t, Color as A, ProviderType as Aa, SourceRef as Ai, RedactionResult as An, AudioData as Ar, NotificationEvent as At, ImageRedaction as B, ActivityExportOptions as Ba, TabularLocation as Bi, ConnectionSyncPage as Bn, Audit as Br, MemberPage as Bt, Language as C, UpdateApiToken as Ca, Polygon as Ci, DetectionMetadata as Cn, Login as Cr, ConnectionSyncFailedParams as Ct, ScopeMetadata as D, DetectionTimeSeries as Da, Report as Di, PipelineDetectionsQuery as Dn, AudioAuditEvent as Dr, MemberInvitedParams as Dt, Languages as E, DetectionStatusEntry as Ea, Redaction as Ei, DetectionStatusEvent as En, AudioAdd as Er, MarkedReadStatus as Et, DateStyle as F, Usage as Fa, TabularAuditKind as Fi, Connection as Fn, AudioManual as Fr, UnreadCountEvent as Ft, LabelScope as G, ConnectionActivityParams as Ga, TabularRetag as Gi, FileServiceConfig as Gn, CitedAttribution as Gr, Invite as Gt, LabelEntry as H, ActivityPage as Ha, TabularModel as Hi, ConnectionsQuery as Hn, BoundingBox as Hr, UpdateMember as Ht, GdprArticle9Treatment as I, UsageAnalytics as Ia, TabularAuditLog as Ii, ConnectionConfig as In, AudioModel as Ir, UnreadStatus as It, ModalityRedactions as J, InviteActivityParams as Ja, TextAuditKind as Ji, LlmConfig as Jn, Contested as Jr, InvitePage as Jt, LanguageTag as K, DetectionActivityParams as Ka, TextAdd as Ki, GcsCredentials as Kn, CodecParams as Kr, InviteCode as Kt, GdprSensitiveScope as L, UsageReport as La, TabularEdit as Li, ConnectionId as Ln, AudioPattern as Lr, UpdateNotificationSettings as Lt, CreatePolicy as M, StorageAnalytics as Ma, Suppress as Mi, WorkspaceDetectionsQuery as Mn, AudioEntity as Mr, NotificationPayload as Mt, CustomMatcher as N, StorageKindEntry as Na, TabularAdd as Ni, AuthenticatedProvider as Nn, AudioHint as Nr, NotificationSettings as Nt, AudioRedaction as O, ModelUsage as Oa, RuleMatch as Oi, RedactDetection as On, AudioAuditKind as Or, MemberJoinedParams as Ot, DateGranularity as P, TokenCounts as Pa, TabularAuditEvent as Pi, AzureCredentials as Pn, AudioLocation as Pr, RedactionCreatedParams as Pt, PolicyDefinition as Q, RedactionActivityParams as Qa, TextEdit as Qi, PickerToken as Qn, DocumentContext as Qr, InviteStatus as Qt, HipaaAccountNumbers as R, WorkspaceAnalytics as Ra, TabularEntity as Ri, ConnectionPage as Rn, AudioRefinement as Rr, ListMembers as Rt, CountryCode as S, TokenExpiration as Sa, Point as Si, DetectionId as Sn, RegisteredRecognizer as Sr, ConnectionSyncCompletedParams as St, LanguageSpan as T, DetectionDayEntry as Ta, RasterMode as Ti, DetectionStatus as Tn, Attribution as Tr, DetectionFailedParams as Tt, LabelLocale as U, ActivityPayload as Ua, TabularPattern as Ui, CreateConnection as Un, Calibration as Ur, CreateInvite as Ut, Label as V, ActivityFilterQuery as Va, TabularManual as Vi, ConnectionVerification as Vn, AuditHash as Vr, MemberSortField as Vt, LabelRef as W, ActivityType as Wa, TabularRefinement as Wi, ExportFiles as Wn, Category as Wr, GenerateInviteCode as Wt, PciPanRender as X, PipelineActivityParams as Xa, TextCoord as Xi, OAuthTokens as Xn, Deduplication as Xr, InviteSent as Xt, PciDssPart as Y, MemberActivityParams as Ya, TextAuditLog as Yi, OAuthStartResponse as Yn, DecodedSpan as Yr, InvitePreview as Yt, Policy as Z, PolicyActivityParams as Za, TextData as Zi, PickedFile as Zn, Dimensions as Zr, InviteSortField as Zt, WebhookId as _, ApiToken as _a, LeakProfile as _i, ExportQuery as _n, SendChatMessage as _r, PipelineSummary as _t, RetentionSettings as a, TextRefinement as aa, ImageAuditKind as ai, DeleteFiles as an, Handle as ao, SyncSchedule as ar, Sha2Algorithm as at, WebhookStatus as b, ApiTokenWithJWT as ba, OperatorId as bi, CreateDetection as bn, LabelCatalog as br, UpdatePipeline as bt, WorkspacePage as c, ArtifactSet as ca, ImageEdit as ci, FileHash as cn, PublicAccount as co, SyncTriggerType as cr, TerminalFallback as ct, CreateWebhook as d, LayoutWord as da, ImageLocation as di, FormatToken as dn, paths as do, ChatMessage as dr, Waveform as dt, TextHint as ea, EditSet as ei, ReplyInvite as en, WorkspaceActivityParams as eo, S3Credentials as er, PolicyRule as et, TestWebhook as f, Token as fa, ImageManual as fi, ListFiles as fn, ChatRole as fr, CreatePipeline as ft, WebhookEvent as g, Transcription as ga, ImageRetag as gi, ExportFormat as gn, CreateChatSession as gr, PipelineStatus as gt, WebhookCreated as h, TranscriptWord as ha, ImageRefinement as hi, DateWindow as hn, ChatToken as hr, PipelineFilter as ht, RetentionOverride as i, TextPattern as ia, ImageAuditEvent as ii, HealthStatus as in, AccountRef as io, SyncMode as ir, Predicate as it, ConfidenceThreshold as j, RecognizerId as ja, SourceSpan as ji, RedactionResultPage as jn, AudioEdit as jr, NotificationPage as jt, ClampBucket as k, ModelUsageEntry as ka, Selection as ki, RedactionId as kn, AudioAuditLog as kr, Notification as kt, WorkspaceRole as l, Layout as la, ImageEntity as li, FileKind as ln, SetPassword as lo, UnauthenticatedProvider as lr, TextRedaction as lt, Webhook as m, TranscriptSegment as ma, ImagePattern as mi, UpdateFile as mn, ChatSessionPage as mr, PipelineDefinition as mt, RasterPolicy as n, TextManual as na, FreeformAttribution as ni, ComponentHealth as nn, AccountIdentities as no, StorageConfig as nr, PolicySummaryPage as nt, UpdateWorkspace as o, TextRetag as oa, ImageAuditLog as oi, DeletedFiles as on, IdentityProvider as oo, SyncScheduleInput as or, TabularRedaction as ot, UpdateWebhook as p, Tokens as pa, ImageModel as pi, ModalityToken as pn, ChatSession as pr, Pipeline as pt, LocalizedText as q, FileActivityParams as qa, TextAuditEvent as qi, ImportFiles as qn, Conflict as qr, InviteExpiration as qt, Retention as r, TextModel as ra, ImageAdd as ri, Health as rn, AccountIdentity as ro, SyncDeletionPolicy as rr, PolicyTemplate as rt, Workspace as s, TimeSpan as sa, ImageData as si, File as sn, OidcStartResponse as so, SyncStatus as sr, TemplateOrigin as st, CreateWorkspace as t, TextLocation as ta, EntityCoRef as ti, SortOrder as tn, Account as to, StartFileServiceOAuth as tr, PolicySummary as tt, WorkspaceSettings as u, LayoutBlock as ua, ImageHint as ui, FilePage as un, UpdateAccount as uo, UpdateConnection as ur, UpdatePolicy as ut, WebhookPage as v, ApiTokenPage as va, ManualIntent as vi, ErrorResponse as vn, ConnectorCatalog as vr, PipelineSummaryPage as vt, LanguageProvenance as w, DetectionAnalytics as wa, RangeOfUint as wi, DetectionPage as wn, Signup as wr, DetectionCompletedParams as wt, Confidence as x, CreateApiToken as xa, PatternEvent as xi, Detection as xn, RecognizerCatalog as xr, CursorPagination as xt, WebhookResult as y, ApiTokenType as ya, ModelEvent as yi, ValidationErrorDetail as yn, FileProviders as yr, PipelineTriggerType as yt, HipaaDeidMethod as z, Activity as za, TabularHint as zi, ConnectionSync as zn, AudioRetag as zr, Member as zt };
|
|
18154
|
+
//# sourceMappingURL=index-B-oR9rqQ.d.ts.map
|