@nvisy/sdk 0.48.0 → 0.49.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 +27 -1
- package/dist/{client-BMQhkLaC.d.ts → client-BEpBVGGP.d.ts} +70 -5
- package/dist/client-BEpBVGGP.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{error-DZ3l15-g.js → error-DNeyT0Z7.js} +2 -2
- package/dist/{error-DZ3l15-g.js.map → error-DNeyT0Z7.js.map} +1 -1
- package/dist/{errors-DILJOdod.d.ts → errors-DzQz1HIR.d.ts} +2 -2
- package/dist/{errors-DILJOdod.d.ts.map → errors-DzQz1HIR.d.ts.map} +1 -1
- package/dist/{index-BtQASJ4U.d.ts → index-CNUnM9QG.d.ts} +1999 -1216
- package/dist/index-CNUnM9QG.d.ts.map +1 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +8 -2
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +2 -2
- package/dist/{services-CG0FEolQ.js → services-COhgjbsy.js} +112 -7
- package/dist/services-COhgjbsy.js.map +1 -0
- package/dist/standalone/index.d.ts +1 -1
- package/dist/standalone/index.js +1 -1
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +1 -1
- package/dist/client-BMQhkLaC.d.ts.map +0 -1
- package/dist/index-BtQASJ4U.d.ts.map +0 -1
- package/dist/services-CG0FEolQ.js.map +0 -1
|
@@ -474,7 +474,7 @@ interface paths {
|
|
|
474
474
|
patch?: never;
|
|
475
475
|
trace?: never;
|
|
476
476
|
};
|
|
477
|
-
"/
|
|
477
|
+
"/workspaces/": {
|
|
478
478
|
parameters: {
|
|
479
479
|
query?: never;
|
|
480
480
|
header?: never;
|
|
@@ -482,25 +482,45 @@ interface paths {
|
|
|
482
482
|
cookie?: never;
|
|
483
483
|
};
|
|
484
484
|
/**
|
|
485
|
-
* List
|
|
486
|
-
* @description Returns the authenticated
|
|
485
|
+
* List workspaces
|
|
486
|
+
* @description Returns all workspaces the authenticated user is a member of.
|
|
487
487
|
*/
|
|
488
488
|
get: {
|
|
489
489
|
parameters: {
|
|
490
|
-
query?:
|
|
490
|
+
query?: {
|
|
491
|
+
/**
|
|
492
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
493
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
494
|
+
*/
|
|
495
|
+
after?: string;
|
|
496
|
+
/**
|
|
497
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
498
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
499
|
+
* only when the count is actually needed.
|
|
500
|
+
*/
|
|
501
|
+
includeCount?: boolean;
|
|
502
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
503
|
+
limit?: number;
|
|
504
|
+
};
|
|
491
505
|
header?: never;
|
|
492
506
|
path?: never;
|
|
493
507
|
cookie?: never;
|
|
494
508
|
};
|
|
495
509
|
requestBody?: never;
|
|
496
510
|
responses: {
|
|
497
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* @description Generic paginated response wrapper.
|
|
513
|
+
*
|
|
514
|
+
* Provides a consistent structure for all paginated API responses with
|
|
515
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
516
|
+
* are more items to fetch.
|
|
517
|
+
*/
|
|
498
518
|
200: {
|
|
499
519
|
headers: {
|
|
500
520
|
[name: string]: unknown;
|
|
501
521
|
};
|
|
502
522
|
content: {
|
|
503
|
-
"application/json": components["schemas"]["
|
|
523
|
+
"application/json": components["schemas"]["WorkspacePage"];
|
|
504
524
|
};
|
|
505
525
|
};
|
|
506
526
|
/**
|
|
@@ -521,26 +541,11 @@ interface paths {
|
|
|
521
541
|
};
|
|
522
542
|
};
|
|
523
543
|
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
544
|
/**
|
|
540
|
-
*
|
|
541
|
-
* @description
|
|
545
|
+
* Create workspace
|
|
546
|
+
* @description Creates a new workspace. The creator is automatically added as an owner.
|
|
542
547
|
*/
|
|
543
|
-
|
|
548
|
+
post: {
|
|
544
549
|
parameters: {
|
|
545
550
|
query?: never;
|
|
546
551
|
header?: never;
|
|
@@ -548,27 +553,25 @@ interface paths {
|
|
|
548
553
|
cookie?: never;
|
|
549
554
|
};
|
|
550
555
|
/**
|
|
551
|
-
* @description
|
|
556
|
+
* @description Request payload for creating a new workspace.
|
|
552
557
|
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
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.
|
|
558
|
+
* Creates a new workspace with the specified configuration. The creator is
|
|
559
|
+
* automatically added as an owner of the workspace.
|
|
559
560
|
*/
|
|
560
561
|
requestBody: {
|
|
561
562
|
content: {
|
|
562
|
-
"application/json": components["schemas"]["
|
|
563
|
+
"application/json": components["schemas"]["CreateWorkspace"];
|
|
563
564
|
};
|
|
564
565
|
};
|
|
565
566
|
responses: {
|
|
566
|
-
/** @description
|
|
567
|
-
|
|
567
|
+
/** @description Workspace response. */
|
|
568
|
+
201: {
|
|
568
569
|
headers: {
|
|
569
570
|
[name: string]: unknown;
|
|
570
571
|
};
|
|
571
|
-
content
|
|
572
|
+
content: {
|
|
573
|
+
"application/json": components["schemas"]["Workspace"];
|
|
574
|
+
};
|
|
572
575
|
};
|
|
573
576
|
/**
|
|
574
577
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -620,26 +623,43 @@ interface paths {
|
|
|
620
623
|
};
|
|
621
624
|
};
|
|
622
625
|
};
|
|
623
|
-
|
|
626
|
+
delete?: never;
|
|
627
|
+
options?: never;
|
|
628
|
+
head?: never;
|
|
629
|
+
patch?: never;
|
|
630
|
+
trace?: never;
|
|
631
|
+
};
|
|
632
|
+
"/workspaces/{workspaceSlug}/": {
|
|
633
|
+
parameters: {
|
|
634
|
+
query?: never;
|
|
635
|
+
header?: never;
|
|
636
|
+
path?: never;
|
|
637
|
+
cookie?: never;
|
|
638
|
+
};
|
|
624
639
|
/**
|
|
625
|
-
*
|
|
626
|
-
* @description
|
|
640
|
+
* Get workspace
|
|
641
|
+
* @description Returns details for a specific workspace.
|
|
627
642
|
*/
|
|
628
|
-
|
|
643
|
+
get: {
|
|
629
644
|
parameters: {
|
|
630
645
|
query?: never;
|
|
631
646
|
header?: never;
|
|
632
|
-
path
|
|
647
|
+
path: {
|
|
648
|
+
/** @description URL-safe workspace identifier. */
|
|
649
|
+
workspaceSlug: string;
|
|
650
|
+
};
|
|
633
651
|
cookie?: never;
|
|
634
652
|
};
|
|
635
653
|
requestBody?: never;
|
|
636
654
|
responses: {
|
|
637
|
-
/** @description
|
|
638
|
-
|
|
655
|
+
/** @description Workspace response. */
|
|
656
|
+
200: {
|
|
639
657
|
headers: {
|
|
640
658
|
[name: string]: unknown;
|
|
641
659
|
};
|
|
642
|
-
content
|
|
660
|
+
content: {
|
|
661
|
+
"application/json": components["schemas"]["Workspace"];
|
|
662
|
+
};
|
|
643
663
|
};
|
|
644
664
|
/**
|
|
645
665
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -663,7 +683,7 @@ interface paths {
|
|
|
663
683
|
* response, including the error name, message, HTTP status code, resource
|
|
664
684
|
* information, and user-friendly messages.
|
|
665
685
|
*/
|
|
666
|
-
|
|
686
|
+
403: {
|
|
667
687
|
headers: {
|
|
668
688
|
[name: string]: unknown;
|
|
669
689
|
};
|
|
@@ -678,7 +698,7 @@ interface paths {
|
|
|
678
698
|
* response, including the error name, message, HTTP status code, resource
|
|
679
699
|
* information, and user-friendly messages.
|
|
680
700
|
*/
|
|
681
|
-
|
|
701
|
+
404: {
|
|
682
702
|
headers: {
|
|
683
703
|
[name: string]: unknown;
|
|
684
704
|
};
|
|
@@ -688,56 +708,30 @@ interface paths {
|
|
|
688
708
|
};
|
|
689
709
|
};
|
|
690
710
|
};
|
|
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
711
|
put?: never;
|
|
712
|
+
post?: never;
|
|
705
713
|
/**
|
|
706
|
-
*
|
|
707
|
-
* @description
|
|
714
|
+
* Delete workspace
|
|
715
|
+
* @description Soft-deletes a workspace. Data is retained for potential recovery.
|
|
708
716
|
*/
|
|
709
|
-
|
|
717
|
+
delete: {
|
|
710
718
|
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
|
-
};
|
|
719
|
+
query?: never;
|
|
724
720
|
header?: never;
|
|
725
721
|
path: {
|
|
726
|
-
/** @description
|
|
727
|
-
|
|
722
|
+
/** @description URL-safe workspace identifier. */
|
|
723
|
+
workspaceSlug: string;
|
|
728
724
|
};
|
|
729
725
|
cookie?: never;
|
|
730
726
|
};
|
|
731
727
|
requestBody?: never;
|
|
732
728
|
responses: {
|
|
733
|
-
/** @description
|
|
729
|
+
/** @description no content */
|
|
734
730
|
200: {
|
|
735
731
|
headers: {
|
|
736
732
|
[name: string]: unknown;
|
|
737
733
|
};
|
|
738
|
-
content
|
|
739
|
-
"application/json": components["schemas"]["OidcStartResponse"];
|
|
740
|
-
};
|
|
734
|
+
content?: never;
|
|
741
735
|
};
|
|
742
736
|
/**
|
|
743
737
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -761,7 +755,7 @@ interface paths {
|
|
|
761
755
|
* response, including the error name, message, HTTP status code, resource
|
|
762
756
|
* information, and user-friendly messages.
|
|
763
757
|
*/
|
|
764
|
-
|
|
758
|
+
403: {
|
|
765
759
|
headers: {
|
|
766
760
|
[name: string]: unknown;
|
|
767
761
|
};
|
|
@@ -776,7 +770,7 @@ interface paths {
|
|
|
776
770
|
* response, including the error name, message, HTTP status code, resource
|
|
777
771
|
* information, and user-friendly messages.
|
|
778
772
|
*/
|
|
779
|
-
|
|
773
|
+
404: {
|
|
780
774
|
headers: {
|
|
781
775
|
[name: string]: unknown;
|
|
782
776
|
};
|
|
@@ -786,28 +780,42 @@ interface paths {
|
|
|
786
780
|
};
|
|
787
781
|
};
|
|
788
782
|
};
|
|
783
|
+
options?: never;
|
|
784
|
+
head?: never;
|
|
789
785
|
/**
|
|
790
|
-
*
|
|
791
|
-
* @description
|
|
786
|
+
* Update workspace
|
|
787
|
+
* @description Updates an existing workspace's configuration. Only provided fields are updated.
|
|
792
788
|
*/
|
|
793
|
-
|
|
789
|
+
patch: {
|
|
794
790
|
parameters: {
|
|
795
791
|
query?: never;
|
|
796
792
|
header?: never;
|
|
797
793
|
path: {
|
|
798
|
-
/** @description
|
|
799
|
-
|
|
794
|
+
/** @description URL-safe workspace identifier. */
|
|
795
|
+
workspaceSlug: string;
|
|
800
796
|
};
|
|
801
797
|
cookie?: never;
|
|
802
798
|
};
|
|
803
|
-
|
|
799
|
+
/**
|
|
800
|
+
* @description Request payload to update an existing workspace.
|
|
801
|
+
*
|
|
802
|
+
* All fields are optional; only provided fields will be updated. The slug is
|
|
803
|
+
* immutable and set at creation, so it cannot be changed here.
|
|
804
|
+
*/
|
|
805
|
+
requestBody: {
|
|
806
|
+
content: {
|
|
807
|
+
"application/json": components["schemas"]["UpdateWorkspace"];
|
|
808
|
+
};
|
|
809
|
+
};
|
|
804
810
|
responses: {
|
|
805
|
-
/** @description
|
|
806
|
-
|
|
811
|
+
/** @description Workspace response. */
|
|
812
|
+
200: {
|
|
807
813
|
headers: {
|
|
808
814
|
[name: string]: unknown;
|
|
809
815
|
};
|
|
810
|
-
content
|
|
816
|
+
content: {
|
|
817
|
+
"application/json": components["schemas"]["Workspace"];
|
|
818
|
+
};
|
|
811
819
|
};
|
|
812
820
|
/**
|
|
813
821
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -846,7 +854,7 @@ interface paths {
|
|
|
846
854
|
* response, including the error name, message, HTTP status code, resource
|
|
847
855
|
* information, and user-friendly messages.
|
|
848
856
|
*/
|
|
849
|
-
|
|
857
|
+
403: {
|
|
850
858
|
headers: {
|
|
851
859
|
[name: string]: unknown;
|
|
852
860
|
};
|
|
@@ -854,76 +862,63 @@ interface paths {
|
|
|
854
862
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
855
863
|
};
|
|
856
864
|
};
|
|
857
|
-
/**
|
|
858
|
-
|
|
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
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
866
|
+
415: {
|
|
865
867
|
headers: {
|
|
866
868
|
[name: string]: unknown;
|
|
867
869
|
};
|
|
868
870
|
content: {
|
|
869
|
-
"
|
|
871
|
+
"text/plain": string;
|
|
872
|
+
};
|
|
873
|
+
};
|
|
874
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
875
|
+
422: {
|
|
876
|
+
headers: {
|
|
877
|
+
[name: string]: unknown;
|
|
878
|
+
};
|
|
879
|
+
content: {
|
|
880
|
+
"text/plain": string;
|
|
870
881
|
};
|
|
871
882
|
};
|
|
872
883
|
};
|
|
873
884
|
};
|
|
874
|
-
options?: never;
|
|
875
|
-
head?: never;
|
|
876
|
-
patch?: never;
|
|
877
885
|
trace?: never;
|
|
878
886
|
};
|
|
879
|
-
"/workspaces/": {
|
|
887
|
+
"/workspaces/{workspaceSlug}/avatar/": {
|
|
880
888
|
parameters: {
|
|
881
889
|
query?: never;
|
|
882
890
|
header?: never;
|
|
883
891
|
path?: never;
|
|
884
892
|
cookie?: never;
|
|
885
893
|
};
|
|
894
|
+
get?: never;
|
|
886
895
|
/**
|
|
887
|
-
*
|
|
888
|
-
* @description
|
|
896
|
+
* Upload workspace avatar
|
|
897
|
+
* @description Uploads and normalizes the workspace's avatar. Requires UpdateWorkspace.
|
|
889
898
|
*/
|
|
890
|
-
|
|
899
|
+
put: {
|
|
891
900
|
parameters: {
|
|
892
|
-
query?:
|
|
893
|
-
/**
|
|
894
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
895
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
896
|
-
*/
|
|
897
|
-
after?: string;
|
|
898
|
-
/**
|
|
899
|
-
* @description Whether to include the total item count in the response's `total` field.
|
|
900
|
-
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
901
|
-
* only when the count is actually needed.
|
|
902
|
-
*/
|
|
903
|
-
includeCount?: boolean;
|
|
904
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
905
|
-
limit?: number;
|
|
906
|
-
};
|
|
901
|
+
query?: never;
|
|
907
902
|
header?: never;
|
|
908
|
-
path
|
|
903
|
+
path: {
|
|
904
|
+
/** @description URL-safe workspace identifier. */
|
|
905
|
+
workspaceSlug: string;
|
|
906
|
+
};
|
|
909
907
|
cookie?: never;
|
|
910
908
|
};
|
|
911
|
-
|
|
909
|
+
/** @description multipart form data */
|
|
910
|
+
requestBody: {
|
|
911
|
+
content: {
|
|
912
|
+
"multipart/form-data": unknown[];
|
|
913
|
+
};
|
|
914
|
+
};
|
|
912
915
|
responses: {
|
|
913
|
-
/**
|
|
914
|
-
* @description Generic paginated response wrapper.
|
|
915
|
-
*
|
|
916
|
-
* Provides a consistent structure for all paginated API responses with
|
|
917
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
918
|
-
* are more items to fetch.
|
|
919
|
-
*/
|
|
916
|
+
/** @description no content */
|
|
920
917
|
200: {
|
|
921
918
|
headers: {
|
|
922
919
|
[name: string]: unknown;
|
|
923
920
|
};
|
|
924
|
-
content
|
|
925
|
-
"application/json": components["schemas"]["WorkspacePage"];
|
|
926
|
-
};
|
|
921
|
+
content?: never;
|
|
927
922
|
};
|
|
928
923
|
/**
|
|
929
924
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -932,7 +927,7 @@ interface paths {
|
|
|
932
927
|
* response, including the error name, message, HTTP status code, resource
|
|
933
928
|
* information, and user-friendly messages.
|
|
934
929
|
*/
|
|
935
|
-
|
|
930
|
+
400: {
|
|
936
931
|
headers: {
|
|
937
932
|
[name: string]: unknown;
|
|
938
933
|
};
|
|
@@ -940,41 +935,6 @@ interface paths {
|
|
|
940
935
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
941
936
|
};
|
|
942
937
|
};
|
|
943
|
-
};
|
|
944
|
-
};
|
|
945
|
-
put?: never;
|
|
946
|
-
/**
|
|
947
|
-
* Create workspace
|
|
948
|
-
* @description Creates a new workspace. The creator is automatically added as an owner.
|
|
949
|
-
*/
|
|
950
|
-
post: {
|
|
951
|
-
parameters: {
|
|
952
|
-
query?: never;
|
|
953
|
-
header?: never;
|
|
954
|
-
path?: never;
|
|
955
|
-
cookie?: never;
|
|
956
|
-
};
|
|
957
|
-
/**
|
|
958
|
-
* @description Request payload for creating a new workspace.
|
|
959
|
-
*
|
|
960
|
-
* Creates a new workspace with the specified configuration. The creator is
|
|
961
|
-
* automatically added as an owner of the workspace.
|
|
962
|
-
*/
|
|
963
|
-
requestBody: {
|
|
964
|
-
content: {
|
|
965
|
-
"application/json": components["schemas"]["CreateWorkspace"];
|
|
966
|
-
};
|
|
967
|
-
};
|
|
968
|
-
responses: {
|
|
969
|
-
/** @description Workspace response. */
|
|
970
|
-
201: {
|
|
971
|
-
headers: {
|
|
972
|
-
[name: string]: unknown;
|
|
973
|
-
};
|
|
974
|
-
content: {
|
|
975
|
-
"application/json": components["schemas"]["Workspace"];
|
|
976
|
-
};
|
|
977
|
-
};
|
|
978
938
|
/**
|
|
979
939
|
* @description HTTP error response representation with security-conscious design.
|
|
980
940
|
*
|
|
@@ -982,7 +942,7 @@ interface paths {
|
|
|
982
942
|
* response, including the error name, message, HTTP status code, resource
|
|
983
943
|
* information, and user-friendly messages.
|
|
984
944
|
*/
|
|
985
|
-
|
|
945
|
+
401: {
|
|
986
946
|
headers: {
|
|
987
947
|
[name: string]: unknown;
|
|
988
948
|
};
|
|
@@ -997,7 +957,7 @@ interface paths {
|
|
|
997
957
|
* response, including the error name, message, HTTP status code, resource
|
|
998
958
|
* information, and user-friendly messages.
|
|
999
959
|
*/
|
|
1000
|
-
|
|
960
|
+
403: {
|
|
1001
961
|
headers: {
|
|
1002
962
|
[name: string]: unknown;
|
|
1003
963
|
};
|
|
@@ -1005,44 +965,29 @@ interface paths {
|
|
|
1005
965
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1006
966
|
};
|
|
1007
967
|
};
|
|
1008
|
-
/**
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
};
|
|
1017
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1018
|
-
422: {
|
|
968
|
+
/**
|
|
969
|
+
* @description HTTP error response representation with security-conscious design.
|
|
970
|
+
*
|
|
971
|
+
* This struct contains all the information needed to serialize an error
|
|
972
|
+
* response, including the error name, message, HTTP status code, resource
|
|
973
|
+
* information, and user-friendly messages.
|
|
974
|
+
*/
|
|
975
|
+
404: {
|
|
1019
976
|
headers: {
|
|
1020
977
|
[name: string]: unknown;
|
|
1021
978
|
};
|
|
1022
979
|
content: {
|
|
1023
|
-
"
|
|
980
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1024
981
|
};
|
|
1025
982
|
};
|
|
1026
983
|
};
|
|
1027
984
|
};
|
|
1028
|
-
|
|
1029
|
-
options?: never;
|
|
1030
|
-
head?: never;
|
|
1031
|
-
patch?: never;
|
|
1032
|
-
trace?: never;
|
|
1033
|
-
};
|
|
1034
|
-
"/workspaces/{workspaceSlug}/": {
|
|
1035
|
-
parameters: {
|
|
1036
|
-
query?: never;
|
|
1037
|
-
header?: never;
|
|
1038
|
-
path?: never;
|
|
1039
|
-
cookie?: never;
|
|
1040
|
-
};
|
|
985
|
+
post?: never;
|
|
1041
986
|
/**
|
|
1042
|
-
*
|
|
1043
|
-
* @description
|
|
987
|
+
* Delete workspace avatar
|
|
988
|
+
* @description Removes the workspace's avatar. Requires UpdateWorkspace.
|
|
1044
989
|
*/
|
|
1045
|
-
|
|
990
|
+
delete: {
|
|
1046
991
|
parameters: {
|
|
1047
992
|
query?: never;
|
|
1048
993
|
header?: never;
|
|
@@ -1054,14 +999,12 @@ interface paths {
|
|
|
1054
999
|
};
|
|
1055
1000
|
requestBody?: never;
|
|
1056
1001
|
responses: {
|
|
1057
|
-
/** @description
|
|
1058
|
-
|
|
1002
|
+
/** @description no content */
|
|
1003
|
+
204: {
|
|
1059
1004
|
headers: {
|
|
1060
1005
|
[name: string]: unknown;
|
|
1061
1006
|
};
|
|
1062
|
-
content
|
|
1063
|
-
"application/json": components["schemas"]["Workspace"];
|
|
1064
|
-
};
|
|
1007
|
+
content?: never;
|
|
1065
1008
|
};
|
|
1066
1009
|
/**
|
|
1067
1010
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1110,13 +1053,23 @@ interface paths {
|
|
|
1110
1053
|
};
|
|
1111
1054
|
};
|
|
1112
1055
|
};
|
|
1113
|
-
|
|
1114
|
-
|
|
1056
|
+
options?: never;
|
|
1057
|
+
head?: never;
|
|
1058
|
+
patch?: never;
|
|
1059
|
+
trace?: never;
|
|
1060
|
+
};
|
|
1061
|
+
"/workspaces/{workspaceSlug}/notifications/": {
|
|
1062
|
+
parameters: {
|
|
1063
|
+
query?: never;
|
|
1064
|
+
header?: never;
|
|
1065
|
+
path?: never;
|
|
1066
|
+
cookie?: never;
|
|
1067
|
+
};
|
|
1115
1068
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
* @description
|
|
1069
|
+
* Get notification settings
|
|
1070
|
+
* @description Returns the notification settings for the authenticated user in a workspace.
|
|
1118
1071
|
*/
|
|
1119
|
-
|
|
1072
|
+
get: {
|
|
1120
1073
|
parameters: {
|
|
1121
1074
|
query?: never;
|
|
1122
1075
|
header?: never;
|
|
@@ -1128,26 +1081,13 @@ interface paths {
|
|
|
1128
1081
|
};
|
|
1129
1082
|
requestBody?: never;
|
|
1130
1083
|
responses: {
|
|
1131
|
-
/** @description
|
|
1084
|
+
/** @description Response for notification settings within a workspace. */
|
|
1132
1085
|
200: {
|
|
1133
|
-
headers: {
|
|
1134
|
-
[name: string]: unknown;
|
|
1135
|
-
};
|
|
1136
|
-
content?: never;
|
|
1137
|
-
};
|
|
1138
|
-
/**
|
|
1139
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1140
|
-
*
|
|
1141
|
-
* This struct contains all the information needed to serialize an error
|
|
1142
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1143
|
-
* information, and user-friendly messages.
|
|
1144
|
-
*/
|
|
1145
|
-
401: {
|
|
1146
1086
|
headers: {
|
|
1147
1087
|
[name: string]: unknown;
|
|
1148
1088
|
};
|
|
1149
1089
|
content: {
|
|
1150
|
-
"application/json": components["schemas"]["
|
|
1090
|
+
"application/json": components["schemas"]["NotificationSettings"];
|
|
1151
1091
|
};
|
|
1152
1092
|
};
|
|
1153
1093
|
/**
|
|
@@ -1157,7 +1097,7 @@ interface paths {
|
|
|
1157
1097
|
* response, including the error name, message, HTTP status code, resource
|
|
1158
1098
|
* information, and user-friendly messages.
|
|
1159
1099
|
*/
|
|
1160
|
-
|
|
1100
|
+
401: {
|
|
1161
1101
|
headers: {
|
|
1162
1102
|
[name: string]: unknown;
|
|
1163
1103
|
};
|
|
@@ -1182,11 +1122,14 @@ interface paths {
|
|
|
1182
1122
|
};
|
|
1183
1123
|
};
|
|
1184
1124
|
};
|
|
1125
|
+
put?: never;
|
|
1126
|
+
post?: never;
|
|
1127
|
+
delete?: never;
|
|
1185
1128
|
options?: never;
|
|
1186
1129
|
head?: never;
|
|
1187
1130
|
/**
|
|
1188
|
-
* Update
|
|
1189
|
-
* @description Updates
|
|
1131
|
+
* Update notification settings
|
|
1132
|
+
* @description Updates the notification settings for the authenticated user in a workspace.
|
|
1190
1133
|
*/
|
|
1191
1134
|
patch: {
|
|
1192
1135
|
parameters: {
|
|
@@ -1198,25 +1141,20 @@ interface paths {
|
|
|
1198
1141
|
};
|
|
1199
1142
|
cookie?: never;
|
|
1200
1143
|
};
|
|
1201
|
-
/**
|
|
1202
|
-
* @description Request payload to update an existing workspace.
|
|
1203
|
-
*
|
|
1204
|
-
* All fields are optional; only provided fields will be updated. The slug is
|
|
1205
|
-
* immutable and set at creation, so it cannot be changed here.
|
|
1206
|
-
*/
|
|
1144
|
+
/** @description Request payload for updating notification settings. */
|
|
1207
1145
|
requestBody: {
|
|
1208
1146
|
content: {
|
|
1209
|
-
"application/json": components["schemas"]["
|
|
1147
|
+
"application/json": components["schemas"]["UpdateNotificationSettings"];
|
|
1210
1148
|
};
|
|
1211
1149
|
};
|
|
1212
1150
|
responses: {
|
|
1213
|
-
/** @description
|
|
1151
|
+
/** @description Response for notification settings within a workspace. */
|
|
1214
1152
|
200: {
|
|
1215
1153
|
headers: {
|
|
1216
1154
|
[name: string]: unknown;
|
|
1217
1155
|
};
|
|
1218
1156
|
content: {
|
|
1219
|
-
"application/json": components["schemas"]["
|
|
1157
|
+
"application/json": components["schemas"]["NotificationSettings"];
|
|
1220
1158
|
};
|
|
1221
1159
|
};
|
|
1222
1160
|
/**
|
|
@@ -1256,7 +1194,7 @@ interface paths {
|
|
|
1256
1194
|
* response, including the error name, message, HTTP status code, resource
|
|
1257
1195
|
* information, and user-friendly messages.
|
|
1258
1196
|
*/
|
|
1259
|
-
|
|
1197
|
+
404: {
|
|
1260
1198
|
headers: {
|
|
1261
1199
|
[name: string]: unknown;
|
|
1262
1200
|
};
|
|
@@ -1286,21 +1224,48 @@ interface paths {
|
|
|
1286
1224
|
};
|
|
1287
1225
|
trace?: never;
|
|
1288
1226
|
};
|
|
1289
|
-
"/workspaces/{workspaceSlug}/
|
|
1227
|
+
"/workspaces/{workspaceSlug}/activities/": {
|
|
1290
1228
|
parameters: {
|
|
1291
1229
|
query?: never;
|
|
1292
1230
|
header?: never;
|
|
1293
1231
|
path?: never;
|
|
1294
1232
|
cookie?: never;
|
|
1295
1233
|
};
|
|
1296
|
-
get?: never;
|
|
1297
1234
|
/**
|
|
1298
|
-
*
|
|
1299
|
-
* @description
|
|
1235
|
+
* List workspace activities
|
|
1236
|
+
* @description Returns the workspace's activity log, most recent first, cursor-paginated. Optional filters: `type` (repeatable, e.g. `file.created`), `actor` (a username), and a `from`/`to` day range (each bound narrows only when given; the feed is otherwise all-time).
|
|
1300
1237
|
*/
|
|
1301
|
-
|
|
1238
|
+
get: {
|
|
1302
1239
|
parameters: {
|
|
1303
|
-
query?:
|
|
1240
|
+
query?: {
|
|
1241
|
+
/** @description Username of the account whose activities to keep. Omit for any actor. */
|
|
1242
|
+
actor?: components["schemas"]["Handle"];
|
|
1243
|
+
/**
|
|
1244
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
1245
|
+
* parameter for several; omit for no type constraint.
|
|
1246
|
+
*/
|
|
1247
|
+
type?: components["schemas"]["ActivityType"][];
|
|
1248
|
+
/**
|
|
1249
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1250
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1251
|
+
*/
|
|
1252
|
+
from?: string;
|
|
1253
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1254
|
+
to?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
1257
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
1258
|
+
*/
|
|
1259
|
+
after?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
1262
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
1263
|
+
* only when the count is actually needed.
|
|
1264
|
+
*/
|
|
1265
|
+
includeCount?: boolean;
|
|
1266
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1267
|
+
limit?: number;
|
|
1268
|
+
};
|
|
1304
1269
|
header?: never;
|
|
1305
1270
|
path: {
|
|
1306
1271
|
/** @description URL-safe workspace identifier. */
|
|
@@ -1308,33 +1273,21 @@ interface paths {
|
|
|
1308
1273
|
};
|
|
1309
1274
|
cookie?: never;
|
|
1310
1275
|
};
|
|
1311
|
-
|
|
1312
|
-
requestBody: {
|
|
1313
|
-
content: {
|
|
1314
|
-
"multipart/form-data": unknown[];
|
|
1315
|
-
};
|
|
1316
|
-
};
|
|
1276
|
+
requestBody?: never;
|
|
1317
1277
|
responses: {
|
|
1318
|
-
/** @description no content */
|
|
1319
|
-
200: {
|
|
1320
|
-
headers: {
|
|
1321
|
-
[name: string]: unknown;
|
|
1322
|
-
};
|
|
1323
|
-
content?: never;
|
|
1324
|
-
};
|
|
1325
1278
|
/**
|
|
1326
|
-
* @description
|
|
1279
|
+
* @description Generic paginated response wrapper.
|
|
1327
1280
|
*
|
|
1328
|
-
*
|
|
1329
|
-
*
|
|
1330
|
-
*
|
|
1281
|
+
* Provides a consistent structure for all paginated API responses with
|
|
1282
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
1283
|
+
* are more items to fetch.
|
|
1331
1284
|
*/
|
|
1332
|
-
|
|
1285
|
+
200: {
|
|
1333
1286
|
headers: {
|
|
1334
1287
|
[name: string]: unknown;
|
|
1335
1288
|
};
|
|
1336
1289
|
content: {
|
|
1337
|
-
"application/json": components["schemas"]["
|
|
1290
|
+
"application/json": components["schemas"]["ActivityPage"];
|
|
1338
1291
|
};
|
|
1339
1292
|
};
|
|
1340
1293
|
/**
|
|
@@ -1367,31 +1320,47 @@ interface paths {
|
|
|
1367
1320
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1368
1321
|
};
|
|
1369
1322
|
};
|
|
1370
|
-
/**
|
|
1371
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1372
|
-
*
|
|
1373
|
-
* This struct contains all the information needed to serialize an error
|
|
1374
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1375
|
-
* information, and user-friendly messages.
|
|
1376
|
-
*/
|
|
1377
|
-
404: {
|
|
1378
|
-
headers: {
|
|
1379
|
-
[name: string]: unknown;
|
|
1380
|
-
};
|
|
1381
|
-
content: {
|
|
1382
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1383
|
-
};
|
|
1384
|
-
};
|
|
1385
1323
|
};
|
|
1386
1324
|
};
|
|
1325
|
+
put?: never;
|
|
1387
1326
|
post?: never;
|
|
1327
|
+
delete?: never;
|
|
1328
|
+
options?: never;
|
|
1329
|
+
head?: never;
|
|
1330
|
+
patch?: never;
|
|
1331
|
+
trace?: never;
|
|
1332
|
+
};
|
|
1333
|
+
"/workspaces/{workspaceSlug}/activities/export": {
|
|
1334
|
+
parameters: {
|
|
1335
|
+
query?: never;
|
|
1336
|
+
header?: never;
|
|
1337
|
+
path?: never;
|
|
1338
|
+
cookie?: never;
|
|
1339
|
+
};
|
|
1388
1340
|
/**
|
|
1389
|
-
*
|
|
1390
|
-
* @description
|
|
1341
|
+
* Export workspace activities
|
|
1342
|
+
* @description Exports a workspace's activity log over a date window as a downloadable file. The window is `from`/`to` (inclusive, YYYY-MM-DD); it defaults to the last 30 days and is capped at 366 days. The same `type` (repeatable) and `actor` filters as the feed apply. `format` is `csv` (default) or `json`. Each activity is a flat row: timestamp, the type split into object/action, the actor, and the acted-on object's id and label, oldest first. At most 100,000 rows are returned (the oldest in the window); a truncated export sets the `X-Export-Truncated` response header.
|
|
1391
1343
|
*/
|
|
1392
|
-
|
|
1344
|
+
get: {
|
|
1393
1345
|
parameters: {
|
|
1394
|
-
query?:
|
|
1346
|
+
query?: {
|
|
1347
|
+
/** @description Username of the account whose activities to keep. Omit for any actor. */
|
|
1348
|
+
actor?: components["schemas"]["Handle"];
|
|
1349
|
+
/**
|
|
1350
|
+
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
1351
|
+
* parameter for several; omit for no type constraint.
|
|
1352
|
+
*/
|
|
1353
|
+
type?: components["schemas"]["ActivityType"][];
|
|
1354
|
+
/**
|
|
1355
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1356
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1357
|
+
*/
|
|
1358
|
+
from?: string;
|
|
1359
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1360
|
+
to?: string;
|
|
1361
|
+
/** @description Output format; defaults to `csv`. */
|
|
1362
|
+
format?: components["schemas"]["ExportFormat"];
|
|
1363
|
+
};
|
|
1395
1364
|
header?: never;
|
|
1396
1365
|
path: {
|
|
1397
1366
|
/** @description URL-safe workspace identifier. */
|
|
@@ -1401,12 +1370,30 @@ interface paths {
|
|
|
1401
1370
|
};
|
|
1402
1371
|
requestBody?: never;
|
|
1403
1372
|
responses: {
|
|
1404
|
-
/** @description
|
|
1405
|
-
|
|
1373
|
+
/** @description The exported activity log. */
|
|
1374
|
+
200: {
|
|
1406
1375
|
headers: {
|
|
1407
1376
|
[name: string]: unknown;
|
|
1408
1377
|
};
|
|
1409
|
-
content
|
|
1378
|
+
content: {
|
|
1379
|
+
"text/csv": unknown;
|
|
1380
|
+
"application/json": unknown;
|
|
1381
|
+
};
|
|
1382
|
+
};
|
|
1383
|
+
/**
|
|
1384
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1385
|
+
*
|
|
1386
|
+
* This struct contains all the information needed to serialize an error
|
|
1387
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1388
|
+
* information, and user-friendly messages.
|
|
1389
|
+
*/
|
|
1390
|
+
400: {
|
|
1391
|
+
headers: {
|
|
1392
|
+
[name: string]: unknown;
|
|
1393
|
+
};
|
|
1394
|
+
content: {
|
|
1395
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1396
|
+
};
|
|
1410
1397
|
};
|
|
1411
1398
|
/**
|
|
1412
1399
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1455,12 +1442,15 @@ interface paths {
|
|
|
1455
1442
|
};
|
|
1456
1443
|
};
|
|
1457
1444
|
};
|
|
1445
|
+
put?: never;
|
|
1446
|
+
post?: never;
|
|
1447
|
+
delete?: never;
|
|
1458
1448
|
options?: never;
|
|
1459
1449
|
head?: never;
|
|
1460
1450
|
patch?: never;
|
|
1461
1451
|
trace?: never;
|
|
1462
1452
|
};
|
|
1463
|
-
"/workspaces/{workspaceSlug}/
|
|
1453
|
+
"/workspaces/{workspaceSlug}/analytics/": {
|
|
1464
1454
|
parameters: {
|
|
1465
1455
|
query?: never;
|
|
1466
1456
|
header?: never;
|
|
@@ -1468,8 +1458,8 @@ interface paths {
|
|
|
1468
1458
|
cookie?: never;
|
|
1469
1459
|
};
|
|
1470
1460
|
/**
|
|
1471
|
-
*
|
|
1472
|
-
* @description Returns
|
|
1461
|
+
* Workspace analytics
|
|
1462
|
+
* @description Returns aggregate analytics for a workspace: stored-file totals with a per-kind breakdown, detection health (status mix, error rate, and durations), and inference token usage (workspace totals plus a per-model breakdown). Breakdowns list every kind/status, zero-filled, in a stable order.
|
|
1473
1463
|
*/
|
|
1474
1464
|
get: {
|
|
1475
1465
|
parameters: {
|
|
@@ -1483,13 +1473,16 @@ interface paths {
|
|
|
1483
1473
|
};
|
|
1484
1474
|
requestBody?: never;
|
|
1485
1475
|
responses: {
|
|
1486
|
-
/**
|
|
1476
|
+
/**
|
|
1477
|
+
* @description Aggregate analytics for a workspace: what it stores, how its detections fare, and
|
|
1478
|
+
* the inference tokens they spent.
|
|
1479
|
+
*/
|
|
1487
1480
|
200: {
|
|
1488
1481
|
headers: {
|
|
1489
1482
|
[name: string]: unknown;
|
|
1490
1483
|
};
|
|
1491
1484
|
content: {
|
|
1492
|
-
"application/json": components["schemas"]["
|
|
1485
|
+
"application/json": components["schemas"]["WorkspaceAnalytics"];
|
|
1493
1486
|
};
|
|
1494
1487
|
};
|
|
1495
1488
|
/**
|
|
@@ -1507,6 +1500,21 @@ interface paths {
|
|
|
1507
1500
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1508
1501
|
};
|
|
1509
1502
|
};
|
|
1503
|
+
/**
|
|
1504
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1505
|
+
*
|
|
1506
|
+
* This struct contains all the information needed to serialize an error
|
|
1507
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1508
|
+
* information, and user-friendly messages.
|
|
1509
|
+
*/
|
|
1510
|
+
403: {
|
|
1511
|
+
headers: {
|
|
1512
|
+
[name: string]: unknown;
|
|
1513
|
+
};
|
|
1514
|
+
content: {
|
|
1515
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1516
|
+
};
|
|
1517
|
+
};
|
|
1510
1518
|
/**
|
|
1511
1519
|
* @description HTTP error response representation with security-conscious design.
|
|
1512
1520
|
*
|
|
@@ -1529,13 +1537,31 @@ interface paths {
|
|
|
1529
1537
|
delete?: never;
|
|
1530
1538
|
options?: never;
|
|
1531
1539
|
head?: never;
|
|
1540
|
+
patch?: never;
|
|
1541
|
+
trace?: never;
|
|
1542
|
+
};
|
|
1543
|
+
"/workspaces/{workspaceSlug}/analytics/detections/timeseries/": {
|
|
1544
|
+
parameters: {
|
|
1545
|
+
query?: never;
|
|
1546
|
+
header?: never;
|
|
1547
|
+
path?: never;
|
|
1548
|
+
cookie?: never;
|
|
1549
|
+
};
|
|
1532
1550
|
/**
|
|
1533
|
-
*
|
|
1534
|
-
* @description
|
|
1551
|
+
* Workspace detection time series
|
|
1552
|
+
* @description Returns a workspace's daily detection activity over a date window: detections per day, plus each day's error rate and durations. Every day in the window is present (quiet days report detections: 0), so the series plots as a continuous line or a contribution-style calendar. The window is `from`/`to` (inclusive, YYYY-MM-DD); it defaults to the last 30 days and is capped at 366 days.
|
|
1535
1553
|
*/
|
|
1536
|
-
|
|
1554
|
+
get: {
|
|
1537
1555
|
parameters: {
|
|
1538
|
-
query?:
|
|
1556
|
+
query?: {
|
|
1557
|
+
/**
|
|
1558
|
+
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1559
|
+
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1560
|
+
*/
|
|
1561
|
+
from?: string;
|
|
1562
|
+
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1563
|
+
to?: string;
|
|
1564
|
+
};
|
|
1539
1565
|
header?: never;
|
|
1540
1566
|
path: {
|
|
1541
1567
|
/** @description URL-safe workspace identifier. */
|
|
@@ -1543,20 +1569,19 @@ interface paths {
|
|
|
1543
1569
|
};
|
|
1544
1570
|
cookie?: never;
|
|
1545
1571
|
};
|
|
1546
|
-
|
|
1547
|
-
requestBody: {
|
|
1548
|
-
content: {
|
|
1549
|
-
"application/json": components["schemas"]["UpdateNotificationSettings"];
|
|
1550
|
-
};
|
|
1551
|
-
};
|
|
1572
|
+
requestBody?: never;
|
|
1552
1573
|
responses: {
|
|
1553
|
-
/**
|
|
1574
|
+
/**
|
|
1575
|
+
* @description A workspace's daily detection activity over a window: one point per day, dense
|
|
1576
|
+
* (quiet days included with `detections: 0`), ready to plot as a continuous
|
|
1577
|
+
* series.
|
|
1578
|
+
*/
|
|
1554
1579
|
200: {
|
|
1555
1580
|
headers: {
|
|
1556
1581
|
[name: string]: unknown;
|
|
1557
1582
|
};
|
|
1558
1583
|
content: {
|
|
1559
|
-
"application/json": components["schemas"]["
|
|
1584
|
+
"application/json": components["schemas"]["DetectionTimeSeries"];
|
|
1560
1585
|
};
|
|
1561
1586
|
};
|
|
1562
1587
|
/**
|
|
@@ -1596,7 +1621,7 @@ interface paths {
|
|
|
1596
1621
|
* response, including the error name, message, HTTP status code, resource
|
|
1597
1622
|
* information, and user-friendly messages.
|
|
1598
1623
|
*/
|
|
1599
|
-
|
|
1624
|
+
403: {
|
|
1600
1625
|
headers: {
|
|
1601
1626
|
[name: string]: unknown;
|
|
1602
1627
|
};
|
|
@@ -1604,29 +1629,32 @@ interface paths {
|
|
|
1604
1629
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1605
1630
|
};
|
|
1606
1631
|
};
|
|
1607
|
-
/**
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
};
|
|
1616
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1617
|
-
422: {
|
|
1632
|
+
/**
|
|
1633
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1634
|
+
*
|
|
1635
|
+
* This struct contains all the information needed to serialize an error
|
|
1636
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1637
|
+
* information, and user-friendly messages.
|
|
1638
|
+
*/
|
|
1639
|
+
404: {
|
|
1618
1640
|
headers: {
|
|
1619
1641
|
[name: string]: unknown;
|
|
1620
1642
|
};
|
|
1621
1643
|
content: {
|
|
1622
|
-
"
|
|
1644
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1623
1645
|
};
|
|
1624
1646
|
};
|
|
1625
1647
|
};
|
|
1626
1648
|
};
|
|
1649
|
+
put?: never;
|
|
1650
|
+
post?: never;
|
|
1651
|
+
delete?: never;
|
|
1652
|
+
options?: never;
|
|
1653
|
+
head?: never;
|
|
1654
|
+
patch?: never;
|
|
1627
1655
|
trace?: never;
|
|
1628
1656
|
};
|
|
1629
|
-
"/workspaces/{workspaceSlug}/
|
|
1657
|
+
"/workspaces/{workspaceSlug}/members/": {
|
|
1630
1658
|
parameters: {
|
|
1631
1659
|
query?: never;
|
|
1632
1660
|
header?: never;
|
|
@@ -1634,26 +1662,20 @@ interface paths {
|
|
|
1634
1662
|
cookie?: never;
|
|
1635
1663
|
};
|
|
1636
1664
|
/**
|
|
1637
|
-
* List
|
|
1638
|
-
* @description Returns
|
|
1665
|
+
* List members
|
|
1666
|
+
* @description Returns a paginated list of workspace members with their roles and status.
|
|
1639
1667
|
*/
|
|
1640
1668
|
get: {
|
|
1641
1669
|
parameters: {
|
|
1642
1670
|
query?: {
|
|
1643
|
-
/** @description
|
|
1644
|
-
|
|
1645
|
-
/**
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1652
|
-
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1653
|
-
*/
|
|
1654
|
-
from?: string;
|
|
1655
|
-
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1656
|
-
to?: string;
|
|
1671
|
+
/** @description Filter by 2FA status. */
|
|
1672
|
+
has2fa?: boolean;
|
|
1673
|
+
/** @description Sort order (asc or desc). */
|
|
1674
|
+
order?: components["schemas"]["SortOrder"];
|
|
1675
|
+
/** @description Filter by workspace role. */
|
|
1676
|
+
role?: components["schemas"]["WorkspaceRole"];
|
|
1677
|
+
/** @description Sort by field. */
|
|
1678
|
+
sortBy?: components["schemas"]["MemberSortField"];
|
|
1657
1679
|
/**
|
|
1658
1680
|
* @description Cursor pointing to the last item of the previous page.
|
|
1659
1681
|
* Obtain this from the `nextCursor` field in the response.
|
|
@@ -1689,7 +1711,7 @@ interface paths {
|
|
|
1689
1711
|
[name: string]: unknown;
|
|
1690
1712
|
};
|
|
1691
1713
|
content: {
|
|
1692
|
-
"application/json": components["schemas"]["
|
|
1714
|
+
"application/json": components["schemas"]["MemberPage"];
|
|
1693
1715
|
};
|
|
1694
1716
|
};
|
|
1695
1717
|
/**
|
|
@@ -1722,6 +1744,21 @@ interface paths {
|
|
|
1722
1744
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1723
1745
|
};
|
|
1724
1746
|
};
|
|
1747
|
+
/**
|
|
1748
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1749
|
+
*
|
|
1750
|
+
* This struct contains all the information needed to serialize an error
|
|
1751
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1752
|
+
* information, and user-friendly messages.
|
|
1753
|
+
*/
|
|
1754
|
+
404: {
|
|
1755
|
+
headers: {
|
|
1756
|
+
[name: string]: unknown;
|
|
1757
|
+
};
|
|
1758
|
+
content: {
|
|
1759
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1760
|
+
};
|
|
1761
|
+
};
|
|
1725
1762
|
};
|
|
1726
1763
|
};
|
|
1727
1764
|
put?: never;
|
|
@@ -1732,37 +1769,22 @@ interface paths {
|
|
|
1732
1769
|
patch?: never;
|
|
1733
1770
|
trace?: never;
|
|
1734
1771
|
};
|
|
1735
|
-
"/workspaces/{workspaceSlug}/
|
|
1772
|
+
"/workspaces/{workspaceSlug}/members/leave/": {
|
|
1736
1773
|
parameters: {
|
|
1737
1774
|
query?: never;
|
|
1738
1775
|
header?: never;
|
|
1739
1776
|
path?: never;
|
|
1740
1777
|
cookie?: never;
|
|
1741
1778
|
};
|
|
1779
|
+
get?: never;
|
|
1780
|
+
put?: never;
|
|
1742
1781
|
/**
|
|
1743
|
-
*
|
|
1744
|
-
* @description
|
|
1782
|
+
* Leave workspace
|
|
1783
|
+
* @description Allows a member to voluntarily leave a workspace.
|
|
1745
1784
|
*/
|
|
1746
|
-
|
|
1785
|
+
post: {
|
|
1747
1786
|
parameters: {
|
|
1748
|
-
query?:
|
|
1749
|
-
/** @description Username of the account whose activities to keep. Omit for any actor. */
|
|
1750
|
-
actor?: components["schemas"]["Handle"];
|
|
1751
|
-
/**
|
|
1752
|
-
* @description Keep only these activity types (e.g. `file.created`). Repeat the `type`
|
|
1753
|
-
* parameter for several; omit for no type constraint.
|
|
1754
|
-
*/
|
|
1755
|
-
type?: components["schemas"]["ActivityType"][];
|
|
1756
|
-
/**
|
|
1757
|
-
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1758
|
-
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1759
|
-
*/
|
|
1760
|
-
from?: string;
|
|
1761
|
-
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1762
|
-
to?: string;
|
|
1763
|
-
/** @description Output format; defaults to `csv`. */
|
|
1764
|
-
format?: components["schemas"]["ExportFormat"];
|
|
1765
|
-
};
|
|
1787
|
+
query?: never;
|
|
1766
1788
|
header?: never;
|
|
1767
1789
|
path: {
|
|
1768
1790
|
/** @description URL-safe workspace identifier. */
|
|
@@ -1772,15 +1794,12 @@ interface paths {
|
|
|
1772
1794
|
};
|
|
1773
1795
|
requestBody?: never;
|
|
1774
1796
|
responses: {
|
|
1775
|
-
/** @description
|
|
1797
|
+
/** @description no content */
|
|
1776
1798
|
200: {
|
|
1777
1799
|
headers: {
|
|
1778
1800
|
[name: string]: unknown;
|
|
1779
1801
|
};
|
|
1780
|
-
content
|
|
1781
|
-
"text/csv": unknown;
|
|
1782
|
-
"application/json": unknown;
|
|
1783
|
-
};
|
|
1802
|
+
content?: never;
|
|
1784
1803
|
};
|
|
1785
1804
|
/**
|
|
1786
1805
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1812,21 +1831,6 @@ interface paths {
|
|
|
1812
1831
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1813
1832
|
};
|
|
1814
1833
|
};
|
|
1815
|
-
/**
|
|
1816
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1817
|
-
*
|
|
1818
|
-
* This struct contains all the information needed to serialize an error
|
|
1819
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1820
|
-
* information, and user-friendly messages.
|
|
1821
|
-
*/
|
|
1822
|
-
403: {
|
|
1823
|
-
headers: {
|
|
1824
|
-
[name: string]: unknown;
|
|
1825
|
-
};
|
|
1826
|
-
content: {
|
|
1827
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1828
|
-
};
|
|
1829
|
-
};
|
|
1830
1834
|
/**
|
|
1831
1835
|
* @description HTTP error response representation with security-conscious design.
|
|
1832
1836
|
*
|
|
@@ -1844,15 +1848,13 @@ interface paths {
|
|
|
1844
1848
|
};
|
|
1845
1849
|
};
|
|
1846
1850
|
};
|
|
1847
|
-
put?: never;
|
|
1848
|
-
post?: never;
|
|
1849
1851
|
delete?: never;
|
|
1850
1852
|
options?: never;
|
|
1851
1853
|
head?: never;
|
|
1852
1854
|
patch?: never;
|
|
1853
1855
|
trace?: never;
|
|
1854
1856
|
};
|
|
1855
|
-
"/workspaces/{workspaceSlug}/
|
|
1857
|
+
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
1856
1858
|
parameters: {
|
|
1857
1859
|
query?: never;
|
|
1858
1860
|
header?: never;
|
|
@@ -1860,8 +1862,8 @@ interface paths {
|
|
|
1860
1862
|
cookie?: never;
|
|
1861
1863
|
};
|
|
1862
1864
|
/**
|
|
1863
|
-
*
|
|
1864
|
-
* @description Returns
|
|
1865
|
+
* Get member
|
|
1866
|
+
* @description Returns detailed information about a specific workspace member.
|
|
1865
1867
|
*/
|
|
1866
1868
|
get: {
|
|
1867
1869
|
parameters: {
|
|
@@ -1870,21 +1872,20 @@ interface paths {
|
|
|
1870
1872
|
path: {
|
|
1871
1873
|
/** @description URL-safe workspace identifier. */
|
|
1872
1874
|
workspaceSlug: string;
|
|
1875
|
+
/** @description Public handle of the member's account. */
|
|
1876
|
+
username: components["schemas"]["Handle"];
|
|
1873
1877
|
};
|
|
1874
1878
|
cookie?: never;
|
|
1875
1879
|
};
|
|
1876
1880
|
requestBody?: never;
|
|
1877
1881
|
responses: {
|
|
1878
|
-
/**
|
|
1879
|
-
* @description Aggregate analytics for a workspace: what it stores, how its detections fare, and
|
|
1880
|
-
* the inference tokens they spent.
|
|
1881
|
-
*/
|
|
1882
|
+
/** @description Represents a workspace member. */
|
|
1882
1883
|
200: {
|
|
1883
1884
|
headers: {
|
|
1884
1885
|
[name: string]: unknown;
|
|
1885
1886
|
};
|
|
1886
1887
|
content: {
|
|
1887
|
-
"application/json": components["schemas"]["
|
|
1888
|
+
"application/json": components["schemas"]["Member"];
|
|
1888
1889
|
};
|
|
1889
1890
|
};
|
|
1890
1891
|
/**
|
|
@@ -1936,55 +1937,30 @@ interface paths {
|
|
|
1936
1937
|
};
|
|
1937
1938
|
put?: never;
|
|
1938
1939
|
post?: never;
|
|
1939
|
-
delete?: never;
|
|
1940
|
-
options?: never;
|
|
1941
|
-
head?: never;
|
|
1942
|
-
patch?: never;
|
|
1943
|
-
trace?: never;
|
|
1944
|
-
};
|
|
1945
|
-
"/workspaces/{workspaceSlug}/analytics/detections/timeseries/": {
|
|
1946
|
-
parameters: {
|
|
1947
|
-
query?: never;
|
|
1948
|
-
header?: never;
|
|
1949
|
-
path?: never;
|
|
1950
|
-
cookie?: never;
|
|
1951
|
-
};
|
|
1952
1940
|
/**
|
|
1953
|
-
*
|
|
1954
|
-
* @description
|
|
1941
|
+
* Remove member
|
|
1942
|
+
* @description Permanently removes a member from the workspace. Cannot remove owners or yourself.
|
|
1955
1943
|
*/
|
|
1956
|
-
|
|
1944
|
+
delete: {
|
|
1957
1945
|
parameters: {
|
|
1958
|
-
query?:
|
|
1959
|
-
/**
|
|
1960
|
-
* @description First day of the range (inclusive), `YYYY-MM-DD`. Defaults so the range
|
|
1961
|
-
* spans the last `DEFAULT_WINDOW_DAYS` days through `to`.
|
|
1962
|
-
*/
|
|
1963
|
-
from?: string;
|
|
1964
|
-
/** @description Last day of the range (inclusive), `YYYY-MM-DD`. Defaults to today (UTC). */
|
|
1965
|
-
to?: string;
|
|
1966
|
-
};
|
|
1946
|
+
query?: never;
|
|
1967
1947
|
header?: never;
|
|
1968
1948
|
path: {
|
|
1969
1949
|
/** @description URL-safe workspace identifier. */
|
|
1970
1950
|
workspaceSlug: string;
|
|
1951
|
+
/** @description Public handle of the member's account. */
|
|
1952
|
+
username: components["schemas"]["Handle"];
|
|
1971
1953
|
};
|
|
1972
1954
|
cookie?: never;
|
|
1973
1955
|
};
|
|
1974
1956
|
requestBody?: never;
|
|
1975
1957
|
responses: {
|
|
1976
|
-
/**
|
|
1977
|
-
* @description A workspace's daily detection activity over a window: one point per day, dense
|
|
1978
|
-
* (quiet days included with `detections: 0`), ready to plot as a continuous
|
|
1979
|
-
* series.
|
|
1980
|
-
*/
|
|
1958
|
+
/** @description no content */
|
|
1981
1959
|
200: {
|
|
1982
1960
|
headers: {
|
|
1983
1961
|
[name: string]: unknown;
|
|
1984
1962
|
};
|
|
1985
|
-
content
|
|
1986
|
-
"application/json": components["schemas"]["DetectionTimeSeries"];
|
|
1987
|
-
};
|
|
1963
|
+
content?: never;
|
|
1988
1964
|
};
|
|
1989
1965
|
/**
|
|
1990
1966
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -2048,72 +2024,53 @@ interface paths {
|
|
|
2048
2024
|
};
|
|
2049
2025
|
};
|
|
2050
2026
|
};
|
|
2051
|
-
put?: never;
|
|
2052
|
-
post?: never;
|
|
2053
|
-
delete?: never;
|
|
2054
2027
|
options?: never;
|
|
2055
2028
|
head?: never;
|
|
2056
|
-
patch?: never;
|
|
2057
|
-
trace?: never;
|
|
2058
|
-
};
|
|
2059
|
-
"/workspaces/{workspaceSlug}/members/": {
|
|
2060
|
-
parameters: {
|
|
2061
|
-
query?: never;
|
|
2062
|
-
header?: never;
|
|
2063
|
-
path?: never;
|
|
2064
|
-
cookie?: never;
|
|
2065
|
-
};
|
|
2066
2029
|
/**
|
|
2067
|
-
*
|
|
2068
|
-
* @description
|
|
2030
|
+
* Update member role
|
|
2031
|
+
* @description Updates a workspace member's role. Cannot update your own role or demote owners.
|
|
2069
2032
|
*/
|
|
2070
|
-
|
|
2033
|
+
patch: {
|
|
2071
2034
|
parameters: {
|
|
2072
|
-
query?:
|
|
2073
|
-
/** @description Filter by 2FA status. */
|
|
2074
|
-
has2fa?: boolean;
|
|
2075
|
-
/** @description Sort order (asc or desc). */
|
|
2076
|
-
order?: components["schemas"]["SortOrder"];
|
|
2077
|
-
/** @description Filter by workspace role. */
|
|
2078
|
-
role?: components["schemas"]["WorkspaceRole"];
|
|
2079
|
-
/** @description Sort by field. */
|
|
2080
|
-
sortBy?: components["schemas"]["MemberSortField"];
|
|
2081
|
-
/**
|
|
2082
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
2083
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
2084
|
-
*/
|
|
2085
|
-
after?: string;
|
|
2086
|
-
/**
|
|
2087
|
-
* @description Whether to include the total item count in the response's `total` field.
|
|
2088
|
-
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2089
|
-
* only when the count is actually needed.
|
|
2090
|
-
*/
|
|
2091
|
-
includeCount?: boolean;
|
|
2092
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2093
|
-
limit?: number;
|
|
2094
|
-
};
|
|
2035
|
+
query?: never;
|
|
2095
2036
|
header?: never;
|
|
2096
2037
|
path: {
|
|
2097
2038
|
/** @description URL-safe workspace identifier. */
|
|
2098
2039
|
workspaceSlug: string;
|
|
2040
|
+
/** @description Public handle of the member's account. */
|
|
2041
|
+
username: components["schemas"]["Handle"];
|
|
2099
2042
|
};
|
|
2100
2043
|
cookie?: never;
|
|
2101
2044
|
};
|
|
2102
|
-
|
|
2045
|
+
/** @description Request to update a member's role. */
|
|
2046
|
+
requestBody: {
|
|
2047
|
+
content: {
|
|
2048
|
+
"application/json": components["schemas"]["UpdateMember"];
|
|
2049
|
+
};
|
|
2050
|
+
};
|
|
2103
2051
|
responses: {
|
|
2052
|
+
/** @description Represents a workspace member. */
|
|
2053
|
+
200: {
|
|
2054
|
+
headers: {
|
|
2055
|
+
[name: string]: unknown;
|
|
2056
|
+
};
|
|
2057
|
+
content: {
|
|
2058
|
+
"application/json": components["schemas"]["Member"];
|
|
2059
|
+
};
|
|
2060
|
+
};
|
|
2104
2061
|
/**
|
|
2105
|
-
* @description
|
|
2062
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2106
2063
|
*
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2064
|
+
* This struct contains all the information needed to serialize an error
|
|
2065
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2066
|
+
* information, and user-friendly messages.
|
|
2110
2067
|
*/
|
|
2111
|
-
|
|
2068
|
+
400: {
|
|
2112
2069
|
headers: {
|
|
2113
2070
|
[name: string]: unknown;
|
|
2114
2071
|
};
|
|
2115
2072
|
content: {
|
|
2116
|
-
"application/json": components["schemas"]["
|
|
2073
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2117
2074
|
};
|
|
2118
2075
|
};
|
|
2119
2076
|
/**
|
|
@@ -2161,32 +2118,61 @@ interface paths {
|
|
|
2161
2118
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2162
2119
|
};
|
|
2163
2120
|
};
|
|
2121
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2122
|
+
415: {
|
|
2123
|
+
headers: {
|
|
2124
|
+
[name: string]: unknown;
|
|
2125
|
+
};
|
|
2126
|
+
content: {
|
|
2127
|
+
"text/plain": string;
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2131
|
+
422: {
|
|
2132
|
+
headers: {
|
|
2133
|
+
[name: string]: unknown;
|
|
2134
|
+
};
|
|
2135
|
+
content: {
|
|
2136
|
+
"text/plain": string;
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2164
2139
|
};
|
|
2165
2140
|
};
|
|
2166
|
-
put?: never;
|
|
2167
|
-
post?: never;
|
|
2168
|
-
delete?: never;
|
|
2169
|
-
options?: never;
|
|
2170
|
-
head?: never;
|
|
2171
|
-
patch?: never;
|
|
2172
2141
|
trace?: never;
|
|
2173
2142
|
};
|
|
2174
|
-
"/workspaces/{workspaceSlug}/
|
|
2143
|
+
"/workspaces/{workspaceSlug}/connections/": {
|
|
2175
2144
|
parameters: {
|
|
2176
2145
|
query?: never;
|
|
2177
2146
|
header?: never;
|
|
2178
2147
|
path?: never;
|
|
2179
2148
|
cookie?: never;
|
|
2180
2149
|
};
|
|
2181
|
-
get?: never;
|
|
2182
|
-
put?: never;
|
|
2183
2150
|
/**
|
|
2184
|
-
*
|
|
2185
|
-
* @description
|
|
2151
|
+
* List connections
|
|
2152
|
+
* @description Returns all configured connections for the workspace. Only metadata is returned; encrypted credentials are never exposed.
|
|
2186
2153
|
*/
|
|
2187
|
-
|
|
2154
|
+
get: {
|
|
2188
2155
|
parameters: {
|
|
2189
|
-
query?:
|
|
2156
|
+
query?: {
|
|
2157
|
+
/**
|
|
2158
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2159
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2160
|
+
*/
|
|
2161
|
+
after?: string;
|
|
2162
|
+
/**
|
|
2163
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2164
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2165
|
+
* only when the count is actually needed.
|
|
2166
|
+
*/
|
|
2167
|
+
includeCount?: boolean;
|
|
2168
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2169
|
+
limit?: number;
|
|
2170
|
+
/**
|
|
2171
|
+
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
2172
|
+
* matches if it uses any of the given providers. Empty means no filter.
|
|
2173
|
+
*/
|
|
2174
|
+
provider?: string[];
|
|
2175
|
+
};
|
|
2190
2176
|
header?: never;
|
|
2191
2177
|
path: {
|
|
2192
2178
|
/** @description URL-safe workspace identifier. */
|
|
@@ -2196,26 +2182,19 @@ interface paths {
|
|
|
2196
2182
|
};
|
|
2197
2183
|
requestBody?: never;
|
|
2198
2184
|
responses: {
|
|
2199
|
-
/** @description no content */
|
|
2200
|
-
200: {
|
|
2201
|
-
headers: {
|
|
2202
|
-
[name: string]: unknown;
|
|
2203
|
-
};
|
|
2204
|
-
content?: never;
|
|
2205
|
-
};
|
|
2206
2185
|
/**
|
|
2207
|
-
* @description
|
|
2186
|
+
* @description Generic paginated response wrapper.
|
|
2208
2187
|
*
|
|
2209
|
-
*
|
|
2210
|
-
*
|
|
2211
|
-
*
|
|
2188
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2189
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2190
|
+
* are more items to fetch.
|
|
2212
2191
|
*/
|
|
2213
|
-
|
|
2192
|
+
200: {
|
|
2214
2193
|
headers: {
|
|
2215
2194
|
[name: string]: unknown;
|
|
2216
2195
|
};
|
|
2217
2196
|
content: {
|
|
2218
|
-
"application/json": components["schemas"]["
|
|
2197
|
+
"application/json": components["schemas"]["ConnectionPage"];
|
|
2219
2198
|
};
|
|
2220
2199
|
};
|
|
2221
2200
|
/**
|
|
@@ -2240,7 +2219,7 @@ interface paths {
|
|
|
2240
2219
|
* response, including the error name, message, HTTP status code, resource
|
|
2241
2220
|
* information, and user-friendly messages.
|
|
2242
2221
|
*/
|
|
2243
|
-
|
|
2222
|
+
403: {
|
|
2244
2223
|
headers: {
|
|
2245
2224
|
[name: string]: unknown;
|
|
2246
2225
|
};
|
|
@@ -2250,44 +2229,40 @@ interface paths {
|
|
|
2250
2229
|
};
|
|
2251
2230
|
};
|
|
2252
2231
|
};
|
|
2253
|
-
|
|
2254
|
-
options?: never;
|
|
2255
|
-
head?: never;
|
|
2256
|
-
patch?: never;
|
|
2257
|
-
trace?: never;
|
|
2258
|
-
};
|
|
2259
|
-
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
2260
|
-
parameters: {
|
|
2261
|
-
query?: never;
|
|
2262
|
-
header?: never;
|
|
2263
|
-
path?: never;
|
|
2264
|
-
cookie?: never;
|
|
2265
|
-
};
|
|
2232
|
+
put?: never;
|
|
2266
2233
|
/**
|
|
2267
|
-
*
|
|
2268
|
-
* @description
|
|
2234
|
+
* Create connection
|
|
2235
|
+
* @description Creates a new provider connection for the workspace. Connection data is encrypted and stored securely. The response includes connection metadata but never exposes the encrypted credentials.
|
|
2269
2236
|
*/
|
|
2270
|
-
|
|
2237
|
+
post: {
|
|
2271
2238
|
parameters: {
|
|
2272
2239
|
query?: never;
|
|
2273
2240
|
header?: never;
|
|
2274
2241
|
path: {
|
|
2275
2242
|
/** @description URL-safe workspace identifier. */
|
|
2276
2243
|
workspaceSlug: string;
|
|
2277
|
-
/** @description Public handle of the member's account. */
|
|
2278
|
-
username: components["schemas"]["Handle"];
|
|
2279
2244
|
};
|
|
2280
2245
|
cookie?: never;
|
|
2281
2246
|
};
|
|
2282
|
-
|
|
2247
|
+
/** @description Request payload for creating a new workspace connection. */
|
|
2248
|
+
requestBody: {
|
|
2249
|
+
content: {
|
|
2250
|
+
"application/json": components["schemas"]["CreateConnection"];
|
|
2251
|
+
};
|
|
2252
|
+
};
|
|
2283
2253
|
responses: {
|
|
2284
|
-
/**
|
|
2285
|
-
|
|
2254
|
+
/**
|
|
2255
|
+
* @description Response type for a workspace connection.
|
|
2256
|
+
*
|
|
2257
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2258
|
+
* Only metadata about the connection is returned.
|
|
2259
|
+
*/
|
|
2260
|
+
201: {
|
|
2286
2261
|
headers: {
|
|
2287
2262
|
[name: string]: unknown;
|
|
2288
2263
|
};
|
|
2289
2264
|
content: {
|
|
2290
|
-
"application/json": components["schemas"]["
|
|
2265
|
+
"application/json": components["schemas"]["Connection"];
|
|
2291
2266
|
};
|
|
2292
2267
|
};
|
|
2293
2268
|
/**
|
|
@@ -2297,7 +2272,7 @@ interface paths {
|
|
|
2297
2272
|
* response, including the error name, message, HTTP status code, resource
|
|
2298
2273
|
* information, and user-friendly messages.
|
|
2299
2274
|
*/
|
|
2300
|
-
|
|
2275
|
+
400: {
|
|
2301
2276
|
headers: {
|
|
2302
2277
|
[name: string]: unknown;
|
|
2303
2278
|
};
|
|
@@ -2312,7 +2287,7 @@ interface paths {
|
|
|
2312
2287
|
* response, including the error name, message, HTTP status code, resource
|
|
2313
2288
|
* information, and user-friendly messages.
|
|
2314
2289
|
*/
|
|
2315
|
-
|
|
2290
|
+
401: {
|
|
2316
2291
|
headers: {
|
|
2317
2292
|
[name: string]: unknown;
|
|
2318
2293
|
};
|
|
@@ -2327,7 +2302,7 @@ interface paths {
|
|
|
2327
2302
|
* response, including the error name, message, HTTP status code, resource
|
|
2328
2303
|
* information, and user-friendly messages.
|
|
2329
2304
|
*/
|
|
2330
|
-
|
|
2305
|
+
403: {
|
|
2331
2306
|
headers: {
|
|
2332
2307
|
[name: string]: unknown;
|
|
2333
2308
|
};
|
|
@@ -2335,34 +2310,70 @@ interface paths {
|
|
|
2335
2310
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2336
2311
|
};
|
|
2337
2312
|
};
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2313
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2314
|
+
415: {
|
|
2315
|
+
headers: {
|
|
2316
|
+
[name: string]: unknown;
|
|
2317
|
+
};
|
|
2318
|
+
content: {
|
|
2319
|
+
"text/plain": string;
|
|
2320
|
+
};
|
|
2321
|
+
};
|
|
2322
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2323
|
+
422: {
|
|
2324
|
+
headers: {
|
|
2325
|
+
[name: string]: unknown;
|
|
2326
|
+
};
|
|
2327
|
+
content: {
|
|
2328
|
+
"text/plain": string;
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
};
|
|
2332
|
+
};
|
|
2333
|
+
delete?: never;
|
|
2334
|
+
options?: never;
|
|
2335
|
+
head?: never;
|
|
2336
|
+
patch?: never;
|
|
2337
|
+
trace?: never;
|
|
2338
|
+
};
|
|
2339
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
2340
|
+
parameters: {
|
|
2341
|
+
query?: never;
|
|
2342
|
+
header?: never;
|
|
2343
|
+
path?: never;
|
|
2344
|
+
cookie?: never;
|
|
2345
|
+
};
|
|
2346
|
+
/**
|
|
2347
|
+
* Get connection
|
|
2348
|
+
* @description Returns connection metadata without encrypted credentials.
|
|
2349
|
+
*/
|
|
2350
|
+
get: {
|
|
2351
|
+
parameters: {
|
|
2352
|
+
query?: never;
|
|
2353
|
+
header?: never;
|
|
2354
|
+
path: {
|
|
2355
|
+
/** @description URL-safe workspace identifier. */
|
|
2356
|
+
workspaceSlug: string;
|
|
2357
|
+
/** @description Opaque identifier of the connection. */
|
|
2358
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2355
2359
|
};
|
|
2356
2360
|
cookie?: never;
|
|
2357
2361
|
};
|
|
2358
2362
|
requestBody?: never;
|
|
2359
2363
|
responses: {
|
|
2360
|
-
/**
|
|
2364
|
+
/**
|
|
2365
|
+
* @description Response type for a workspace connection.
|
|
2366
|
+
*
|
|
2367
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2368
|
+
* Only metadata about the connection is returned.
|
|
2369
|
+
*/
|
|
2361
2370
|
200: {
|
|
2362
2371
|
headers: {
|
|
2363
2372
|
[name: string]: unknown;
|
|
2364
2373
|
};
|
|
2365
|
-
content
|
|
2374
|
+
content: {
|
|
2375
|
+
"application/json": components["schemas"]["Connection"];
|
|
2376
|
+
};
|
|
2366
2377
|
};
|
|
2367
2378
|
/**
|
|
2368
2379
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -2371,7 +2382,37 @@ interface paths {
|
|
|
2371
2382
|
* response, including the error name, message, HTTP status code, resource
|
|
2372
2383
|
* information, and user-friendly messages.
|
|
2373
2384
|
*/
|
|
2374
|
-
|
|
2385
|
+
401: {
|
|
2386
|
+
headers: {
|
|
2387
|
+
[name: string]: unknown;
|
|
2388
|
+
};
|
|
2389
|
+
content: {
|
|
2390
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
/**
|
|
2394
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2395
|
+
*
|
|
2396
|
+
* This struct contains all the information needed to serialize an error
|
|
2397
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2398
|
+
* information, and user-friendly messages.
|
|
2399
|
+
*/
|
|
2400
|
+
403: {
|
|
2401
|
+
headers: {
|
|
2402
|
+
[name: string]: unknown;
|
|
2403
|
+
};
|
|
2404
|
+
content: {
|
|
2405
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2406
|
+
};
|
|
2407
|
+
};
|
|
2408
|
+
/**
|
|
2409
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2410
|
+
*
|
|
2411
|
+
* This struct contains all the information needed to serialize an error
|
|
2412
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2413
|
+
* information, and user-friendly messages.
|
|
2414
|
+
*/
|
|
2415
|
+
404: {
|
|
2375
2416
|
headers: {
|
|
2376
2417
|
[name: string]: unknown;
|
|
2377
2418
|
};
|
|
@@ -2379,6 +2420,35 @@ interface paths {
|
|
|
2379
2420
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2380
2421
|
};
|
|
2381
2422
|
};
|
|
2423
|
+
};
|
|
2424
|
+
};
|
|
2425
|
+
put?: never;
|
|
2426
|
+
post?: never;
|
|
2427
|
+
/**
|
|
2428
|
+
* Delete connection
|
|
2429
|
+
* @description Soft-deletes the connection from the workspace.
|
|
2430
|
+
*/
|
|
2431
|
+
delete: {
|
|
2432
|
+
parameters: {
|
|
2433
|
+
query?: never;
|
|
2434
|
+
header?: never;
|
|
2435
|
+
path: {
|
|
2436
|
+
/** @description URL-safe workspace identifier. */
|
|
2437
|
+
workspaceSlug: string;
|
|
2438
|
+
/** @description Opaque identifier of the connection. */
|
|
2439
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2440
|
+
};
|
|
2441
|
+
cookie?: never;
|
|
2442
|
+
};
|
|
2443
|
+
requestBody?: never;
|
|
2444
|
+
responses: {
|
|
2445
|
+
/** @description no content */
|
|
2446
|
+
204: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content?: never;
|
|
2451
|
+
};
|
|
2382
2452
|
/**
|
|
2383
2453
|
* @description HTTP error response representation with security-conscious design.
|
|
2384
2454
|
*
|
|
@@ -2429,8 +2499,8 @@ interface paths {
|
|
|
2429
2499
|
options?: never;
|
|
2430
2500
|
head?: never;
|
|
2431
2501
|
/**
|
|
2432
|
-
* Update
|
|
2433
|
-
* @description Updates
|
|
2502
|
+
* Update connection
|
|
2503
|
+
* @description Updates connection name or encrypted data.
|
|
2434
2504
|
*/
|
|
2435
2505
|
patch: {
|
|
2436
2506
|
parameters: {
|
|
@@ -2439,25 +2509,30 @@ interface paths {
|
|
|
2439
2509
|
path: {
|
|
2440
2510
|
/** @description URL-safe workspace identifier. */
|
|
2441
2511
|
workspaceSlug: string;
|
|
2442
|
-
/** @description
|
|
2443
|
-
|
|
2512
|
+
/** @description Opaque identifier of the connection. */
|
|
2513
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2444
2514
|
};
|
|
2445
2515
|
cookie?: never;
|
|
2446
2516
|
};
|
|
2447
|
-
/** @description Request
|
|
2517
|
+
/** @description Request payload for updating an existing workspace connection. */
|
|
2448
2518
|
requestBody: {
|
|
2449
2519
|
content: {
|
|
2450
|
-
"application/json": components["schemas"]["
|
|
2520
|
+
"application/json": components["schemas"]["UpdateConnection"];
|
|
2451
2521
|
};
|
|
2452
2522
|
};
|
|
2453
2523
|
responses: {
|
|
2454
|
-
/**
|
|
2524
|
+
/**
|
|
2525
|
+
* @description Response type for a workspace connection.
|
|
2526
|
+
*
|
|
2527
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
2528
|
+
* Only metadata about the connection is returned.
|
|
2529
|
+
*/
|
|
2455
2530
|
200: {
|
|
2456
2531
|
headers: {
|
|
2457
2532
|
[name: string]: unknown;
|
|
2458
2533
|
};
|
|
2459
2534
|
content: {
|
|
2460
|
-
"application/json": components["schemas"]["
|
|
2535
|
+
"application/json": components["schemas"]["Connection"];
|
|
2461
2536
|
};
|
|
2462
2537
|
};
|
|
2463
2538
|
/**
|
|
@@ -2542,61 +2617,40 @@ interface paths {
|
|
|
2542
2617
|
};
|
|
2543
2618
|
trace?: never;
|
|
2544
2619
|
};
|
|
2545
|
-
"/workspaces/{workspaceSlug}/connections/": {
|
|
2620
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
|
|
2546
2621
|
parameters: {
|
|
2547
2622
|
query?: never;
|
|
2548
2623
|
header?: never;
|
|
2549
2624
|
path?: never;
|
|
2550
2625
|
cookie?: never;
|
|
2551
2626
|
};
|
|
2627
|
+
get?: never;
|
|
2628
|
+
put?: never;
|
|
2552
2629
|
/**
|
|
2553
|
-
*
|
|
2554
|
-
* @description
|
|
2630
|
+
* Verify connection
|
|
2631
|
+
* @description Checks whether the connection's backing store is reachable with its stored credentials.
|
|
2555
2632
|
*/
|
|
2556
|
-
|
|
2633
|
+
post: {
|
|
2557
2634
|
parameters: {
|
|
2558
|
-
query?:
|
|
2559
|
-
/**
|
|
2560
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
2561
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
2562
|
-
*/
|
|
2563
|
-
after?: string;
|
|
2564
|
-
/**
|
|
2565
|
-
* @description Whether to include the total item count in the response's `total` field.
|
|
2566
|
-
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2567
|
-
* only when the count is actually needed.
|
|
2568
|
-
*/
|
|
2569
|
-
includeCount?: boolean;
|
|
2570
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2571
|
-
limit?: number;
|
|
2572
|
-
/**
|
|
2573
|
-
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
2574
|
-
* matches if it uses any of the given providers. Empty means no filter.
|
|
2575
|
-
*/
|
|
2576
|
-
provider?: string[];
|
|
2577
|
-
};
|
|
2635
|
+
query?: never;
|
|
2578
2636
|
header?: never;
|
|
2579
2637
|
path: {
|
|
2580
2638
|
/** @description URL-safe workspace identifier. */
|
|
2581
2639
|
workspaceSlug: string;
|
|
2640
|
+
/** @description Opaque identifier of the connection. */
|
|
2641
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2582
2642
|
};
|
|
2583
2643
|
cookie?: never;
|
|
2584
2644
|
};
|
|
2585
2645
|
requestBody?: never;
|
|
2586
2646
|
responses: {
|
|
2587
|
-
/**
|
|
2588
|
-
* @description Generic paginated response wrapper.
|
|
2589
|
-
*
|
|
2590
|
-
* Provides a consistent structure for all paginated API responses with
|
|
2591
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2592
|
-
* are more items to fetch.
|
|
2593
|
-
*/
|
|
2647
|
+
/** @description Result of a connection reachability check. */
|
|
2594
2648
|
200: {
|
|
2595
2649
|
headers: {
|
|
2596
2650
|
[name: string]: unknown;
|
|
2597
2651
|
};
|
|
2598
2652
|
content: {
|
|
2599
|
-
"application/json": components["schemas"]["
|
|
2653
|
+
"application/json": components["schemas"]["ConnectionVerification"];
|
|
2600
2654
|
};
|
|
2601
2655
|
};
|
|
2602
2656
|
/**
|
|
@@ -2629,12 +2683,41 @@ interface paths {
|
|
|
2629
2683
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2630
2684
|
};
|
|
2631
2685
|
};
|
|
2686
|
+
/**
|
|
2687
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2688
|
+
*
|
|
2689
|
+
* This struct contains all the information needed to serialize an error
|
|
2690
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2691
|
+
* information, and user-friendly messages.
|
|
2692
|
+
*/
|
|
2693
|
+
404: {
|
|
2694
|
+
headers: {
|
|
2695
|
+
[name: string]: unknown;
|
|
2696
|
+
};
|
|
2697
|
+
content: {
|
|
2698
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2699
|
+
};
|
|
2700
|
+
};
|
|
2632
2701
|
};
|
|
2633
2702
|
};
|
|
2703
|
+
delete?: never;
|
|
2704
|
+
options?: never;
|
|
2705
|
+
head?: never;
|
|
2706
|
+
patch?: never;
|
|
2707
|
+
trace?: never;
|
|
2708
|
+
};
|
|
2709
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/picker-token/": {
|
|
2710
|
+
parameters: {
|
|
2711
|
+
query?: never;
|
|
2712
|
+
header?: never;
|
|
2713
|
+
path?: never;
|
|
2714
|
+
cookie?: never;
|
|
2715
|
+
};
|
|
2716
|
+
get?: never;
|
|
2634
2717
|
put?: never;
|
|
2635
2718
|
/**
|
|
2636
|
-
*
|
|
2637
|
-
* @description
|
|
2719
|
+
* Mint picker token
|
|
2720
|
+
* @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. An optional body `{ resource }` names the resource the picker requested (used by the OneDrive picker, which requires a SharePoint-audience token); providers whose picker takes a single token ignore it. The OneDrive picker is available only for work or school (OneDrive for Business) accounts.
|
|
2638
2721
|
*/
|
|
2639
2722
|
post: {
|
|
2640
2723
|
parameters: {
|
|
@@ -2643,28 +2726,39 @@ interface paths {
|
|
|
2643
2726
|
path: {
|
|
2644
2727
|
/** @description URL-safe workspace identifier. */
|
|
2645
2728
|
workspaceSlug: string;
|
|
2729
|
+
/** @description Opaque identifier of the connection. */
|
|
2730
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2646
2731
|
};
|
|
2647
2732
|
cookie?: never;
|
|
2648
2733
|
};
|
|
2649
|
-
/**
|
|
2734
|
+
/**
|
|
2735
|
+
* @description Body for minting a browser file-picker token.
|
|
2736
|
+
*
|
|
2737
|
+
* The OneDrive v8 picker requests a token per resource (it names the resource in
|
|
2738
|
+
* each `authenticate` command); the caller passes that `resource` so the server
|
|
2739
|
+
* mints a token scoped to exactly it. Ignored by providers whose picker takes a
|
|
2740
|
+
* single provider token (Google Drive, Box); omit it for those.
|
|
2741
|
+
*/
|
|
2650
2742
|
requestBody: {
|
|
2651
2743
|
content: {
|
|
2652
|
-
"application/json": components["schemas"]["
|
|
2744
|
+
"application/json": components["schemas"]["PickerTokenRequest"];
|
|
2653
2745
|
};
|
|
2654
2746
|
};
|
|
2655
2747
|
responses: {
|
|
2656
2748
|
/**
|
|
2657
|
-
* @description
|
|
2749
|
+
* @description A short-lived provider OAuth access token for a browser file picker.
|
|
2658
2750
|
*
|
|
2659
|
-
*
|
|
2660
|
-
*
|
|
2751
|
+
* Carries only the access token and its expiry — never the refresh token, which
|
|
2752
|
+
* stays server-side. The token is minted from the connection's stored
|
|
2753
|
+
* credentials and is short-lived (the provider's access-token lifetime), so the
|
|
2754
|
+
* browser holds a narrow, expiring credential rather than a durable one.
|
|
2661
2755
|
*/
|
|
2662
|
-
|
|
2756
|
+
200: {
|
|
2663
2757
|
headers: {
|
|
2664
2758
|
[name: string]: unknown;
|
|
2665
2759
|
};
|
|
2666
2760
|
content: {
|
|
2667
|
-
"application/json": components["schemas"]["
|
|
2761
|
+
"application/json": components["schemas"]["PickerToken"];
|
|
2668
2762
|
};
|
|
2669
2763
|
};
|
|
2670
2764
|
/**
|
|
@@ -2712,22 +2806,19 @@ interface paths {
|
|
|
2712
2806
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2713
2807
|
};
|
|
2714
2808
|
};
|
|
2715
|
-
/**
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
};
|
|
2724
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
2725
|
-
422: {
|
|
2809
|
+
/**
|
|
2810
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2811
|
+
*
|
|
2812
|
+
* This struct contains all the information needed to serialize an error
|
|
2813
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2814
|
+
* information, and user-friendly messages.
|
|
2815
|
+
*/
|
|
2816
|
+
404: {
|
|
2726
2817
|
headers: {
|
|
2727
2818
|
[name: string]: unknown;
|
|
2728
2819
|
};
|
|
2729
2820
|
content: {
|
|
2730
|
-
"
|
|
2821
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2731
2822
|
};
|
|
2732
2823
|
};
|
|
2733
2824
|
};
|
|
@@ -2738,7 +2829,7 @@ interface paths {
|
|
|
2738
2829
|
patch?: never;
|
|
2739
2830
|
trace?: never;
|
|
2740
2831
|
};
|
|
2741
|
-
"/workspaces/{workspaceSlug}/
|
|
2832
|
+
"/workspaces/{workspaceSlug}/providers/": {
|
|
2742
2833
|
parameters: {
|
|
2743
2834
|
query?: never;
|
|
2744
2835
|
header?: never;
|
|
@@ -2746,35 +2837,232 @@ interface paths {
|
|
|
2746
2837
|
cookie?: never;
|
|
2747
2838
|
};
|
|
2748
2839
|
/**
|
|
2749
|
-
*
|
|
2750
|
-
* @description Returns
|
|
2840
|
+
* List providers
|
|
2841
|
+
* @description Returns all configured inference providers for the workspace. Only metadata is returned; encrypted credentials are never exposed.
|
|
2751
2842
|
*/
|
|
2752
2843
|
get: {
|
|
2844
|
+
parameters: {
|
|
2845
|
+
query?: {
|
|
2846
|
+
/**
|
|
2847
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2848
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2849
|
+
*/
|
|
2850
|
+
after?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
2853
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
2854
|
+
* only when the count is actually needed.
|
|
2855
|
+
*/
|
|
2856
|
+
includeCount?: boolean;
|
|
2857
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2858
|
+
limit?: number;
|
|
2859
|
+
/**
|
|
2860
|
+
* @description Filter by provider (`openai`, `ollama`, `anthropic`). Repeatable; a
|
|
2861
|
+
* provider matches if it uses any of the given providers. Empty means no
|
|
2862
|
+
* filter.
|
|
2863
|
+
*/
|
|
2864
|
+
provider?: string[];
|
|
2865
|
+
};
|
|
2866
|
+
header?: never;
|
|
2867
|
+
path: {
|
|
2868
|
+
/** @description URL-safe workspace identifier. */
|
|
2869
|
+
workspaceSlug: string;
|
|
2870
|
+
};
|
|
2871
|
+
cookie?: never;
|
|
2872
|
+
};
|
|
2873
|
+
requestBody?: never;
|
|
2874
|
+
responses: {
|
|
2875
|
+
/**
|
|
2876
|
+
* @description Generic paginated response wrapper.
|
|
2877
|
+
*
|
|
2878
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2879
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2880
|
+
* are more items to fetch.
|
|
2881
|
+
*/
|
|
2882
|
+
200: {
|
|
2883
|
+
headers: {
|
|
2884
|
+
[name: string]: unknown;
|
|
2885
|
+
};
|
|
2886
|
+
content: {
|
|
2887
|
+
"application/json": components["schemas"]["ProviderPage"];
|
|
2888
|
+
};
|
|
2889
|
+
};
|
|
2890
|
+
/**
|
|
2891
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2892
|
+
*
|
|
2893
|
+
* This struct contains all the information needed to serialize an error
|
|
2894
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2895
|
+
* information, and user-friendly messages.
|
|
2896
|
+
*/
|
|
2897
|
+
401: {
|
|
2898
|
+
headers: {
|
|
2899
|
+
[name: string]: unknown;
|
|
2900
|
+
};
|
|
2901
|
+
content: {
|
|
2902
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2903
|
+
};
|
|
2904
|
+
};
|
|
2905
|
+
/**
|
|
2906
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2907
|
+
*
|
|
2908
|
+
* This struct contains all the information needed to serialize an error
|
|
2909
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2910
|
+
* information, and user-friendly messages.
|
|
2911
|
+
*/
|
|
2912
|
+
403: {
|
|
2913
|
+
headers: {
|
|
2914
|
+
[name: string]: unknown;
|
|
2915
|
+
};
|
|
2916
|
+
content: {
|
|
2917
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
};
|
|
2921
|
+
};
|
|
2922
|
+
put?: never;
|
|
2923
|
+
/**
|
|
2924
|
+
* Create provider
|
|
2925
|
+
* @description Creates a new inference provider for the workspace. Provider data is encrypted and stored securely. The response includes provider metadata but never exposes the encrypted credentials.
|
|
2926
|
+
*/
|
|
2927
|
+
post: {
|
|
2753
2928
|
parameters: {
|
|
2754
2929
|
query?: never;
|
|
2755
2930
|
header?: never;
|
|
2756
2931
|
path: {
|
|
2757
2932
|
/** @description URL-safe workspace identifier. */
|
|
2758
2933
|
workspaceSlug: string;
|
|
2759
|
-
|
|
2760
|
-
|
|
2934
|
+
};
|
|
2935
|
+
cookie?: never;
|
|
2936
|
+
};
|
|
2937
|
+
/** @description Request payload for creating a new workspace provider. */
|
|
2938
|
+
requestBody: {
|
|
2939
|
+
content: {
|
|
2940
|
+
"application/json": components["schemas"]["CreateProvider"];
|
|
2941
|
+
};
|
|
2942
|
+
};
|
|
2943
|
+
responses: {
|
|
2944
|
+
/**
|
|
2945
|
+
* @description Response type for a workspace inference provider.
|
|
2946
|
+
*
|
|
2947
|
+
* Note: The encrypted provider data is never exposed in API responses. Only
|
|
2948
|
+
* metadata about the provider is returned.
|
|
2949
|
+
*/
|
|
2950
|
+
201: {
|
|
2951
|
+
headers: {
|
|
2952
|
+
[name: string]: unknown;
|
|
2953
|
+
};
|
|
2954
|
+
content: {
|
|
2955
|
+
"application/json": components["schemas"]["Provider"];
|
|
2956
|
+
};
|
|
2957
|
+
};
|
|
2958
|
+
/**
|
|
2959
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2960
|
+
*
|
|
2961
|
+
* This struct contains all the information needed to serialize an error
|
|
2962
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2963
|
+
* information, and user-friendly messages.
|
|
2964
|
+
*/
|
|
2965
|
+
400: {
|
|
2966
|
+
headers: {
|
|
2967
|
+
[name: string]: unknown;
|
|
2968
|
+
};
|
|
2969
|
+
content: {
|
|
2970
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2971
|
+
};
|
|
2972
|
+
};
|
|
2973
|
+
/**
|
|
2974
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2975
|
+
*
|
|
2976
|
+
* This struct contains all the information needed to serialize an error
|
|
2977
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2978
|
+
* information, and user-friendly messages.
|
|
2979
|
+
*/
|
|
2980
|
+
401: {
|
|
2981
|
+
headers: {
|
|
2982
|
+
[name: string]: unknown;
|
|
2983
|
+
};
|
|
2984
|
+
content: {
|
|
2985
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2986
|
+
};
|
|
2987
|
+
};
|
|
2988
|
+
/**
|
|
2989
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2990
|
+
*
|
|
2991
|
+
* This struct contains all the information needed to serialize an error
|
|
2992
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2993
|
+
* information, and user-friendly messages.
|
|
2994
|
+
*/
|
|
2995
|
+
403: {
|
|
2996
|
+
headers: {
|
|
2997
|
+
[name: string]: unknown;
|
|
2998
|
+
};
|
|
2999
|
+
content: {
|
|
3000
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3001
|
+
};
|
|
3002
|
+
};
|
|
3003
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3004
|
+
415: {
|
|
3005
|
+
headers: {
|
|
3006
|
+
[name: string]: unknown;
|
|
3007
|
+
};
|
|
3008
|
+
content: {
|
|
3009
|
+
"text/plain": string;
|
|
3010
|
+
};
|
|
3011
|
+
};
|
|
3012
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
3013
|
+
422: {
|
|
3014
|
+
headers: {
|
|
3015
|
+
[name: string]: unknown;
|
|
3016
|
+
};
|
|
3017
|
+
content: {
|
|
3018
|
+
"text/plain": string;
|
|
3019
|
+
};
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
delete?: never;
|
|
3024
|
+
options?: never;
|
|
3025
|
+
head?: never;
|
|
3026
|
+
patch?: never;
|
|
3027
|
+
trace?: never;
|
|
3028
|
+
};
|
|
3029
|
+
"/workspaces/{workspaceSlug}/providers/{providerId}/": {
|
|
3030
|
+
parameters: {
|
|
3031
|
+
query?: never;
|
|
3032
|
+
header?: never;
|
|
3033
|
+
path?: never;
|
|
3034
|
+
cookie?: never;
|
|
3035
|
+
};
|
|
3036
|
+
/**
|
|
3037
|
+
* Get provider
|
|
3038
|
+
* @description Returns provider metadata without encrypted credentials.
|
|
3039
|
+
*/
|
|
3040
|
+
get: {
|
|
3041
|
+
parameters: {
|
|
3042
|
+
query?: never;
|
|
3043
|
+
header?: never;
|
|
3044
|
+
path: {
|
|
3045
|
+
/** @description URL-safe workspace identifier. */
|
|
3046
|
+
workspaceSlug: string;
|
|
3047
|
+
/** @description Opaque identifier of the provider. */
|
|
3048
|
+
providerId: components["schemas"]["ProviderId"];
|
|
2761
3049
|
};
|
|
2762
3050
|
cookie?: never;
|
|
2763
3051
|
};
|
|
2764
3052
|
requestBody?: never;
|
|
2765
3053
|
responses: {
|
|
2766
3054
|
/**
|
|
2767
|
-
* @description Response type for a workspace
|
|
3055
|
+
* @description Response type for a workspace inference provider.
|
|
2768
3056
|
*
|
|
2769
|
-
* Note: The encrypted
|
|
2770
|
-
*
|
|
3057
|
+
* Note: The encrypted provider data is never exposed in API responses. Only
|
|
3058
|
+
* metadata about the provider is returned.
|
|
2771
3059
|
*/
|
|
2772
3060
|
200: {
|
|
2773
3061
|
headers: {
|
|
2774
3062
|
[name: string]: unknown;
|
|
2775
3063
|
};
|
|
2776
3064
|
content: {
|
|
2777
|
-
"application/json": components["schemas"]["
|
|
3065
|
+
"application/json": components["schemas"]["Provider"];
|
|
2778
3066
|
};
|
|
2779
3067
|
};
|
|
2780
3068
|
/**
|
|
@@ -2827,8 +3115,8 @@ interface paths {
|
|
|
2827
3115
|
put?: never;
|
|
2828
3116
|
post?: never;
|
|
2829
3117
|
/**
|
|
2830
|
-
* Delete
|
|
2831
|
-
* @description Soft-deletes the
|
|
3118
|
+
* Delete provider
|
|
3119
|
+
* @description Soft-deletes the provider from the workspace.
|
|
2832
3120
|
*/
|
|
2833
3121
|
delete: {
|
|
2834
3122
|
parameters: {
|
|
@@ -2837,8 +3125,8 @@ interface paths {
|
|
|
2837
3125
|
path: {
|
|
2838
3126
|
/** @description URL-safe workspace identifier. */
|
|
2839
3127
|
workspaceSlug: string;
|
|
2840
|
-
/** @description Opaque identifier of the
|
|
2841
|
-
|
|
3128
|
+
/** @description Opaque identifier of the provider. */
|
|
3129
|
+
providerId: components["schemas"]["ProviderId"];
|
|
2842
3130
|
};
|
|
2843
3131
|
cookie?: never;
|
|
2844
3132
|
};
|
|
@@ -2901,8 +3189,8 @@ interface paths {
|
|
|
2901
3189
|
options?: never;
|
|
2902
3190
|
head?: never;
|
|
2903
3191
|
/**
|
|
2904
|
-
* Update
|
|
2905
|
-
* @description Updates
|
|
3192
|
+
* Update provider
|
|
3193
|
+
* @description Updates provider name or encrypted data.
|
|
2906
3194
|
*/
|
|
2907
3195
|
patch: {
|
|
2908
3196
|
parameters: {
|
|
@@ -2911,30 +3199,30 @@ interface paths {
|
|
|
2911
3199
|
path: {
|
|
2912
3200
|
/** @description URL-safe workspace identifier. */
|
|
2913
3201
|
workspaceSlug: string;
|
|
2914
|
-
/** @description Opaque identifier of the
|
|
2915
|
-
|
|
3202
|
+
/** @description Opaque identifier of the provider. */
|
|
3203
|
+
providerId: components["schemas"]["ProviderId"];
|
|
2916
3204
|
};
|
|
2917
3205
|
cookie?: never;
|
|
2918
3206
|
};
|
|
2919
|
-
/** @description Request payload for updating an existing workspace
|
|
3207
|
+
/** @description Request payload for updating an existing workspace provider. */
|
|
2920
3208
|
requestBody: {
|
|
2921
3209
|
content: {
|
|
2922
|
-
"application/json": components["schemas"]["
|
|
3210
|
+
"application/json": components["schemas"]["UpdateProvider"];
|
|
2923
3211
|
};
|
|
2924
3212
|
};
|
|
2925
3213
|
responses: {
|
|
2926
3214
|
/**
|
|
2927
|
-
* @description Response type for a workspace
|
|
3215
|
+
* @description Response type for a workspace inference provider.
|
|
2928
3216
|
*
|
|
2929
|
-
* Note: The encrypted
|
|
2930
|
-
*
|
|
3217
|
+
* Note: The encrypted provider data is never exposed in API responses. Only
|
|
3218
|
+
* metadata about the provider is returned.
|
|
2931
3219
|
*/
|
|
2932
3220
|
200: {
|
|
2933
3221
|
headers: {
|
|
2934
3222
|
[name: string]: unknown;
|
|
2935
3223
|
};
|
|
2936
3224
|
content: {
|
|
2937
|
-
"application/json": components["schemas"]["
|
|
3225
|
+
"application/json": components["schemas"]["Provider"];
|
|
2938
3226
|
};
|
|
2939
3227
|
};
|
|
2940
3228
|
/**
|
|
@@ -3019,7 +3307,7 @@ interface paths {
|
|
|
3019
3307
|
};
|
|
3020
3308
|
trace?: never;
|
|
3021
3309
|
};
|
|
3022
|
-
"/workspaces/{workspaceSlug}/
|
|
3310
|
+
"/workspaces/{workspaceSlug}/providers/{providerId}/verify/": {
|
|
3023
3311
|
parameters: {
|
|
3024
3312
|
query?: never;
|
|
3025
3313
|
header?: never;
|
|
@@ -3029,8 +3317,8 @@ interface paths {
|
|
|
3029
3317
|
get?: never;
|
|
3030
3318
|
put?: never;
|
|
3031
3319
|
/**
|
|
3032
|
-
* Verify
|
|
3033
|
-
* @description Checks whether the
|
|
3320
|
+
* Verify provider
|
|
3321
|
+
* @description Checks whether the provider is reachable with its stored credentials.
|
|
3034
3322
|
*/
|
|
3035
3323
|
post: {
|
|
3036
3324
|
parameters: {
|
|
@@ -3039,8 +3327,8 @@ interface paths {
|
|
|
3039
3327
|
path: {
|
|
3040
3328
|
/** @description URL-safe workspace identifier. */
|
|
3041
3329
|
workspaceSlug: string;
|
|
3042
|
-
/** @description Opaque identifier of the
|
|
3043
|
-
|
|
3330
|
+
/** @description Opaque identifier of the provider. */
|
|
3331
|
+
providerId: components["schemas"]["ProviderId"];
|
|
3044
3332
|
};
|
|
3045
3333
|
cookie?: never;
|
|
3046
3334
|
};
|
|
@@ -3108,7 +3396,7 @@ interface paths {
|
|
|
3108
3396
|
patch?: never;
|
|
3109
3397
|
trace?: never;
|
|
3110
3398
|
};
|
|
3111
|
-
"/workspaces/{workspaceSlug}/connections/{
|
|
3399
|
+
"/workspaces/{workspaceSlug}/connections/oauth/{provider}/start/": {
|
|
3112
3400
|
parameters: {
|
|
3113
3401
|
query?: never;
|
|
3114
3402
|
header?: never;
|
|
@@ -3118,8 +3406,8 @@ interface paths {
|
|
|
3118
3406
|
get?: never;
|
|
3119
3407
|
put?: never;
|
|
3120
3408
|
/**
|
|
3121
|
-
*
|
|
3122
|
-
* @description
|
|
3409
|
+
* Start cloud file OAuth
|
|
3410
|
+
* @description Begins the OAuth authorization for a cloud file-service connection and returns the provider authorize URL to redirect the user to. On the user's consent, the provider redirects to the callback, which creates the connection.
|
|
3123
3411
|
*/
|
|
3124
3412
|
post: {
|
|
3125
3413
|
parameters: {
|
|
@@ -3128,42 +3416,34 @@ interface paths {
|
|
|
3128
3416
|
path: {
|
|
3129
3417
|
/** @description URL-safe workspace identifier. */
|
|
3130
3418
|
workspaceSlug: string;
|
|
3131
|
-
/** @description
|
|
3132
|
-
|
|
3419
|
+
/** @description The cloud file provider to connect. */
|
|
3420
|
+
provider: components["schemas"]["FileServiceProvider"];
|
|
3133
3421
|
};
|
|
3134
3422
|
cookie?: never;
|
|
3135
3423
|
};
|
|
3136
|
-
|
|
3424
|
+
/** @description Request payload for starting a cloud file-service OAuth authorization. */
|
|
3425
|
+
requestBody: {
|
|
3426
|
+
content: {
|
|
3427
|
+
"application/json": components["schemas"]["StartFileServiceOAuth"];
|
|
3428
|
+
};
|
|
3429
|
+
};
|
|
3137
3430
|
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
|
-
*/
|
|
3431
|
+
/** @description The response to a successful authorization start: where to send the user. */
|
|
3146
3432
|
200: {
|
|
3147
3433
|
headers: {
|
|
3148
3434
|
[name: string]: unknown;
|
|
3149
3435
|
};
|
|
3150
3436
|
content: {
|
|
3151
|
-
"application/json": components["schemas"]["
|
|
3437
|
+
"application/json": components["schemas"]["OAuthStartResponse"];
|
|
3152
3438
|
};
|
|
3153
3439
|
};
|
|
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
|
-
*/
|
|
3440
|
+
/** @description Failed to parse the request body as JSON */
|
|
3161
3441
|
400: {
|
|
3162
3442
|
headers: {
|
|
3163
3443
|
[name: string]: unknown;
|
|
3164
3444
|
};
|
|
3165
3445
|
content: {
|
|
3166
|
-
"
|
|
3446
|
+
"text/plain": string;
|
|
3167
3447
|
};
|
|
3168
3448
|
};
|
|
3169
3449
|
/**
|
|
@@ -3196,111 +3476,8 @@ interface paths {
|
|
|
3196
3476
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3197
3477
|
};
|
|
3198
3478
|
};
|
|
3199
|
-
/**
|
|
3200
|
-
|
|
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
|
-
};
|
|
3222
|
-
"/workspaces/{workspaceSlug}/connections/oauth/{provider}/start/": {
|
|
3223
|
-
parameters: {
|
|
3224
|
-
query?: never;
|
|
3225
|
-
header?: never;
|
|
3226
|
-
path?: never;
|
|
3227
|
-
cookie?: never;
|
|
3228
|
-
};
|
|
3229
|
-
get?: never;
|
|
3230
|
-
put?: never;
|
|
3231
|
-
/**
|
|
3232
|
-
* Start cloud file OAuth
|
|
3233
|
-
* @description Begins the OAuth authorization for a cloud file-service connection and returns the provider authorize URL to redirect the user to. On the user's consent, the provider redirects to the callback, which creates the connection.
|
|
3234
|
-
*/
|
|
3235
|
-
post: {
|
|
3236
|
-
parameters: {
|
|
3237
|
-
query?: never;
|
|
3238
|
-
header?: never;
|
|
3239
|
-
path: {
|
|
3240
|
-
/** @description URL-safe workspace identifier. */
|
|
3241
|
-
workspaceSlug: string;
|
|
3242
|
-
/** @description The cloud file provider to connect. */
|
|
3243
|
-
provider: components["schemas"]["Provider"];
|
|
3244
|
-
};
|
|
3245
|
-
cookie?: never;
|
|
3246
|
-
};
|
|
3247
|
-
/** @description Request payload for starting a cloud file-service OAuth authorization. */
|
|
3248
|
-
requestBody: {
|
|
3249
|
-
content: {
|
|
3250
|
-
"application/json": components["schemas"]["StartFileServiceOAuth"];
|
|
3251
|
-
};
|
|
3252
|
-
};
|
|
3253
|
-
responses: {
|
|
3254
|
-
/** @description The response to a successful authorization start: where to send the user. */
|
|
3255
|
-
200: {
|
|
3256
|
-
headers: {
|
|
3257
|
-
[name: string]: unknown;
|
|
3258
|
-
};
|
|
3259
|
-
content: {
|
|
3260
|
-
"application/json": components["schemas"]["OAuthStartResponse"];
|
|
3261
|
-
};
|
|
3262
|
-
};
|
|
3263
|
-
/** @description Failed to parse the request body as JSON */
|
|
3264
|
-
400: {
|
|
3265
|
-
headers: {
|
|
3266
|
-
[name: string]: unknown;
|
|
3267
|
-
};
|
|
3268
|
-
content: {
|
|
3269
|
-
"text/plain": string;
|
|
3270
|
-
};
|
|
3271
|
-
};
|
|
3272
|
-
/**
|
|
3273
|
-
* @description HTTP error response representation with security-conscious design.
|
|
3274
|
-
*
|
|
3275
|
-
* This struct contains all the information needed to serialize an error
|
|
3276
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3277
|
-
* information, and user-friendly messages.
|
|
3278
|
-
*/
|
|
3279
|
-
401: {
|
|
3280
|
-
headers: {
|
|
3281
|
-
[name: string]: unknown;
|
|
3282
|
-
};
|
|
3283
|
-
content: {
|
|
3284
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
3285
|
-
};
|
|
3286
|
-
};
|
|
3287
|
-
/**
|
|
3288
|
-
* @description HTTP error response representation with security-conscious design.
|
|
3289
|
-
*
|
|
3290
|
-
* This struct contains all the information needed to serialize an error
|
|
3291
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3292
|
-
* information, and user-friendly messages.
|
|
3293
|
-
*/
|
|
3294
|
-
403: {
|
|
3295
|
-
headers: {
|
|
3296
|
-
[name: string]: unknown;
|
|
3297
|
-
};
|
|
3298
|
-
content: {
|
|
3299
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
3300
|
-
};
|
|
3301
|
-
};
|
|
3302
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
3303
|
-
415: {
|
|
3479
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3480
|
+
415: {
|
|
3304
3481
|
headers: {
|
|
3305
3482
|
[name: string]: unknown;
|
|
3306
3483
|
};
|
|
@@ -9524,28 +9701,481 @@ interface paths {
|
|
|
9524
9701
|
};
|
|
9525
9702
|
};
|
|
9526
9703
|
responses: {
|
|
9527
|
-
/** @description Workspace webhook response. */
|
|
9704
|
+
/** @description Workspace webhook response. */
|
|
9705
|
+
200: {
|
|
9706
|
+
headers: {
|
|
9707
|
+
[name: string]: unknown;
|
|
9708
|
+
};
|
|
9709
|
+
content: {
|
|
9710
|
+
"application/json": components["schemas"]["Webhook"];
|
|
9711
|
+
};
|
|
9712
|
+
};
|
|
9713
|
+
/**
|
|
9714
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9715
|
+
*
|
|
9716
|
+
* This struct contains all the information needed to serialize an error
|
|
9717
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9718
|
+
* information, and user-friendly messages.
|
|
9719
|
+
*/
|
|
9720
|
+
400: {
|
|
9721
|
+
headers: {
|
|
9722
|
+
[name: string]: unknown;
|
|
9723
|
+
};
|
|
9724
|
+
content: {
|
|
9725
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9726
|
+
};
|
|
9727
|
+
};
|
|
9728
|
+
/**
|
|
9729
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9730
|
+
*
|
|
9731
|
+
* This struct contains all the information needed to serialize an error
|
|
9732
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9733
|
+
* information, and user-friendly messages.
|
|
9734
|
+
*/
|
|
9735
|
+
401: {
|
|
9736
|
+
headers: {
|
|
9737
|
+
[name: string]: unknown;
|
|
9738
|
+
};
|
|
9739
|
+
content: {
|
|
9740
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9741
|
+
};
|
|
9742
|
+
};
|
|
9743
|
+
/**
|
|
9744
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9745
|
+
*
|
|
9746
|
+
* This struct contains all the information needed to serialize an error
|
|
9747
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9748
|
+
* information, and user-friendly messages.
|
|
9749
|
+
*/
|
|
9750
|
+
403: {
|
|
9751
|
+
headers: {
|
|
9752
|
+
[name: string]: unknown;
|
|
9753
|
+
};
|
|
9754
|
+
content: {
|
|
9755
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9756
|
+
};
|
|
9757
|
+
};
|
|
9758
|
+
/**
|
|
9759
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9760
|
+
*
|
|
9761
|
+
* This struct contains all the information needed to serialize an error
|
|
9762
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9763
|
+
* information, and user-friendly messages.
|
|
9764
|
+
*/
|
|
9765
|
+
404: {
|
|
9766
|
+
headers: {
|
|
9767
|
+
[name: string]: unknown;
|
|
9768
|
+
};
|
|
9769
|
+
content: {
|
|
9770
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9771
|
+
};
|
|
9772
|
+
};
|
|
9773
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
9774
|
+
415: {
|
|
9775
|
+
headers: {
|
|
9776
|
+
[name: string]: unknown;
|
|
9777
|
+
};
|
|
9778
|
+
content: {
|
|
9779
|
+
"text/plain": string;
|
|
9780
|
+
};
|
|
9781
|
+
};
|
|
9782
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
9783
|
+
422: {
|
|
9784
|
+
headers: {
|
|
9785
|
+
[name: string]: unknown;
|
|
9786
|
+
};
|
|
9787
|
+
content: {
|
|
9788
|
+
"text/plain": string;
|
|
9789
|
+
};
|
|
9790
|
+
};
|
|
9791
|
+
};
|
|
9792
|
+
};
|
|
9793
|
+
trace?: never;
|
|
9794
|
+
};
|
|
9795
|
+
"/workspaces/{workspaceSlug}/webhooks/{webhookId}/test/": {
|
|
9796
|
+
parameters: {
|
|
9797
|
+
query?: never;
|
|
9798
|
+
header?: never;
|
|
9799
|
+
path?: never;
|
|
9800
|
+
cookie?: never;
|
|
9801
|
+
};
|
|
9802
|
+
get?: never;
|
|
9803
|
+
put?: never;
|
|
9804
|
+
/**
|
|
9805
|
+
* Test webhook
|
|
9806
|
+
* @description Sends a test payload to the webhook endpoint and returns the result.
|
|
9807
|
+
*/
|
|
9808
|
+
post: {
|
|
9809
|
+
parameters: {
|
|
9810
|
+
query?: never;
|
|
9811
|
+
header?: never;
|
|
9812
|
+
path: {
|
|
9813
|
+
/** @description URL-safe workspace identifier. */
|
|
9814
|
+
workspaceSlug: string;
|
|
9815
|
+
/** @description Opaque identifier of the webhook. */
|
|
9816
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
9817
|
+
};
|
|
9818
|
+
cookie?: never;
|
|
9819
|
+
};
|
|
9820
|
+
/** @description Request payload for testing a webhook. */
|
|
9821
|
+
requestBody: {
|
|
9822
|
+
content: {
|
|
9823
|
+
"application/json": components["schemas"]["TestWebhook"];
|
|
9824
|
+
};
|
|
9825
|
+
};
|
|
9826
|
+
responses: {
|
|
9827
|
+
/** @description Result of a webhook delivery attempt. */
|
|
9828
|
+
200: {
|
|
9829
|
+
headers: {
|
|
9830
|
+
[name: string]: unknown;
|
|
9831
|
+
};
|
|
9832
|
+
content: {
|
|
9833
|
+
"application/json": components["schemas"]["WebhookResult"];
|
|
9834
|
+
};
|
|
9835
|
+
};
|
|
9836
|
+
/** @description Failed to parse the request body as JSON */
|
|
9837
|
+
400: {
|
|
9838
|
+
headers: {
|
|
9839
|
+
[name: string]: unknown;
|
|
9840
|
+
};
|
|
9841
|
+
content: {
|
|
9842
|
+
"text/plain": string;
|
|
9843
|
+
};
|
|
9844
|
+
};
|
|
9845
|
+
/**
|
|
9846
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9847
|
+
*
|
|
9848
|
+
* This struct contains all the information needed to serialize an error
|
|
9849
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9850
|
+
* information, and user-friendly messages.
|
|
9851
|
+
*/
|
|
9852
|
+
401: {
|
|
9853
|
+
headers: {
|
|
9854
|
+
[name: string]: unknown;
|
|
9855
|
+
};
|
|
9856
|
+
content: {
|
|
9857
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9858
|
+
};
|
|
9859
|
+
};
|
|
9860
|
+
/**
|
|
9861
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9862
|
+
*
|
|
9863
|
+
* This struct contains all the information needed to serialize an error
|
|
9864
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9865
|
+
* information, and user-friendly messages.
|
|
9866
|
+
*/
|
|
9867
|
+
403: {
|
|
9868
|
+
headers: {
|
|
9869
|
+
[name: string]: unknown;
|
|
9870
|
+
};
|
|
9871
|
+
content: {
|
|
9872
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9873
|
+
};
|
|
9874
|
+
};
|
|
9875
|
+
/**
|
|
9876
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9877
|
+
*
|
|
9878
|
+
* This struct contains all the information needed to serialize an error
|
|
9879
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9880
|
+
* information, and user-friendly messages.
|
|
9881
|
+
*/
|
|
9882
|
+
404: {
|
|
9883
|
+
headers: {
|
|
9884
|
+
[name: string]: unknown;
|
|
9885
|
+
};
|
|
9886
|
+
content: {
|
|
9887
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9888
|
+
};
|
|
9889
|
+
};
|
|
9890
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
9891
|
+
415: {
|
|
9892
|
+
headers: {
|
|
9893
|
+
[name: string]: unknown;
|
|
9894
|
+
};
|
|
9895
|
+
content: {
|
|
9896
|
+
"text/plain": string;
|
|
9897
|
+
};
|
|
9898
|
+
};
|
|
9899
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
9900
|
+
422: {
|
|
9901
|
+
headers: {
|
|
9902
|
+
[name: string]: unknown;
|
|
9903
|
+
};
|
|
9904
|
+
content: {
|
|
9905
|
+
"text/plain": string;
|
|
9906
|
+
};
|
|
9907
|
+
};
|
|
9908
|
+
};
|
|
9909
|
+
};
|
|
9910
|
+
delete?: never;
|
|
9911
|
+
options?: never;
|
|
9912
|
+
head?: never;
|
|
9913
|
+
patch?: never;
|
|
9914
|
+
trace?: never;
|
|
9915
|
+
};
|
|
9916
|
+
"/account/identities/": {
|
|
9917
|
+
parameters: {
|
|
9918
|
+
query?: never;
|
|
9919
|
+
header?: never;
|
|
9920
|
+
path?: never;
|
|
9921
|
+
cookie?: never;
|
|
9922
|
+
};
|
|
9923
|
+
/**
|
|
9924
|
+
* List sign-in methods
|
|
9925
|
+
* @description Returns the authenticated account's identities: its password and any linked providers.
|
|
9926
|
+
*/
|
|
9927
|
+
get: {
|
|
9928
|
+
parameters: {
|
|
9929
|
+
query?: never;
|
|
9930
|
+
header?: never;
|
|
9931
|
+
path?: never;
|
|
9932
|
+
cookie?: never;
|
|
9933
|
+
};
|
|
9934
|
+
requestBody?: never;
|
|
9935
|
+
responses: {
|
|
9936
|
+
/** @description The account's sign-in methods. */
|
|
9937
|
+
200: {
|
|
9938
|
+
headers: {
|
|
9939
|
+
[name: string]: unknown;
|
|
9940
|
+
};
|
|
9941
|
+
content: {
|
|
9942
|
+
"application/json": components["schemas"]["AccountIdentities"];
|
|
9943
|
+
};
|
|
9944
|
+
};
|
|
9945
|
+
/**
|
|
9946
|
+
* @description HTTP error response representation with security-conscious design.
|
|
9947
|
+
*
|
|
9948
|
+
* This struct contains all the information needed to serialize an error
|
|
9949
|
+
* response, including the error name, message, HTTP status code, resource
|
|
9950
|
+
* information, and user-friendly messages.
|
|
9951
|
+
*/
|
|
9952
|
+
401: {
|
|
9953
|
+
headers: {
|
|
9954
|
+
[name: string]: unknown;
|
|
9955
|
+
};
|
|
9956
|
+
content: {
|
|
9957
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9958
|
+
};
|
|
9959
|
+
};
|
|
9960
|
+
};
|
|
9961
|
+
};
|
|
9962
|
+
put?: never;
|
|
9963
|
+
post?: never;
|
|
9964
|
+
delete?: never;
|
|
9965
|
+
options?: never;
|
|
9966
|
+
head?: never;
|
|
9967
|
+
patch?: never;
|
|
9968
|
+
trace?: never;
|
|
9969
|
+
};
|
|
9970
|
+
"/account/identities/password/": {
|
|
9971
|
+
parameters: {
|
|
9972
|
+
query?: never;
|
|
9973
|
+
header?: never;
|
|
9974
|
+
path?: never;
|
|
9975
|
+
cookie?: never;
|
|
9976
|
+
};
|
|
9977
|
+
get?: never;
|
|
9978
|
+
/**
|
|
9979
|
+
* Set or change password
|
|
9980
|
+
* @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.
|
|
9981
|
+
*/
|
|
9982
|
+
put: {
|
|
9983
|
+
parameters: {
|
|
9984
|
+
query?: never;
|
|
9985
|
+
header?: never;
|
|
9986
|
+
path?: never;
|
|
9987
|
+
cookie?: never;
|
|
9988
|
+
};
|
|
9989
|
+
/**
|
|
9990
|
+
* @description A password set or change.
|
|
9991
|
+
*
|
|
9992
|
+
* When the account already has a password, `current_password` is required and
|
|
9993
|
+
* verified before the change is applied, so a hijacked session or CSRF cannot
|
|
9994
|
+
* silently reset it (and lock out the real owner). When the account has no
|
|
9995
|
+
* password yet (an SSO-only account setting its first one), there is nothing to
|
|
9996
|
+
* re-authenticate against, so a fresh step-up `reauth_proof` is required instead
|
|
9997
|
+
* — a live session alone must not mint a durable new credential.
|
|
9998
|
+
*/
|
|
9999
|
+
requestBody: {
|
|
10000
|
+
content: {
|
|
10001
|
+
"application/json": components["schemas"]["SetPassword"];
|
|
10002
|
+
};
|
|
10003
|
+
};
|
|
10004
|
+
responses: {
|
|
10005
|
+
/** @description Password set. */
|
|
10006
|
+
204: {
|
|
10007
|
+
headers: {
|
|
10008
|
+
[name: string]: unknown;
|
|
10009
|
+
};
|
|
10010
|
+
content?: never;
|
|
10011
|
+
};
|
|
10012
|
+
/**
|
|
10013
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10014
|
+
*
|
|
10015
|
+
* This struct contains all the information needed to serialize an error
|
|
10016
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10017
|
+
* information, and user-friendly messages.
|
|
10018
|
+
*/
|
|
10019
|
+
400: {
|
|
10020
|
+
headers: {
|
|
10021
|
+
[name: string]: unknown;
|
|
10022
|
+
};
|
|
10023
|
+
content: {
|
|
10024
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10025
|
+
};
|
|
10026
|
+
};
|
|
10027
|
+
/**
|
|
10028
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10029
|
+
*
|
|
10030
|
+
* This struct contains all the information needed to serialize an error
|
|
10031
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10032
|
+
* information, and user-friendly messages.
|
|
10033
|
+
*/
|
|
10034
|
+
401: {
|
|
10035
|
+
headers: {
|
|
10036
|
+
[name: string]: unknown;
|
|
10037
|
+
};
|
|
10038
|
+
content: {
|
|
10039
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10040
|
+
};
|
|
10041
|
+
};
|
|
10042
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
10043
|
+
415: {
|
|
10044
|
+
headers: {
|
|
10045
|
+
[name: string]: unknown;
|
|
10046
|
+
};
|
|
10047
|
+
content: {
|
|
10048
|
+
"text/plain": string;
|
|
10049
|
+
};
|
|
10050
|
+
};
|
|
10051
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
10052
|
+
422: {
|
|
10053
|
+
headers: {
|
|
10054
|
+
[name: string]: unknown;
|
|
10055
|
+
};
|
|
10056
|
+
content: {
|
|
10057
|
+
"text/plain": string;
|
|
10058
|
+
};
|
|
10059
|
+
};
|
|
10060
|
+
};
|
|
10061
|
+
};
|
|
10062
|
+
post?: never;
|
|
10063
|
+
/**
|
|
10064
|
+
* Remove password
|
|
10065
|
+
* @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.
|
|
10066
|
+
*/
|
|
10067
|
+
delete: {
|
|
10068
|
+
parameters: {
|
|
10069
|
+
query?: never;
|
|
10070
|
+
header?: never;
|
|
10071
|
+
path?: never;
|
|
10072
|
+
cookie?: never;
|
|
10073
|
+
};
|
|
10074
|
+
requestBody?: never;
|
|
10075
|
+
responses: {
|
|
10076
|
+
/** @description Password removed. */
|
|
10077
|
+
204: {
|
|
10078
|
+
headers: {
|
|
10079
|
+
[name: string]: unknown;
|
|
10080
|
+
};
|
|
10081
|
+
content?: never;
|
|
10082
|
+
};
|
|
10083
|
+
/**
|
|
10084
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10085
|
+
*
|
|
10086
|
+
* This struct contains all the information needed to serialize an error
|
|
10087
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10088
|
+
* information, and user-friendly messages.
|
|
10089
|
+
*/
|
|
10090
|
+
401: {
|
|
10091
|
+
headers: {
|
|
10092
|
+
[name: string]: unknown;
|
|
10093
|
+
};
|
|
10094
|
+
content: {
|
|
10095
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10096
|
+
};
|
|
10097
|
+
};
|
|
10098
|
+
/**
|
|
10099
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10100
|
+
*
|
|
10101
|
+
* This struct contains all the information needed to serialize an error
|
|
10102
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10103
|
+
* information, and user-friendly messages.
|
|
10104
|
+
*/
|
|
10105
|
+
404: {
|
|
10106
|
+
headers: {
|
|
10107
|
+
[name: string]: unknown;
|
|
10108
|
+
};
|
|
10109
|
+
content: {
|
|
10110
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10111
|
+
};
|
|
10112
|
+
};
|
|
10113
|
+
/**
|
|
10114
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10115
|
+
*
|
|
10116
|
+
* This struct contains all the information needed to serialize an error
|
|
10117
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10118
|
+
* information, and user-friendly messages.
|
|
10119
|
+
*/
|
|
10120
|
+
409: {
|
|
10121
|
+
headers: {
|
|
10122
|
+
[name: string]: unknown;
|
|
10123
|
+
};
|
|
10124
|
+
content: {
|
|
10125
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
10126
|
+
};
|
|
10127
|
+
};
|
|
10128
|
+
};
|
|
10129
|
+
};
|
|
10130
|
+
options?: never;
|
|
10131
|
+
head?: never;
|
|
10132
|
+
patch?: never;
|
|
10133
|
+
trace?: never;
|
|
10134
|
+
};
|
|
10135
|
+
"/account/identities/{provider}/": {
|
|
10136
|
+
parameters: {
|
|
10137
|
+
query?: never;
|
|
10138
|
+
header?: never;
|
|
10139
|
+
path?: never;
|
|
10140
|
+
cookie?: never;
|
|
10141
|
+
};
|
|
10142
|
+
get?: never;
|
|
10143
|
+
put?: never;
|
|
10144
|
+
/**
|
|
10145
|
+
* Link a provider
|
|
10146
|
+
* @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.
|
|
10147
|
+
*/
|
|
10148
|
+
post: {
|
|
10149
|
+
parameters: {
|
|
10150
|
+
query?: {
|
|
10151
|
+
/**
|
|
10152
|
+
* @description A step-up re-authentication proof. Required to start a *link* (adding a
|
|
10153
|
+
* provider is a credential-adding action, so a live session alone is not
|
|
10154
|
+
* enough); ignored for sign-in and reauth.
|
|
10155
|
+
*/
|
|
10156
|
+
reauthProof?: string;
|
|
10157
|
+
/**
|
|
10158
|
+
* @description Frontend URL to return to once done. Carried through the flow and used to
|
|
10159
|
+
* build the callback's redirect.
|
|
10160
|
+
*/
|
|
10161
|
+
redirectUri?: string;
|
|
10162
|
+
};
|
|
10163
|
+
header?: never;
|
|
10164
|
+
path: {
|
|
10165
|
+
/** @description The identity provider to act on. */
|
|
10166
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
10167
|
+
};
|
|
10168
|
+
cookie?: never;
|
|
10169
|
+
};
|
|
10170
|
+
requestBody?: never;
|
|
10171
|
+
responses: {
|
|
10172
|
+
/** @description The response to a successful sign-in start: where to send the user. */
|
|
9528
10173
|
200: {
|
|
9529
10174
|
headers: {
|
|
9530
10175
|
[name: string]: unknown;
|
|
9531
10176
|
};
|
|
9532
10177
|
content: {
|
|
9533
|
-
"application/json": components["schemas"]["
|
|
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"];
|
|
10178
|
+
"application/json": components["schemas"]["OidcStartResponse"];
|
|
9549
10179
|
};
|
|
9550
10180
|
};
|
|
9551
10181
|
/**
|
|
@@ -9570,7 +10200,7 @@ interface paths {
|
|
|
9570
10200
|
* response, including the error name, message, HTTP status code, resource
|
|
9571
10201
|
* information, and user-friendly messages.
|
|
9572
10202
|
*/
|
|
9573
|
-
|
|
10203
|
+
404: {
|
|
9574
10204
|
headers: {
|
|
9575
10205
|
[name: string]: unknown;
|
|
9576
10206
|
};
|
|
@@ -9585,7 +10215,7 @@ interface paths {
|
|
|
9585
10215
|
* response, including the error name, message, HTTP status code, resource
|
|
9586
10216
|
* information, and user-friendly messages.
|
|
9587
10217
|
*/
|
|
9588
|
-
|
|
10218
|
+
503: {
|
|
9589
10219
|
headers: {
|
|
9590
10220
|
[name: string]: unknown;
|
|
9591
10221
|
};
|
|
@@ -9593,76 +10223,44 @@ interface paths {
|
|
|
9593
10223
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
9594
10224
|
};
|
|
9595
10225
|
};
|
|
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
10226
|
};
|
|
9615
10227
|
};
|
|
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
10228
|
/**
|
|
9628
|
-
*
|
|
9629
|
-
* @description
|
|
10229
|
+
* Unlink a provider
|
|
10230
|
+
* @description Removes a linked OIDC provider from the account. Refused if the provider is the account's only sign-in method.
|
|
9630
10231
|
*/
|
|
9631
|
-
|
|
10232
|
+
delete: {
|
|
9632
10233
|
parameters: {
|
|
9633
10234
|
query?: never;
|
|
9634
10235
|
header?: never;
|
|
9635
10236
|
path: {
|
|
9636
|
-
/** @description
|
|
9637
|
-
|
|
9638
|
-
/** @description Opaque identifier of the webhook. */
|
|
9639
|
-
webhookId: components["schemas"]["WebhookId"];
|
|
10237
|
+
/** @description The identity provider to act on. */
|
|
10238
|
+
provider: components["schemas"]["IdentityProvider"];
|
|
9640
10239
|
};
|
|
9641
10240
|
cookie?: never;
|
|
9642
10241
|
};
|
|
9643
|
-
|
|
9644
|
-
requestBody: {
|
|
9645
|
-
content: {
|
|
9646
|
-
"application/json": components["schemas"]["TestWebhook"];
|
|
9647
|
-
};
|
|
9648
|
-
};
|
|
10242
|
+
requestBody?: never;
|
|
9649
10243
|
responses: {
|
|
9650
|
-
/** @description
|
|
9651
|
-
|
|
10244
|
+
/** @description Provider unlinked. */
|
|
10245
|
+
204: {
|
|
9652
10246
|
headers: {
|
|
9653
10247
|
[name: string]: unknown;
|
|
9654
10248
|
};
|
|
9655
|
-
content
|
|
9656
|
-
"application/json": components["schemas"]["WebhookResult"];
|
|
9657
|
-
};
|
|
10249
|
+
content?: never;
|
|
9658
10250
|
};
|
|
9659
|
-
/**
|
|
10251
|
+
/**
|
|
10252
|
+
* @description HTTP error response representation with security-conscious design.
|
|
10253
|
+
*
|
|
10254
|
+
* This struct contains all the information needed to serialize an error
|
|
10255
|
+
* response, including the error name, message, HTTP status code, resource
|
|
10256
|
+
* information, and user-friendly messages.
|
|
10257
|
+
*/
|
|
9660
10258
|
400: {
|
|
9661
10259
|
headers: {
|
|
9662
10260
|
[name: string]: unknown;
|
|
9663
10261
|
};
|
|
9664
10262
|
content: {
|
|
9665
|
-
"
|
|
10263
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9666
10264
|
};
|
|
9667
10265
|
};
|
|
9668
10266
|
/**
|
|
@@ -9687,7 +10285,7 @@ interface paths {
|
|
|
9687
10285
|
* response, including the error name, message, HTTP status code, resource
|
|
9688
10286
|
* information, and user-friendly messages.
|
|
9689
10287
|
*/
|
|
9690
|
-
|
|
10288
|
+
404: {
|
|
9691
10289
|
headers: {
|
|
9692
10290
|
[name: string]: unknown;
|
|
9693
10291
|
};
|
|
@@ -9702,7 +10300,7 @@ interface paths {
|
|
|
9702
10300
|
* response, including the error name, message, HTTP status code, resource
|
|
9703
10301
|
* information, and user-friendly messages.
|
|
9704
10302
|
*/
|
|
9705
|
-
|
|
10303
|
+
409: {
|
|
9706
10304
|
headers: {
|
|
9707
10305
|
[name: string]: unknown;
|
|
9708
10306
|
};
|
|
@@ -9710,27 +10308,8 @@ interface paths {
|
|
|
9710
10308
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
9711
10309
|
};
|
|
9712
10310
|
};
|
|
9713
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
9714
|
-
415: {
|
|
9715
|
-
headers: {
|
|
9716
|
-
[name: string]: unknown;
|
|
9717
|
-
};
|
|
9718
|
-
content: {
|
|
9719
|
-
"text/plain": string;
|
|
9720
|
-
};
|
|
9721
|
-
};
|
|
9722
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
9723
|
-
422: {
|
|
9724
|
-
headers: {
|
|
9725
|
-
[name: string]: unknown;
|
|
9726
|
-
};
|
|
9727
|
-
content: {
|
|
9728
|
-
"text/plain": string;
|
|
9729
|
-
};
|
|
9730
|
-
};
|
|
9731
10311
|
};
|
|
9732
10312
|
};
|
|
9733
|
-
delete?: never;
|
|
9734
10313
|
options?: never;
|
|
9735
10314
|
head?: never;
|
|
9736
10315
|
patch?: never;
|
|
@@ -10638,6 +11217,18 @@ interface components {
|
|
|
10638
11217
|
data: components["schemas"]["ConnectionActivityParams"];
|
|
10639
11218
|
/** @constant */
|
|
10640
11219
|
type: "connection.sync.failed";
|
|
11220
|
+
} | {
|
|
11221
|
+
data: components["schemas"]["ProviderActivityParams"];
|
|
11222
|
+
/** @constant */
|
|
11223
|
+
type: "provider.created";
|
|
11224
|
+
} | {
|
|
11225
|
+
data: components["schemas"]["ProviderActivityParams"];
|
|
11226
|
+
/** @constant */
|
|
11227
|
+
type: "provider.updated";
|
|
11228
|
+
} | {
|
|
11229
|
+
data: components["schemas"]["ProviderActivityParams"];
|
|
11230
|
+
/** @constant */
|
|
11231
|
+
type: "provider.deleted";
|
|
10641
11232
|
} | {
|
|
10642
11233
|
data: components["schemas"]["WebhookActivityParams"];
|
|
10643
11234
|
/** @constant */
|
|
@@ -10710,7 +11301,7 @@ interface components {
|
|
|
10710
11301
|
* to categorize different types of activities that occur within workspaces for comprehensive
|
|
10711
11302
|
* audit trail and activity tracking.
|
|
10712
11303
|
*/
|
|
10713
|
-
ActivityType: "workspace.created" | "workspace.updated" | "workspace.deleted" | "member.added" | "member.updated" | "member.deleted" | "invite.created" | "invite.accepted" | "invite.declined" | "invite.canceled" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "file.created" | "file.updated" | "file.deleted" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.detection.started" | "pipeline.detection.completed" | "pipeline.detection.failed" | "pipeline.redaction.created" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
11304
|
+
ActivityType: "workspace.created" | "workspace.updated" | "workspace.deleted" | "member.added" | "member.updated" | "member.deleted" | "invite.created" | "invite.accepted" | "invite.declined" | "invite.canceled" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "provider.created" | "provider.updated" | "provider.deleted" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "file.created" | "file.updated" | "file.deleted" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.detection.started" | "pipeline.detection.completed" | "pipeline.detection.failed" | "pipeline.redaction.created" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
10714
11305
|
/** @description API token response structure. */
|
|
10715
11306
|
ApiToken: {
|
|
10716
11307
|
/**
|
|
@@ -11782,6 +12373,8 @@ interface components {
|
|
|
11782
12373
|
* Only metadata about the connection is returned.
|
|
11783
12374
|
*/
|
|
11784
12375
|
Connection: {
|
|
12376
|
+
/** @description Capability category of the connection (object store, file service). */
|
|
12377
|
+
connectionType: components["schemas"]["ConnectionType"];
|
|
11785
12378
|
/**
|
|
11786
12379
|
* Format: date-time
|
|
11787
12380
|
* @description When the connection was created.
|
|
@@ -11795,11 +12388,19 @@ interface components {
|
|
|
11795
12388
|
id: components["schemas"]["ConnectionId"];
|
|
11796
12389
|
/** @description Whether the connection is enabled. */
|
|
11797
12390
|
isActive: boolean;
|
|
11798
|
-
/**
|
|
12391
|
+
/**
|
|
12392
|
+
* Format: date-time
|
|
12393
|
+
* @description When the connection last synced successfully, if ever. Independent of
|
|
12394
|
+
* `sync`: a connection with no schedule still records its on-demand syncs.
|
|
12395
|
+
*/
|
|
12396
|
+
lastSyncedAt?: string;
|
|
12397
|
+
/** @description Provider identifier (`s3`, `azure`, `gcs`, `google_drive`, `dropbox`, ...). */
|
|
11799
12398
|
provider: string;
|
|
11800
|
-
/**
|
|
11801
|
-
|
|
11802
|
-
|
|
12399
|
+
/**
|
|
12400
|
+
* @description Scheduled-sync configuration; present only for connections that sync on a
|
|
12401
|
+
* timer. Its absence does not mean the connection cannot sync — a file
|
|
12402
|
+
* service and an unscheduled object store both transfer on demand.
|
|
12403
|
+
*/
|
|
11803
12404
|
sync?: components["schemas"]["SyncSchedule"];
|
|
11804
12405
|
/**
|
|
11805
12406
|
* Format: date-time
|
|
@@ -11817,12 +12418,12 @@ interface components {
|
|
|
11817
12418
|
connectionName: string;
|
|
11818
12419
|
};
|
|
11819
12420
|
/**
|
|
11820
|
-
* @description A fully-typed connection configuration
|
|
12421
|
+
* @description A fully-typed transfer-connection configuration.
|
|
11821
12422
|
*
|
|
11822
12423
|
* Untagged: the two inner enums have disjoint `provider` values, so serde
|
|
11823
12424
|
* resolves the variant from the flat payload without an outer discriminator.
|
|
11824
12425
|
*/
|
|
11825
|
-
ConnectionConfig: components["schemas"]["StorageConfig"] | components["schemas"]["FileServiceConfig"]
|
|
12426
|
+
ConnectionConfig: components["schemas"]["StorageConfig"] | components["schemas"]["FileServiceConfig"];
|
|
11826
12427
|
/** @description Opaque conn identifier (conn_<uuid>). */
|
|
11827
12428
|
ConnectionId: string;
|
|
11828
12429
|
/**
|
|
@@ -11942,6 +12543,17 @@ interface components {
|
|
|
11942
12543
|
*/
|
|
11943
12544
|
syncId: string;
|
|
11944
12545
|
};
|
|
12546
|
+
/**
|
|
12547
|
+
* @description The capability category of a transfer connection.
|
|
12548
|
+
*
|
|
12549
|
+
* Corresponds to the `CONNECTION_TYPE` PostgreSQL enum. A stable, closed set:
|
|
12550
|
+
* the concrete provider (the `provider` column, e.g. `s3`) stays open and
|
|
12551
|
+
* extensible, while its capability is one of these types. Both categories are
|
|
12552
|
+
* transfer-capable — an object store is enumerable and syncs on a timer; a file
|
|
12553
|
+
* service transfers on demand. Inference services are a separate resource
|
|
12554
|
+
* (`workspace_providers`), not a connection.
|
|
12555
|
+
*/
|
|
12556
|
+
ConnectionType: "object_store" | "file_service";
|
|
11945
12557
|
/** @description Result of a connection reachability check. */
|
|
11946
12558
|
ConnectionVerification: {
|
|
11947
12559
|
/** @description Failure reason when not reachable; omitted on success. */
|
|
@@ -12038,8 +12650,8 @@ interface components {
|
|
|
12038
12650
|
*/
|
|
12039
12651
|
isActive?: boolean;
|
|
12040
12652
|
/**
|
|
12041
|
-
* @description
|
|
12042
|
-
* stores); rejected for others. Omit for
|
|
12653
|
+
* @description Scheduled-sync configuration. Accepted only for schedulable providers
|
|
12654
|
+
* (object stores); rejected for others. Omit for on-demand only.
|
|
12043
12655
|
*/
|
|
12044
12656
|
sync?: components["schemas"]["SyncScheduleInput"];
|
|
12045
12657
|
};
|
|
@@ -12134,6 +12746,22 @@ interface components {
|
|
|
12134
12746
|
/** @constant */
|
|
12135
12747
|
source: "inline";
|
|
12136
12748
|
});
|
|
12749
|
+
/** @description Request payload for creating a new workspace provider. */
|
|
12750
|
+
CreateProvider: {
|
|
12751
|
+
/**
|
|
12752
|
+
* @description Typed provider configuration (provider tag + its credentials), encrypted at
|
|
12753
|
+
* rest. The `provider` tag selects which credential shape is required and
|
|
12754
|
+
* which model type the provider has.
|
|
12755
|
+
*/
|
|
12756
|
+
config: components["schemas"]["ProviderConfig"];
|
|
12757
|
+
/** @description Human-readable provider display name. */
|
|
12758
|
+
displayName: string;
|
|
12759
|
+
/**
|
|
12760
|
+
* @description Whether the provider is enabled. Omit to default to active; set `false` to
|
|
12761
|
+
* create it disabled.
|
|
12762
|
+
*/
|
|
12763
|
+
isActive?: boolean;
|
|
12764
|
+
};
|
|
12137
12765
|
/** @description Request payload for creating a new workspace webhook. */
|
|
12138
12766
|
CreateWebhook: {
|
|
12139
12767
|
/** @description Detailed description of the webhook's purpose (max 500 characters). */
|
|
@@ -12849,7 +13477,7 @@ interface components {
|
|
|
12849
13477
|
*/
|
|
12850
13478
|
FileServiceConfig: {
|
|
12851
13479
|
/** @description Which provider backs this connection. */
|
|
12852
|
-
provider: components["schemas"]["
|
|
13480
|
+
provider: components["schemas"]["FileServiceProvider"];
|
|
12853
13481
|
/**
|
|
12854
13482
|
* @description The folder (id or path) new exports are written into; `None` uses the
|
|
12855
13483
|
* account root.
|
|
@@ -12858,6 +13486,13 @@ interface components {
|
|
|
12858
13486
|
/** @description The OAuth token set for this connection. */
|
|
12859
13487
|
tokens: components["schemas"]["OAuthTokens"];
|
|
12860
13488
|
};
|
|
13489
|
+
/**
|
|
13490
|
+
* @description A supported cloud file-service provider.
|
|
13491
|
+
*
|
|
13492
|
+
* The serialized form (snake_case) is the `provider` tag stored on a connection
|
|
13493
|
+
* and used in the API, so every provider name lives in exactly one place.
|
|
13494
|
+
*/
|
|
13495
|
+
FileServiceProvider: "google_drive" | "dropbox" | "one_drive" | "box";
|
|
12861
13496
|
/**
|
|
12862
13497
|
* @description A supported file extension.
|
|
12863
13498
|
* @enum {string}
|
|
@@ -13563,6 +14198,16 @@ interface components {
|
|
|
13563
14198
|
/** @description The files to import. Already-imported files are skipped. */
|
|
13564
14199
|
files: components["schemas"]["PickedFile"][];
|
|
13565
14200
|
};
|
|
14201
|
+
/**
|
|
14202
|
+
* @description A fully-typed inference connection configuration, across every inference kind.
|
|
14203
|
+
*
|
|
14204
|
+
* Inference is a family: a language model for chat today, and other model kinds
|
|
14205
|
+
* (e.g. named-entity recognition) as they are added. Each kind owns its own
|
|
14206
|
+
* config with its own `provider` tag, and this enum is untagged, so the flat
|
|
14207
|
+
* payload's `provider` remains the sole discriminator — an inference kind is
|
|
14208
|
+
* added as a new variant with no change to the wire format or storage.
|
|
14209
|
+
*/
|
|
14210
|
+
InferenceConfig: components["schemas"]["LlmConfig"];
|
|
13566
14211
|
/**
|
|
13567
14212
|
* @description Workspace invite with complete information.
|
|
13568
14213
|
*
|
|
@@ -14354,12 +14999,12 @@ interface components {
|
|
|
14354
14999
|
};
|
|
14355
15000
|
/**
|
|
14356
15001
|
* @description Path parameters for the OAuth start endpoint: which cloud file provider to
|
|
14357
|
-
* begin authorizing. The provider is the crate's [`
|
|
15002
|
+
* begin authorizing. The provider is the crate's [`FileServiceProvider`], so the API and
|
|
14358
15003
|
* stored config name each provider identically.
|
|
14359
15004
|
*/
|
|
14360
15005
|
OAuthStartPathParams: {
|
|
14361
15006
|
/** @description The cloud file provider to connect. */
|
|
14362
|
-
provider: components["schemas"]["
|
|
15007
|
+
provider: components["schemas"]["FileServiceProvider"];
|
|
14363
15008
|
};
|
|
14364
15009
|
/** @description The response to a successful authorization start: where to send the user. */
|
|
14365
15010
|
OAuthStartResponse: {
|
|
@@ -14507,6 +15152,22 @@ interface components {
|
|
|
14507
15152
|
*/
|
|
14508
15153
|
expiresAt?: number;
|
|
14509
15154
|
};
|
|
15155
|
+
/**
|
|
15156
|
+
* @description Body for minting a browser file-picker token.
|
|
15157
|
+
*
|
|
15158
|
+
* The OneDrive v8 picker requests a token per resource (it names the resource in
|
|
15159
|
+
* each `authenticate` command); the caller passes that `resource` so the server
|
|
15160
|
+
* mints a token scoped to exactly it. Ignored by providers whose picker takes a
|
|
15161
|
+
* single provider token (Google Drive, Box); omit it for those.
|
|
15162
|
+
*/
|
|
15163
|
+
PickerTokenRequest: {
|
|
15164
|
+
/**
|
|
15165
|
+
* @description The resource the picker asked for (its `authenticate` command's
|
|
15166
|
+
* `resource`), e.g. `https://contoso-my.sharepoint.com`. Optional; when
|
|
15167
|
+
* absent the server uses the connection's default picker resource.
|
|
15168
|
+
*/
|
|
15169
|
+
resource?: string;
|
|
15170
|
+
};
|
|
14510
15171
|
/** @description Pipeline response. */
|
|
14511
15172
|
Pipeline: {
|
|
14512
15173
|
/**
|
|
@@ -15088,22 +15749,105 @@ interface components {
|
|
|
15088
15749
|
not: components["schemas"]["Predicate"];
|
|
15089
15750
|
};
|
|
15090
15751
|
/**
|
|
15091
|
-
* @description
|
|
15752
|
+
* @description Response type for a workspace inference provider.
|
|
15092
15753
|
*
|
|
15093
|
-
* The
|
|
15094
|
-
*
|
|
15754
|
+
* Note: The encrypted provider data is never exposed in API responses. Only
|
|
15755
|
+
* metadata about the provider is returned.
|
|
15756
|
+
*/
|
|
15757
|
+
Provider: {
|
|
15758
|
+
/**
|
|
15759
|
+
* Format: date-time
|
|
15760
|
+
* @description When the provider was created.
|
|
15761
|
+
*/
|
|
15762
|
+
createdAt: string;
|
|
15763
|
+
/** @description Account that created this provider. */
|
|
15764
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
15765
|
+
/** @description Human-readable provider display name. */
|
|
15766
|
+
displayName: string;
|
|
15767
|
+
/** @description Opaque identifier of the provider. */
|
|
15768
|
+
id: components["schemas"]["ProviderId"];
|
|
15769
|
+
/** @description Whether the provider is enabled. */
|
|
15770
|
+
isActive: boolean;
|
|
15771
|
+
/** @description Provider identifier (`openai`, `ollama`, `anthropic`, ...). */
|
|
15772
|
+
provider: string;
|
|
15773
|
+
/** @description Inference model type of the provider (llm, ner). */
|
|
15774
|
+
providerType: components["schemas"]["ProviderType"];
|
|
15775
|
+
/**
|
|
15776
|
+
* Format: date-time
|
|
15777
|
+
* @description When the provider was last updated.
|
|
15778
|
+
*/
|
|
15779
|
+
updatedAt: string;
|
|
15780
|
+
/** @description Handle of the workspace this provider belongs to. */
|
|
15781
|
+
workspaceSlug: components["schemas"]["Handle"];
|
|
15782
|
+
};
|
|
15783
|
+
/** @description Params of a provider activity (`provider.*`). */
|
|
15784
|
+
ProviderActivityParams: {
|
|
15785
|
+
/** @description Id of the provider. */
|
|
15786
|
+
providerId: components["schemas"]["ProviderId"];
|
|
15787
|
+
/** @description Display name of the provider. */
|
|
15788
|
+
providerName: string;
|
|
15789
|
+
};
|
|
15790
|
+
/**
|
|
15791
|
+
* @description A fully-typed inference-provider configuration.
|
|
15792
|
+
*
|
|
15793
|
+
* Untagged: the inner config's `provider` tag is the sole discriminator, so the
|
|
15794
|
+
* stored/wire form is flat. A new inference kind is added as a variant of
|
|
15795
|
+
* [`InferenceConfig`] with no change here.
|
|
15796
|
+
*/
|
|
15797
|
+
ProviderConfig: components["schemas"]["InferenceConfig"];
|
|
15798
|
+
/** @description Opaque prov identifier (prov_<uuid>). */
|
|
15799
|
+
ProviderId: string;
|
|
15800
|
+
/**
|
|
15801
|
+
* @description Generic paginated response wrapper.
|
|
15802
|
+
*
|
|
15803
|
+
* Provides a consistent structure for all paginated API responses with
|
|
15804
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
15805
|
+
* are more items to fetch.
|
|
15806
|
+
*/
|
|
15807
|
+
ProviderPage: {
|
|
15808
|
+
/** @description Items in this page. */
|
|
15809
|
+
items: components["schemas"]["Provider"][];
|
|
15810
|
+
/** @description Cursor to fetch the next page. Present only when more items exist. */
|
|
15811
|
+
nextCursor?: string;
|
|
15812
|
+
/**
|
|
15813
|
+
* Format: int64
|
|
15814
|
+
* @description Total count of items matching the query (if requested).
|
|
15815
|
+
*/
|
|
15816
|
+
total?: number;
|
|
15817
|
+
};
|
|
15818
|
+
/**
|
|
15819
|
+
* @description Path parameters for provider operations.
|
|
15820
|
+
*
|
|
15821
|
+
* The workspace is resolved separately from the `{workspaceSlug}` segment by the
|
|
15822
|
+
* [`WorkspaceContext`] extractor.
|
|
15823
|
+
*
|
|
15824
|
+
* [`WorkspaceContext`]: crate::extract::WorkspaceContext
|
|
15095
15825
|
*/
|
|
15096
|
-
|
|
15826
|
+
ProviderPathParams: {
|
|
15827
|
+
/** @description Opaque identifier of the provider. */
|
|
15828
|
+
providerId: components["schemas"]["ProviderId"];
|
|
15829
|
+
};
|
|
15097
15830
|
/**
|
|
15098
|
-
* @description The
|
|
15831
|
+
* @description The inference model type backing a workspace provider.
|
|
15099
15832
|
*
|
|
15100
|
-
* Corresponds to the `PROVIDER_TYPE` PostgreSQL enum. A
|
|
15101
|
-
* the
|
|
15102
|
-
*
|
|
15103
|
-
*
|
|
15104
|
-
*
|
|
15833
|
+
* Corresponds to the `PROVIDER_TYPE` PostgreSQL enum. A workspace provider is an
|
|
15834
|
+
* inference service the platform calls; this says which kind of model it is — a
|
|
15835
|
+
* language model for chat, or a named-entity-recognition model for extraction.
|
|
15836
|
+
* The concrete vendor (the `provider` column, e.g. `openai`) is orthogonal and
|
|
15837
|
+
* stays open; this type is a stable, closed set used to find a workspace's
|
|
15838
|
+
* provider of a given type without decrypting its config.
|
|
15105
15839
|
*/
|
|
15106
|
-
ProviderType: "
|
|
15840
|
+
ProviderType: "llm" | "ner";
|
|
15841
|
+
/** @description Query parameters for listing providers. */
|
|
15842
|
+
ProvidersQuery: {
|
|
15843
|
+
/**
|
|
15844
|
+
* @description Filter by provider (`openai`, `ollama`, `anthropic`). Repeatable; a
|
|
15845
|
+
* provider matches if it uses any of the given providers. Empty means no
|
|
15846
|
+
* filter.
|
|
15847
|
+
* @default []
|
|
15848
|
+
*/
|
|
15849
|
+
provider?: string[];
|
|
15850
|
+
};
|
|
15107
15851
|
/**
|
|
15108
15852
|
* @description Public view of an account, returned when looking up someone other than the
|
|
15109
15853
|
* authenticated caller. Carries only the fields safe to share with a
|
|
@@ -15807,11 +16551,16 @@ interface components {
|
|
|
15807
16551
|
reason?: string;
|
|
15808
16552
|
};
|
|
15809
16553
|
/**
|
|
15810
|
-
* @description What
|
|
16554
|
+
* @description What a whole-listing import does with a file whose source object no longer
|
|
16555
|
+
* exists.
|
|
15811
16556
|
*
|
|
15812
|
-
* Corresponds to the `SYNC_DELETION_POLICY` PostgreSQL enum.
|
|
15813
|
-
*
|
|
15814
|
-
*
|
|
16557
|
+
* Corresponds to the `SYNC_DELETION_POLICY` PostgreSQL enum. Only whole-listing
|
|
16558
|
+
* import reconciles deletions (it compares the full source listing against what
|
|
16559
|
+
* was imported), so this applies to object-store import alone; picker-driven
|
|
16560
|
+
* file-service import transfers only the files the user selected and never
|
|
16561
|
+
* reconciles. Deletion is opt-in per connection: the default `Ignore` keeps
|
|
16562
|
+
* imports strictly additive so a transient listing error or a misconfigured
|
|
16563
|
+
* root path can never remove files.
|
|
15815
16564
|
*/
|
|
15816
16565
|
SyncDeletionPolicy: "ignore" | "delete";
|
|
15817
16566
|
/**
|
|
@@ -15819,27 +16568,34 @@ interface components {
|
|
|
15819
16568
|
*
|
|
15820
16569
|
* Corresponds to the `SYNC_MODE` PostgreSQL enum: `Import` fetches objects from
|
|
15821
16570
|
* the connection into the workspace; `Export` pushes workspace files out.
|
|
16571
|
+
*
|
|
16572
|
+
* A scheduled `Import` is an object-store concept: it enumerates the source and
|
|
16573
|
+
* pulls the whole listing on a timer. A file service is not enumerated on a
|
|
16574
|
+
* timer — its import is picker-driven and request-time — so only `Export` is
|
|
16575
|
+
* scheduled for a file service.
|
|
15822
16576
|
*/
|
|
15823
16577
|
SyncMode: "import" | "export";
|
|
15824
|
-
/**
|
|
16578
|
+
/**
|
|
16579
|
+
* @description A connection's scheduled-sync configuration (its cron config), present only
|
|
16580
|
+
* for connections that sync on a timer. A connection can transfer on demand
|
|
16581
|
+
* without this — it is purely the schedule, not a capability marker. When the
|
|
16582
|
+
* connection last synced is on [`Connection`] itself, since a connection with no
|
|
16583
|
+
* schedule still syncs.
|
|
16584
|
+
*/
|
|
15825
16585
|
SyncSchedule: {
|
|
15826
16586
|
/** @description How an import reconciles files whose source object was deleted. */
|
|
15827
16587
|
deletionPolicy: components["schemas"]["SyncDeletionPolicy"];
|
|
15828
|
-
/**
|
|
15829
|
-
* Format: date-time
|
|
15830
|
-
* @description When the connection last synced successfully, if ever.
|
|
15831
|
-
*/
|
|
15832
|
-
lastSynced?: string;
|
|
15833
16588
|
/** @description Cron expression for scheduled imports, if configured. */
|
|
15834
16589
|
scheduleCron?: string;
|
|
15835
16590
|
/** @description Whether the connection imports data in or exports data out. */
|
|
15836
16591
|
syncMode: components["schemas"]["SyncMode"];
|
|
15837
16592
|
};
|
|
15838
16593
|
/**
|
|
15839
|
-
* @description
|
|
16594
|
+
* @description Scheduled-sync configuration for a schedulable connection.
|
|
15840
16595
|
*
|
|
15841
|
-
*
|
|
15842
|
-
*
|
|
16596
|
+
* Accepted only for providers that can sync on a timer (object stores); rejected
|
|
16597
|
+
* for others — a file service transfers on demand (picker import, per-file
|
|
16598
|
+
* export), and an LLM does not transfer at all. Omit for on-demand only.
|
|
15843
16599
|
*/
|
|
15844
16600
|
SyncScheduleInput: {
|
|
15845
16601
|
/**
|
|
@@ -15865,10 +16621,12 @@ interface components {
|
|
|
15865
16621
|
/**
|
|
15866
16622
|
* @description Defines how a connection sync run was initiated.
|
|
15867
16623
|
*
|
|
15868
|
-
*
|
|
15869
|
-
*
|
|
16624
|
+
* Corresponds to the `SYNC_TRIGGER_TYPE` PostgreSQL enum. The axis is who
|
|
16625
|
+
* initiated the run: the connection's own schedule, or anything else — a user,
|
|
16626
|
+
* the SDK, an external automation (Zapier and the like). The latter is
|
|
16627
|
+
* `OnDemand`, which covers every non-scheduled trigger, not only a human click.
|
|
15870
16628
|
*/
|
|
15871
|
-
SyncTriggerType: "
|
|
16629
|
+
SyncTriggerType: "on_demand" | "scheduled";
|
|
15872
16630
|
/**
|
|
15873
16631
|
* @description A detection recognition missed.
|
|
15874
16632
|
*
|
|
@@ -17369,8 +18127,8 @@ interface components {
|
|
|
17369
18127
|
*/
|
|
17370
18128
|
isActive?: boolean;
|
|
17371
18129
|
/**
|
|
17372
|
-
* @description
|
|
17373
|
-
* unchanged.
|
|
18130
|
+
* @description Scheduled-sync configuration. Accepted only for schedulable providers
|
|
18131
|
+
* (object stores); rejected for others. Omit to leave unchanged.
|
|
17374
18132
|
*/
|
|
17375
18133
|
sync?: components["schemas"]["SyncScheduleInput"];
|
|
17376
18134
|
};
|
|
@@ -17431,6 +18189,18 @@ interface components {
|
|
|
17431
18189
|
/** @description Human-readable policy display name. */
|
|
17432
18190
|
displayName?: string;
|
|
17433
18191
|
};
|
|
18192
|
+
/** @description Request payload for updating an existing workspace provider. */
|
|
18193
|
+
UpdateProvider: {
|
|
18194
|
+
/**
|
|
18195
|
+
* @description Typed provider configuration. If provided, fully replaces the stored config
|
|
18196
|
+
* (and, with it, the provider). Omit to leave it unchanged.
|
|
18197
|
+
*/
|
|
18198
|
+
config?: components["schemas"]["ProviderConfig"];
|
|
18199
|
+
/** @description Human-readable provider display name. */
|
|
18200
|
+
displayName?: string;
|
|
18201
|
+
/** @description Whether the provider is enabled. Omit to leave unchanged. */
|
|
18202
|
+
isActive?: boolean;
|
|
18203
|
+
};
|
|
17434
18204
|
/** @description Request payload for updating an existing workspace webhook. */
|
|
17435
18205
|
UpdateWebhook: {
|
|
17436
18206
|
/** @description Updated description of the webhook's purpose (max 500 characters). */
|
|
@@ -17666,7 +18436,7 @@ interface components {
|
|
|
17666
18436
|
* This enumeration corresponds to the `WEBHOOK_EVENT` PostgreSQL enum and is used
|
|
17667
18437
|
* to configure which events a webhook should receive notifications for.
|
|
17668
18438
|
*/
|
|
17669
|
-
WebhookEvent: "file.created" | "file.updated" | "file.deleted" | "member.added" | "member.deleted" | "member.updated" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.detection.started" | "pipeline.detection.completed" | "pipeline.detection.failed" | "pipeline.redaction.created" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
18439
|
+
WebhookEvent: "file.created" | "file.updated" | "file.deleted" | "member.added" | "member.deleted" | "member.updated" | "connection.created" | "connection.updated" | "connection.deleted" | "connection.sync.started" | "connection.sync.completed" | "connection.sync.failed" | "provider.created" | "provider.updated" | "provider.deleted" | "pipeline.created" | "pipeline.updated" | "pipeline.deleted" | "pipeline.detection.started" | "pipeline.detection.completed" | "pipeline.detection.failed" | "pipeline.redaction.created" | "policy.created" | "policy.updated" | "policy.deleted";
|
|
17670
18440
|
/** @description Opaque whk identifier (whk_<uuid>). */
|
|
17671
18441
|
WebhookId: string;
|
|
17672
18442
|
/**
|
|
@@ -17878,380 +18648,393 @@ interface components {
|
|
|
17878
18648
|
}
|
|
17879
18649
|
//#endregion
|
|
17880
18650
|
//#region src/datatypes/account.d.ts
|
|
17881
|
-
type Schemas$
|
|
17882
|
-
type Handle = Schemas$
|
|
17883
|
-
type Account = Schemas$
|
|
17884
|
-
type PublicAccount = Schemas$
|
|
17885
|
-
type UpdateAccount = Schemas$
|
|
17886
|
-
type AccountRef = Schemas$
|
|
17887
|
-
type AccountIdentities = Schemas$
|
|
17888
|
-
type AccountIdentity = Schemas$
|
|
17889
|
-
type IdentityProvider = Schemas$
|
|
17890
|
-
type SetPassword = Schemas$
|
|
17891
|
-
type OidcStartResponse = Schemas$
|
|
18651
|
+
type Schemas$24 = components["schemas"];
|
|
18652
|
+
type Handle = Schemas$24["Handle"];
|
|
18653
|
+
type Account = Schemas$24["Account"];
|
|
18654
|
+
type PublicAccount = Schemas$24["PublicAccount"];
|
|
18655
|
+
type UpdateAccount = Schemas$24["UpdateAccount"];
|
|
18656
|
+
type AccountRef = Schemas$24["AccountRef"];
|
|
18657
|
+
type AccountIdentities = Schemas$24["AccountIdentities"];
|
|
18658
|
+
type AccountIdentity = Schemas$24["AccountIdentity"];
|
|
18659
|
+
type IdentityProvider = Schemas$24["IdentityProvider"];
|
|
18660
|
+
type SetPassword = Schemas$24["SetPassword"];
|
|
18661
|
+
type OidcStartResponse = Schemas$24["OidcStartResponse"];
|
|
17892
18662
|
//#endregion
|
|
17893
18663
|
//#region src/datatypes/activity.d.ts
|
|
17894
|
-
type Schemas$
|
|
17895
|
-
type Activity = Schemas$
|
|
17896
|
-
type ActivityPage = Schemas$
|
|
17897
|
-
type ActivityType = Schemas$
|
|
17898
|
-
type ActivityFilterQuery = Schemas$
|
|
17899
|
-
type ActivityExportOptions = Schemas$
|
|
17900
|
-
type ActivityPayload = Schemas$
|
|
17901
|
-
type WorkspaceActivityParams = Schemas$
|
|
17902
|
-
type MemberActivityParams = Schemas$
|
|
17903
|
-
type InviteActivityParams = Schemas$
|
|
17904
|
-
type ConnectionActivityParams = Schemas$
|
|
17905
|
-
type PipelineActivityParams = Schemas$
|
|
17906
|
-
type DetectionActivityParams = Schemas$
|
|
17907
|
-
type RedactionActivityParams = Schemas$
|
|
17908
|
-
type PolicyActivityParams = Schemas$
|
|
17909
|
-
type FileActivityParams = Schemas$
|
|
17910
|
-
type WebhookActivityParams = Schemas$
|
|
18664
|
+
type Schemas$23 = components["schemas"];
|
|
18665
|
+
type Activity = Schemas$23["Activity"];
|
|
18666
|
+
type ActivityPage = Schemas$23["ActivityPage"];
|
|
18667
|
+
type ActivityType = Schemas$23["ActivityType"];
|
|
18668
|
+
type ActivityFilterQuery = Schemas$23["ActivityFilterQuery"];
|
|
18669
|
+
type ActivityExportOptions = Schemas$23["ActivityExportOptions"];
|
|
18670
|
+
type ActivityPayload = Schemas$23["ActivityPayload"];
|
|
18671
|
+
type WorkspaceActivityParams = Schemas$23["WorkspaceActivityParams"];
|
|
18672
|
+
type MemberActivityParams = Schemas$23["MemberActivityParams"];
|
|
18673
|
+
type InviteActivityParams = Schemas$23["InviteActivityParams"];
|
|
18674
|
+
type ConnectionActivityParams = Schemas$23["ConnectionActivityParams"];
|
|
18675
|
+
type PipelineActivityParams = Schemas$23["PipelineActivityParams"];
|
|
18676
|
+
type DetectionActivityParams = Schemas$23["DetectionActivityParams"];
|
|
18677
|
+
type RedactionActivityParams = Schemas$23["RedactionActivityParams"];
|
|
18678
|
+
type PolicyActivityParams = Schemas$23["PolicyActivityParams"];
|
|
18679
|
+
type FileActivityParams = Schemas$23["FileActivityParams"];
|
|
18680
|
+
type WebhookActivityParams = Schemas$23["WebhookActivityParams"];
|
|
17911
18681
|
//#endregion
|
|
17912
18682
|
//#region src/datatypes/analytics.d.ts
|
|
17913
|
-
type Schemas$
|
|
17914
|
-
type WorkspaceAnalytics = Schemas$
|
|
17915
|
-
type StorageAnalytics = Schemas$
|
|
17916
|
-
type StorageKindEntry = Schemas$
|
|
17917
|
-
type DetectionAnalytics = Schemas$
|
|
17918
|
-
type DetectionStatusEntry = Schemas$
|
|
17919
|
-
type UsageAnalytics = Schemas$
|
|
17920
|
-
type ModelUsage = Schemas$
|
|
17921
|
-
type ModelUsageEntry = Schemas$
|
|
17922
|
-
type Usage = Schemas$
|
|
17923
|
-
type UsageReport = Schemas$
|
|
17924
|
-
type TokenCounts = Schemas$
|
|
17925
|
-
type
|
|
17926
|
-
type
|
|
17927
|
-
type
|
|
17928
|
-
type DetectionDayEntry = Schemas$21["DetectionDayEntry"];
|
|
18683
|
+
type Schemas$22 = components["schemas"];
|
|
18684
|
+
type WorkspaceAnalytics = Schemas$22["WorkspaceAnalytics"];
|
|
18685
|
+
type StorageAnalytics = Schemas$22["StorageAnalytics"];
|
|
18686
|
+
type StorageKindEntry = Schemas$22["StorageKindEntry"];
|
|
18687
|
+
type DetectionAnalytics = Schemas$22["DetectionAnalytics"];
|
|
18688
|
+
type DetectionStatusEntry = Schemas$22["DetectionStatusEntry"];
|
|
18689
|
+
type UsageAnalytics = Schemas$22["UsageAnalytics"];
|
|
18690
|
+
type ModelUsage = Schemas$22["ModelUsage"];
|
|
18691
|
+
type ModelUsageEntry = Schemas$22["ModelUsageEntry"];
|
|
18692
|
+
type Usage = Schemas$22["Usage"];
|
|
18693
|
+
type UsageReport = Schemas$22["UsageReport"];
|
|
18694
|
+
type TokenCounts = Schemas$22["TokenCounts"];
|
|
18695
|
+
type RecognizerId = Schemas$22["RecognizerId"];
|
|
18696
|
+
type DetectionTimeSeries = Schemas$22["DetectionTimeSeries"];
|
|
18697
|
+
type DetectionDayEntry = Schemas$22["DetectionDayEntry"];
|
|
17929
18698
|
//#endregion
|
|
17930
18699
|
//#region src/datatypes/api-token.d.ts
|
|
17931
|
-
type Schemas$
|
|
17932
|
-
type ApiToken = Schemas$
|
|
17933
|
-
type ApiTokenWithJWT = Schemas$
|
|
17934
|
-
type ApiTokenType = Schemas$
|
|
17935
|
-
type CreateApiToken = Schemas$
|
|
17936
|
-
type UpdateApiToken = Schemas$
|
|
17937
|
-
type TokenExpiration = Schemas$
|
|
17938
|
-
type ApiTokenPage = Schemas$
|
|
18700
|
+
type Schemas$21 = components["schemas"];
|
|
18701
|
+
type ApiToken = Schemas$21["ApiToken"];
|
|
18702
|
+
type ApiTokenWithJWT = Schemas$21["ApiTokenWithJWT"];
|
|
18703
|
+
type ApiTokenType = Schemas$21["ApiTokenType"];
|
|
18704
|
+
type CreateApiToken = Schemas$21["CreateApiToken"];
|
|
18705
|
+
type UpdateApiToken = Schemas$21["UpdateApiToken"];
|
|
18706
|
+
type TokenExpiration = Schemas$21["TokenExpiration"];
|
|
18707
|
+
type ApiTokenPage = Schemas$21["ApiTokenPage"];
|
|
17939
18708
|
//#endregion
|
|
17940
18709
|
//#region src/datatypes/artifact.d.ts
|
|
17941
|
-
type Schemas$
|
|
17942
|
-
type ArtifactSet = Schemas$
|
|
17943
|
-
type Layout = Schemas$
|
|
17944
|
-
type LayoutBlock = Schemas$
|
|
17945
|
-
type LayoutWord = Schemas$
|
|
17946
|
-
type Transcription = Schemas$
|
|
17947
|
-
type TranscriptSegment = Schemas$
|
|
17948
|
-
type TranscriptWord = Schemas$
|
|
17949
|
-
type Tokens = Schemas$
|
|
17950
|
-
type Token = Schemas$
|
|
18710
|
+
type Schemas$20 = components["schemas"];
|
|
18711
|
+
type ArtifactSet = Schemas$20["ArtifactSet"];
|
|
18712
|
+
type Layout = Schemas$20["Layout"];
|
|
18713
|
+
type LayoutBlock = Schemas$20["LayoutBlock"];
|
|
18714
|
+
type LayoutWord = Schemas$20["LayoutWord"];
|
|
18715
|
+
type Transcription = Schemas$20["Transcription"];
|
|
18716
|
+
type TranscriptSegment = Schemas$20["TranscriptSegment"];
|
|
18717
|
+
type TranscriptWord = Schemas$20["TranscriptWord"];
|
|
18718
|
+
type Tokens = Schemas$20["Tokens"];
|
|
18719
|
+
type Token = Schemas$20["Token"];
|
|
17951
18720
|
//#endregion
|
|
17952
18721
|
//#region src/datatypes/audit.d.ts
|
|
17953
|
-
type Schemas$
|
|
17954
|
-
type Audit = Schemas$
|
|
17955
|
-
type DocumentContext = Schemas$
|
|
17956
|
-
type CodecParams = Schemas$
|
|
17957
|
-
type EntityCoRef = Schemas$
|
|
17958
|
-
type Report = Schemas$
|
|
17959
|
-
type EditSet = Schemas$
|
|
17960
|
-
type RasterMode = Schemas$
|
|
17961
|
-
type Dpi = Schemas$
|
|
17962
|
-
type Redaction = Schemas$
|
|
17963
|
-
type Selection = Schemas$
|
|
17964
|
-
type Suppress = Schemas$
|
|
17965
|
-
type ManualIntent = Schemas$
|
|
17966
|
-
type LeakProfile = Schemas$
|
|
17967
|
-
type RuleMatch = Schemas$
|
|
17968
|
-
type Attribution = Schemas$
|
|
17969
|
-
type CitedAttribution = Schemas$
|
|
17970
|
-
type FreeformAttribution = Schemas$
|
|
17971
|
-
type ModelEvent = Schemas$
|
|
17972
|
-
type PatternEvent = Schemas$
|
|
17973
|
-
type Conflict = Schemas$
|
|
17974
|
-
type Contested = Schemas$
|
|
17975
|
-
type Deduplication = Schemas$
|
|
17976
|
-
type Calibration = Schemas$
|
|
17977
|
-
type OperatorId = Schemas$
|
|
17978
|
-
type AuditHash = Schemas$
|
|
17979
|
-
type Category = Schemas$
|
|
18722
|
+
type Schemas$19 = components["schemas"];
|
|
18723
|
+
type Audit = Schemas$19["Audit"];
|
|
18724
|
+
type DocumentContext = Schemas$19["DocumentContext"];
|
|
18725
|
+
type CodecParams = Schemas$19["CodecParams"];
|
|
18726
|
+
type EntityCoRef = Schemas$19["EntityCoRef"];
|
|
18727
|
+
type Report = Schemas$19["Report"];
|
|
18728
|
+
type EditSet = Schemas$19["EditSet"];
|
|
18729
|
+
type RasterMode = Schemas$19["RasterMode"];
|
|
18730
|
+
type Dpi = Schemas$19["Dpi"];
|
|
18731
|
+
type Redaction = Schemas$19["Redaction"];
|
|
18732
|
+
type Selection = Schemas$19["Selection"];
|
|
18733
|
+
type Suppress = Schemas$19["Suppress"];
|
|
18734
|
+
type ManualIntent = Schemas$19["ManualIntent"];
|
|
18735
|
+
type LeakProfile = Schemas$19["LeakProfile"];
|
|
18736
|
+
type RuleMatch = Schemas$19["RuleMatch"];
|
|
18737
|
+
type Attribution = Schemas$19["Attribution"];
|
|
18738
|
+
type CitedAttribution = Schemas$19["CitedAttribution"];
|
|
18739
|
+
type FreeformAttribution = Schemas$19["FreeformAttribution"];
|
|
18740
|
+
type ModelEvent = Schemas$19["ModelEvent"];
|
|
18741
|
+
type PatternEvent = Schemas$19["PatternEvent"];
|
|
18742
|
+
type Conflict = Schemas$19["Conflict"];
|
|
18743
|
+
type Contested = Schemas$19["Contested"];
|
|
18744
|
+
type Deduplication = Schemas$19["Deduplication"];
|
|
18745
|
+
type Calibration = Schemas$19["Calibration"];
|
|
18746
|
+
type OperatorId = Schemas$19["OperatorId"];
|
|
18747
|
+
type AuditHash = Schemas$19["AuditHash"];
|
|
18748
|
+
type Category = Schemas$19["Category"];
|
|
17980
18749
|
/** Half-open `[start, end)` index range. Generated name; a plain uint range. */
|
|
17981
|
-
type RangeOfUint = Schemas$
|
|
17982
|
-
type SourceRef = Schemas$
|
|
17983
|
-
type BoundingBox = Schemas$
|
|
17984
|
-
type Point = Schemas$
|
|
17985
|
-
type Polygon = Schemas$
|
|
17986
|
-
type Dimensions = Schemas$
|
|
17987
|
-
type TimeSpan = Schemas$
|
|
17988
|
-
type TextEntity = Schemas$
|
|
17989
|
-
type TextAuditEvent = Schemas$
|
|
17990
|
-
type TextAuditKind = Schemas$
|
|
17991
|
-
type TextAuditLog = Schemas$
|
|
17992
|
-
type TextHint = Schemas$
|
|
17993
|
-
type TextLocation = Schemas$
|
|
17994
|
-
type TextCoord = Schemas$
|
|
17995
|
-
type DecodedSpan = Schemas$
|
|
17996
|
-
type SourceSpan = Schemas$
|
|
17997
|
-
type TextData = Schemas$
|
|
17998
|
-
type TextModel = Schemas$
|
|
17999
|
-
type TextPattern = Schemas$
|
|
18000
|
-
type TextManual = Schemas$
|
|
18001
|
-
type TextEdit = Schemas$
|
|
18002
|
-
type TextAdd = Schemas$
|
|
18003
|
-
type TextRefinement = Schemas$
|
|
18004
|
-
type TextRetag = Schemas$
|
|
18005
|
-
type ImageEntity = Schemas$
|
|
18006
|
-
type ImageAuditEvent = Schemas$
|
|
18007
|
-
type ImageAuditKind = Schemas$
|
|
18008
|
-
type ImageAuditLog = Schemas$
|
|
18009
|
-
type ImageHint = Schemas$
|
|
18010
|
-
type ImageLocation = Schemas$
|
|
18011
|
-
type ImageData = Schemas$
|
|
18012
|
-
type ImageModel = Schemas$
|
|
18013
|
-
type ImagePattern = Schemas$
|
|
18014
|
-
type ImageManual = Schemas$
|
|
18015
|
-
type ImageEdit = Schemas$
|
|
18016
|
-
type ImageAdd = Schemas$
|
|
18017
|
-
type ImageRefinement = Schemas$
|
|
18018
|
-
type ImageRetag = Schemas$
|
|
18019
|
-
type AudioEntity = Schemas$
|
|
18020
|
-
type AudioAuditEvent = Schemas$
|
|
18021
|
-
type AudioAuditKind = Schemas$
|
|
18022
|
-
type AudioAuditLog = Schemas$
|
|
18023
|
-
type AudioHint = Schemas$
|
|
18024
|
-
type AudioLocation = Schemas$
|
|
18025
|
-
type AudioData = Schemas$
|
|
18026
|
-
type AudioModel = Schemas$
|
|
18027
|
-
type AudioPattern = Schemas$
|
|
18028
|
-
type AudioManual = Schemas$
|
|
18029
|
-
type AudioEdit = Schemas$
|
|
18030
|
-
type AudioAdd = Schemas$
|
|
18031
|
-
type AudioRefinement = Schemas$
|
|
18032
|
-
type AudioRetag = Schemas$
|
|
18033
|
-
type TabularEntity = Schemas$
|
|
18034
|
-
type TabularAuditEvent = Schemas$
|
|
18035
|
-
type TabularAuditKind = Schemas$
|
|
18036
|
-
type TabularAuditLog = Schemas$
|
|
18037
|
-
type TabularHint = Schemas$
|
|
18038
|
-
type TabularLocation = Schemas$
|
|
18039
|
-
type TabularModel = Schemas$
|
|
18040
|
-
type TabularPattern = Schemas$
|
|
18041
|
-
type TabularManual = Schemas$
|
|
18042
|
-
type TabularEdit = Schemas$
|
|
18043
|
-
type TabularAdd = Schemas$
|
|
18044
|
-
type TabularRefinement = Schemas$
|
|
18045
|
-
type TabularRetag = Schemas$
|
|
18750
|
+
type RangeOfUint = Schemas$19["Range_of_uint"];
|
|
18751
|
+
type SourceRef = Schemas$19["SourceRef"];
|
|
18752
|
+
type BoundingBox = Schemas$19["BoundingBox"];
|
|
18753
|
+
type Point = Schemas$19["Point"];
|
|
18754
|
+
type Polygon = Schemas$19["Polygon"];
|
|
18755
|
+
type Dimensions = Schemas$19["Dimensions"];
|
|
18756
|
+
type TimeSpan = Schemas$19["TimeSpan"];
|
|
18757
|
+
type TextEntity = Schemas$19["TextEntity"];
|
|
18758
|
+
type TextAuditEvent = Schemas$19["TextAuditEvent"];
|
|
18759
|
+
type TextAuditKind = Schemas$19["TextAuditKind"];
|
|
18760
|
+
type TextAuditLog = Schemas$19["TextAuditLog"];
|
|
18761
|
+
type TextHint = Schemas$19["TextHint"];
|
|
18762
|
+
type TextLocation = Schemas$19["TextLocation"];
|
|
18763
|
+
type TextCoord = Schemas$19["TextCoord"];
|
|
18764
|
+
type DecodedSpan = Schemas$19["DecodedSpan"];
|
|
18765
|
+
type SourceSpan = Schemas$19["SourceSpan"];
|
|
18766
|
+
type TextData = Schemas$19["TextData"];
|
|
18767
|
+
type TextModel = Schemas$19["TextModel"];
|
|
18768
|
+
type TextPattern = Schemas$19["TextPattern"];
|
|
18769
|
+
type TextManual = Schemas$19["TextManual"];
|
|
18770
|
+
type TextEdit = Schemas$19["TextEdit"];
|
|
18771
|
+
type TextAdd = Schemas$19["TextAdd"];
|
|
18772
|
+
type TextRefinement = Schemas$19["TextRefinement"];
|
|
18773
|
+
type TextRetag = Schemas$19["TextRetag"];
|
|
18774
|
+
type ImageEntity = Schemas$19["ImageEntity"];
|
|
18775
|
+
type ImageAuditEvent = Schemas$19["ImageAuditEvent"];
|
|
18776
|
+
type ImageAuditKind = Schemas$19["ImageAuditKind"];
|
|
18777
|
+
type ImageAuditLog = Schemas$19["ImageAuditLog"];
|
|
18778
|
+
type ImageHint = Schemas$19["ImageHint"];
|
|
18779
|
+
type ImageLocation = Schemas$19["ImageLocation"];
|
|
18780
|
+
type ImageData = Schemas$19["ImageData"];
|
|
18781
|
+
type ImageModel = Schemas$19["ImageModel"];
|
|
18782
|
+
type ImagePattern = Schemas$19["ImagePattern"];
|
|
18783
|
+
type ImageManual = Schemas$19["ImageManual"];
|
|
18784
|
+
type ImageEdit = Schemas$19["ImageEdit"];
|
|
18785
|
+
type ImageAdd = Schemas$19["ImageAdd"];
|
|
18786
|
+
type ImageRefinement = Schemas$19["ImageRefinement"];
|
|
18787
|
+
type ImageRetag = Schemas$19["ImageRetag"];
|
|
18788
|
+
type AudioEntity = Schemas$19["AudioEntity"];
|
|
18789
|
+
type AudioAuditEvent = Schemas$19["AudioAuditEvent"];
|
|
18790
|
+
type AudioAuditKind = Schemas$19["AudioAuditKind"];
|
|
18791
|
+
type AudioAuditLog = Schemas$19["AudioAuditLog"];
|
|
18792
|
+
type AudioHint = Schemas$19["AudioHint"];
|
|
18793
|
+
type AudioLocation = Schemas$19["AudioLocation"];
|
|
18794
|
+
type AudioData = Schemas$19["AudioData"];
|
|
18795
|
+
type AudioModel = Schemas$19["AudioModel"];
|
|
18796
|
+
type AudioPattern = Schemas$19["AudioPattern"];
|
|
18797
|
+
type AudioManual = Schemas$19["AudioManual"];
|
|
18798
|
+
type AudioEdit = Schemas$19["AudioEdit"];
|
|
18799
|
+
type AudioAdd = Schemas$19["AudioAdd"];
|
|
18800
|
+
type AudioRefinement = Schemas$19["AudioRefinement"];
|
|
18801
|
+
type AudioRetag = Schemas$19["AudioRetag"];
|
|
18802
|
+
type TabularEntity = Schemas$19["TabularEntity"];
|
|
18803
|
+
type TabularAuditEvent = Schemas$19["TabularAuditEvent"];
|
|
18804
|
+
type TabularAuditKind = Schemas$19["TabularAuditKind"];
|
|
18805
|
+
type TabularAuditLog = Schemas$19["TabularAuditLog"];
|
|
18806
|
+
type TabularHint = Schemas$19["TabularHint"];
|
|
18807
|
+
type TabularLocation = Schemas$19["TabularLocation"];
|
|
18808
|
+
type TabularModel = Schemas$19["TabularModel"];
|
|
18809
|
+
type TabularPattern = Schemas$19["TabularPattern"];
|
|
18810
|
+
type TabularManual = Schemas$19["TabularManual"];
|
|
18811
|
+
type TabularEdit = Schemas$19["TabularEdit"];
|
|
18812
|
+
type TabularAdd = Schemas$19["TabularAdd"];
|
|
18813
|
+
type TabularRefinement = Schemas$19["TabularRefinement"];
|
|
18814
|
+
type TabularRetag = Schemas$19["TabularRetag"];
|
|
18046
18815
|
//#endregion
|
|
18047
18816
|
//#region src/datatypes/auth.d.ts
|
|
18048
|
-
type Schemas$
|
|
18049
|
-
type Login = Schemas$
|
|
18050
|
-
type Signup = Schemas$
|
|
18051
|
-
type DesktopTokenRequest = Schemas$
|
|
18052
|
-
type DesktopToken = Schemas$
|
|
18817
|
+
type Schemas$18 = components["schemas"];
|
|
18818
|
+
type Login = Schemas$18["Login"];
|
|
18819
|
+
type Signup = Schemas$18["Signup"];
|
|
18820
|
+
type DesktopTokenRequest = Schemas$18["DesktopTokenRequest"];
|
|
18821
|
+
type DesktopToken = Schemas$18["DesktopToken"];
|
|
18053
18822
|
//#endregion
|
|
18054
18823
|
//#region src/datatypes/catalog.d.ts
|
|
18055
|
-
type Schemas$
|
|
18824
|
+
type Schemas$17 = components["schemas"];
|
|
18056
18825
|
/** Registry of the deployment's built-in labels, keyed by id. */
|
|
18057
|
-
type LabelCatalog = Schemas$
|
|
18826
|
+
type LabelCatalog = Schemas$17["LabelCatalog"];
|
|
18058
18827
|
/** The engine's registered recognizers, grouped into NER and LLM. */
|
|
18059
|
-
type RecognizerCatalog = Schemas$
|
|
18060
|
-
type RegisteredRecognizer = Schemas$
|
|
18828
|
+
type RecognizerCatalog = Schemas$17["RecognizerCatalog"];
|
|
18829
|
+
type RegisteredRecognizer = Schemas$17["RegisteredRecognizer"];
|
|
18061
18830
|
/** Which connector families and providers this deployment can create. */
|
|
18062
|
-
type ConnectorCatalog = Schemas$
|
|
18063
|
-
type FileProviders = Schemas$
|
|
18831
|
+
type ConnectorCatalog = Schemas$17["ConnectorCatalog"];
|
|
18832
|
+
type FileProviders = Schemas$17["FileProviders"];
|
|
18064
18833
|
//#endregion
|
|
18065
18834
|
//#region src/datatypes/chat.d.ts
|
|
18066
|
-
type Schemas$
|
|
18067
|
-
type ChatSession = Schemas$
|
|
18068
|
-
type ChatSessionPage = Schemas$
|
|
18069
|
-
type CreateChatSession = Schemas$
|
|
18070
|
-
type ChatMessage = Schemas$
|
|
18071
|
-
type ChatRole = Schemas$
|
|
18072
|
-
type SendChatMessage = Schemas$
|
|
18073
|
-
type ChatToken = Schemas$
|
|
18835
|
+
type Schemas$16 = components["schemas"];
|
|
18836
|
+
type ChatSession = Schemas$16["ChatSession"];
|
|
18837
|
+
type ChatSessionPage = Schemas$16["ChatSessionPage"];
|
|
18838
|
+
type CreateChatSession = Schemas$16["CreateChatSession"];
|
|
18839
|
+
type ChatMessage = Schemas$16["ChatMessage"];
|
|
18840
|
+
type ChatRole = Schemas$16["ChatRole"];
|
|
18841
|
+
type SendChatMessage = Schemas$16["SendChatMessage"];
|
|
18842
|
+
type ChatToken = Schemas$16["ChatToken"];
|
|
18074
18843
|
//#endregion
|
|
18075
18844
|
//#region src/datatypes/connection.d.ts
|
|
18076
|
-
type Schemas$
|
|
18077
|
-
type ConnectionId = Schemas$
|
|
18078
|
-
type Connection = Schemas$
|
|
18079
|
-
type
|
|
18080
|
-
type
|
|
18081
|
-
type
|
|
18082
|
-
type
|
|
18083
|
-
type
|
|
18084
|
-
type
|
|
18085
|
-
type
|
|
18086
|
-
type
|
|
18087
|
-
type
|
|
18088
|
-
type
|
|
18089
|
-
type
|
|
18090
|
-
type
|
|
18091
|
-
type
|
|
18092
|
-
type
|
|
18093
|
-
type
|
|
18094
|
-
type
|
|
18095
|
-
type
|
|
18096
|
-
type
|
|
18097
|
-
type
|
|
18098
|
-
type
|
|
18099
|
-
type
|
|
18100
|
-
type
|
|
18101
|
-
type
|
|
18102
|
-
type
|
|
18103
|
-
type
|
|
18104
|
-
type
|
|
18105
|
-
type
|
|
18106
|
-
type
|
|
18107
|
-
type
|
|
18108
|
-
type
|
|
18845
|
+
type Schemas$15 = components["schemas"];
|
|
18846
|
+
type ConnectionId = Schemas$15["ConnectionId"];
|
|
18847
|
+
type Connection = Schemas$15["Connection"];
|
|
18848
|
+
type ConnectionType = Schemas$15["ConnectionType"];
|
|
18849
|
+
type CreateConnection = Schemas$15["CreateConnection"];
|
|
18850
|
+
type UpdateConnection = Schemas$15["UpdateConnection"];
|
|
18851
|
+
type ConnectionsQuery = Schemas$15["ConnectionsQuery"];
|
|
18852
|
+
type ConnectionPage = Schemas$15["ConnectionPage"];
|
|
18853
|
+
type ConnectionSync = Schemas$15["ConnectionSync"];
|
|
18854
|
+
type ConnectionSyncPage = Schemas$15["ConnectionSyncPage"];
|
|
18855
|
+
type ConnectionVerification = Schemas$15["ConnectionVerification"];
|
|
18856
|
+
type ImportFiles = Schemas$15["ImportFiles"];
|
|
18857
|
+
type PickedFile = Schemas$15["PickedFile"];
|
|
18858
|
+
type ExportFiles = Schemas$15["ExportFiles"];
|
|
18859
|
+
type PickerTokenRequest = Schemas$15["PickerTokenRequest"];
|
|
18860
|
+
type PickerToken = Schemas$15["PickerToken"];
|
|
18861
|
+
type SyncMode = Schemas$15["SyncMode"];
|
|
18862
|
+
type SyncStatus = Schemas$15["SyncStatus"];
|
|
18863
|
+
type SyncTriggerType = Schemas$15["SyncTriggerType"];
|
|
18864
|
+
type SyncDeletionPolicy = Schemas$15["SyncDeletionPolicy"];
|
|
18865
|
+
type ConnectionConfig = Schemas$15["ConnectionConfig"];
|
|
18866
|
+
type StorageConfig = Schemas$15["StorageConfig"];
|
|
18867
|
+
type S3Credentials = Schemas$15["S3Credentials"];
|
|
18868
|
+
type AzureCredentials = Schemas$15["AzureCredentials"];
|
|
18869
|
+
type GcsCredentials = Schemas$15["GcsCredentials"];
|
|
18870
|
+
type LlmConfig = Schemas$15["LlmConfig"];
|
|
18871
|
+
type AuthenticatedProvider = Schemas$15["AuthenticatedProvider"];
|
|
18872
|
+
type UnauthenticatedProvider = Schemas$15["UnauthenticatedProvider"];
|
|
18873
|
+
type FileServiceProvider = Schemas$15["FileServiceProvider"];
|
|
18874
|
+
type FileServiceConfig = Schemas$15["FileServiceConfig"];
|
|
18875
|
+
type OAuthTokens = Schemas$15["OAuthTokens"];
|
|
18876
|
+
type StartFileServiceOAuth = Schemas$15["StartFileServiceOAuth"];
|
|
18877
|
+
type OAuthStartResponse = Schemas$15["OAuthStartResponse"];
|
|
18878
|
+
type SyncSchedule = Schemas$15["SyncSchedule"];
|
|
18879
|
+
type SyncScheduleInput = Schemas$15["SyncScheduleInput"];
|
|
18109
18880
|
//#endregion
|
|
18110
18881
|
//#region src/datatypes/detection.d.ts
|
|
18111
|
-
type Schemas$
|
|
18112
|
-
type DetectionId = Schemas$
|
|
18113
|
-
type Detection = Schemas$
|
|
18114
|
-
type DetectionMetadata = Schemas$
|
|
18115
|
-
type CreateDetection = Schemas$
|
|
18116
|
-
type DetectionStatus = Schemas$
|
|
18117
|
-
type DetectionPage = Schemas$
|
|
18118
|
-
type WorkspaceDetectionsQuery = Schemas$
|
|
18119
|
-
type PipelineDetectionsQuery = Schemas$
|
|
18120
|
-
type DetectionStatusEvent = Schemas$
|
|
18121
|
-
type RedactionId = Schemas$
|
|
18122
|
-
type RedactDetection = Schemas$
|
|
18123
|
-
type RedactionResult = Schemas$
|
|
18124
|
-
type RedactionResultPage = Schemas$
|
|
18882
|
+
type Schemas$14 = components["schemas"];
|
|
18883
|
+
type DetectionId = Schemas$14["DetectionId"];
|
|
18884
|
+
type Detection = Schemas$14["Detection"];
|
|
18885
|
+
type DetectionMetadata = Schemas$14["DetectionMetadata"];
|
|
18886
|
+
type CreateDetection = Schemas$14["CreateDetection"];
|
|
18887
|
+
type DetectionStatus = Schemas$14["DetectionStatus"];
|
|
18888
|
+
type DetectionPage = Schemas$14["DetectionPage"];
|
|
18889
|
+
type WorkspaceDetectionsQuery = Schemas$14["WorkspaceDetectionsQuery"];
|
|
18890
|
+
type PipelineDetectionsQuery = Schemas$14["PipelineDetectionsQuery"];
|
|
18891
|
+
type DetectionStatusEvent = Schemas$14["DetectionStatusEvent"];
|
|
18892
|
+
type RedactionId = Schemas$14["RedactionId"];
|
|
18893
|
+
type RedactDetection = Schemas$14["RedactDetection"];
|
|
18894
|
+
type RedactionResult = Schemas$14["RedactionResult"];
|
|
18895
|
+
type RedactionResultPage = Schemas$14["RedactionResultPage"];
|
|
18125
18896
|
//#endregion
|
|
18126
18897
|
//#region src/datatypes/error.d.ts
|
|
18127
|
-
type Schemas$
|
|
18128
|
-
type ErrorResponse = Schemas$
|
|
18129
|
-
type ValidationErrorDetail = Schemas$
|
|
18898
|
+
type Schemas$13 = components["schemas"];
|
|
18899
|
+
type ErrorResponse = Schemas$13["ErrorResponse"];
|
|
18900
|
+
type ValidationErrorDetail = Schemas$13["ValidationErrorDetail"];
|
|
18130
18901
|
//#endregion
|
|
18131
18902
|
//#region src/datatypes/export.d.ts
|
|
18132
|
-
type Schemas$
|
|
18133
|
-
type ExportFormat = Schemas$
|
|
18134
|
-
type ExportQuery = Schemas$
|
|
18135
|
-
type DateWindow = Schemas$
|
|
18903
|
+
type Schemas$12 = components["schemas"];
|
|
18904
|
+
type ExportFormat = Schemas$12["ExportFormat"];
|
|
18905
|
+
type ExportQuery = Schemas$12["ExportQuery"];
|
|
18906
|
+
type DateWindow = Schemas$12["DateWindow"];
|
|
18136
18907
|
//#endregion
|
|
18137
18908
|
//#region src/datatypes/file.d.ts
|
|
18138
|
-
type Schemas$
|
|
18139
|
-
type File = Schemas$
|
|
18140
|
-
type UpdateFile = Schemas$
|
|
18141
|
-
type FileKind = Schemas$
|
|
18142
|
-
type FileHash = Schemas$
|
|
18143
|
-
type FormatToken = Schemas$
|
|
18144
|
-
type ModalityToken = Schemas$
|
|
18145
|
-
type ListFiles = Schemas$
|
|
18146
|
-
type FilePage = Schemas$
|
|
18147
|
-
type DeleteFiles = Schemas$
|
|
18148
|
-
type DeletedFiles = Schemas$
|
|
18909
|
+
type Schemas$11 = components["schemas"];
|
|
18910
|
+
type File = Schemas$11["File"];
|
|
18911
|
+
type UpdateFile = Schemas$11["UpdateFile"];
|
|
18912
|
+
type FileKind = Schemas$11["FileKind"];
|
|
18913
|
+
type FileHash = Schemas$11["FileHash"];
|
|
18914
|
+
type FormatToken = Schemas$11["FormatToken"];
|
|
18915
|
+
type ModalityToken = Schemas$11["ModalityToken"];
|
|
18916
|
+
type ListFiles = Schemas$11["ListFiles"];
|
|
18917
|
+
type FilePage = Schemas$11["FilePage"];
|
|
18918
|
+
type DeleteFiles = Schemas$11["DeleteFiles"];
|
|
18919
|
+
type DeletedFiles = Schemas$11["DeletedFiles"];
|
|
18149
18920
|
//#endregion
|
|
18150
18921
|
//#region src/datatypes/health.d.ts
|
|
18151
|
-
type Schemas$
|
|
18152
|
-
type Health = Schemas$
|
|
18153
|
-
type HealthStatus = Schemas$
|
|
18154
|
-
type ComponentHealth = Schemas$
|
|
18922
|
+
type Schemas$10 = components["schemas"];
|
|
18923
|
+
type Health = Schemas$10["Health"];
|
|
18924
|
+
type HealthStatus = Schemas$10["HealthStatus"];
|
|
18925
|
+
type ComponentHealth = Schemas$10["ComponentHealth"];
|
|
18155
18926
|
//#endregion
|
|
18156
18927
|
//#region src/datatypes/invite.d.ts
|
|
18157
|
-
type Schemas$
|
|
18158
|
-
type Invite = Schemas$
|
|
18159
|
-
type InviteSent = Schemas$
|
|
18160
|
-
type CreateInvite = Schemas$
|
|
18161
|
-
type ReplyInvite = Schemas$
|
|
18162
|
-
type GenerateInviteCode = Schemas$
|
|
18163
|
-
type InviteCode = Schemas$
|
|
18164
|
-
type InviteStatus = Schemas$
|
|
18165
|
-
type InviteExpiration = Schemas$
|
|
18166
|
-
type ListInvites = Schemas$
|
|
18167
|
-
type InviteSortField = Schemas$
|
|
18168
|
-
type SortOrder = Schemas$
|
|
18169
|
-
type InvitePreview = Schemas$
|
|
18170
|
-
type InvitePage = Schemas$
|
|
18928
|
+
type Schemas$9 = components["schemas"];
|
|
18929
|
+
type Invite = Schemas$9["Invite"];
|
|
18930
|
+
type InviteSent = Schemas$9["InviteSent"];
|
|
18931
|
+
type CreateInvite = Schemas$9["CreateInvite"];
|
|
18932
|
+
type ReplyInvite = Schemas$9["ReplyInvite"];
|
|
18933
|
+
type GenerateInviteCode = Schemas$9["GenerateInviteCode"];
|
|
18934
|
+
type InviteCode = Schemas$9["InviteCode"];
|
|
18935
|
+
type InviteStatus = Schemas$9["InviteStatus"];
|
|
18936
|
+
type InviteExpiration = Schemas$9["InviteExpiration"];
|
|
18937
|
+
type ListInvites = Schemas$9["ListInvites"];
|
|
18938
|
+
type InviteSortField = Schemas$9["InviteSortField"];
|
|
18939
|
+
type SortOrder = Schemas$9["SortOrder"];
|
|
18940
|
+
type InvitePreview = Schemas$9["InvitePreview"];
|
|
18941
|
+
type InvitePage = Schemas$9["InvitePage"];
|
|
18171
18942
|
//#endregion
|
|
18172
18943
|
//#region src/datatypes/member.d.ts
|
|
18173
|
-
type Schemas$
|
|
18174
|
-
type Member = Schemas$
|
|
18175
|
-
type UpdateMember = Schemas$
|
|
18176
|
-
type ListMembers = Schemas$
|
|
18177
|
-
type MemberSortField = Schemas$
|
|
18178
|
-
type MemberPage = Schemas$
|
|
18944
|
+
type Schemas$8 = components["schemas"];
|
|
18945
|
+
type Member = Schemas$8["Member"];
|
|
18946
|
+
type UpdateMember = Schemas$8["UpdateMember"];
|
|
18947
|
+
type ListMembers = Schemas$8["ListMembers"];
|
|
18948
|
+
type MemberSortField = Schemas$8["MemberSortField"];
|
|
18949
|
+
type MemberPage = Schemas$8["MemberPage"];
|
|
18179
18950
|
//#endregion
|
|
18180
18951
|
//#region src/datatypes/notification.d.ts
|
|
18181
|
-
type Schemas$
|
|
18182
|
-
type Notification = Schemas$
|
|
18183
|
-
type NotificationEvent = Schemas$
|
|
18184
|
-
type NotificationSettings = Schemas$
|
|
18185
|
-
type UpdateNotificationSettings = Schemas$
|
|
18186
|
-
type UnreadStatus = Schemas$
|
|
18187
|
-
type NotificationPage = Schemas$
|
|
18188
|
-
type MarkedReadStatus = Schemas$
|
|
18189
|
-
type UnreadCountEvent = Schemas$
|
|
18190
|
-
type NotificationPayload = Schemas$
|
|
18191
|
-
type MemberInvitedParams = Schemas$
|
|
18192
|
-
type MemberJoinedParams = Schemas$
|
|
18193
|
-
type ConnectionSyncCompletedParams = Schemas$
|
|
18194
|
-
type ConnectionSyncFailedParams = Schemas$
|
|
18195
|
-
type DetectionCompletedParams = Schemas$
|
|
18196
|
-
type DetectionFailedParams = Schemas$
|
|
18197
|
-
type RedactionCreatedParams = Schemas$
|
|
18952
|
+
type Schemas$7 = components["schemas"];
|
|
18953
|
+
type Notification = Schemas$7["Notification"];
|
|
18954
|
+
type NotificationEvent = Schemas$7["NotificationEvent"];
|
|
18955
|
+
type NotificationSettings = Schemas$7["NotificationSettings"];
|
|
18956
|
+
type UpdateNotificationSettings = Schemas$7["UpdateNotificationSettings"];
|
|
18957
|
+
type UnreadStatus = Schemas$7["UnreadStatus"];
|
|
18958
|
+
type NotificationPage = Schemas$7["NotificationPage"];
|
|
18959
|
+
type MarkedReadStatus = Schemas$7["MarkedReadStatus"];
|
|
18960
|
+
type UnreadCountEvent = Schemas$7["UnreadCountEvent"];
|
|
18961
|
+
type NotificationPayload = Schemas$7["NotificationPayload"];
|
|
18962
|
+
type MemberInvitedParams = Schemas$7["MemberInvitedParams"];
|
|
18963
|
+
type MemberJoinedParams = Schemas$7["MemberJoinedParams"];
|
|
18964
|
+
type ConnectionSyncCompletedParams = Schemas$7["ConnectionSyncCompletedParams"];
|
|
18965
|
+
type ConnectionSyncFailedParams = Schemas$7["ConnectionSyncFailedParams"];
|
|
18966
|
+
type DetectionCompletedParams = Schemas$7["DetectionCompletedParams"];
|
|
18967
|
+
type DetectionFailedParams = Schemas$7["DetectionFailedParams"];
|
|
18968
|
+
type RedactionCreatedParams = Schemas$7["RedactionCreatedParams"];
|
|
18198
18969
|
//#endregion
|
|
18199
18970
|
//#region src/datatypes/pagination.d.ts
|
|
18200
|
-
type Schemas$
|
|
18201
|
-
type CursorPagination = Schemas$
|
|
18971
|
+
type Schemas$6 = components["schemas"];
|
|
18972
|
+
type CursorPagination = Schemas$6["CursorPagination"];
|
|
18202
18973
|
//#endregion
|
|
18203
18974
|
//#region src/datatypes/pipeline.d.ts
|
|
18204
|
-
type Schemas$
|
|
18205
|
-
type Pipeline = Schemas$
|
|
18206
|
-
type CreatePipeline = Schemas$
|
|
18207
|
-
type UpdatePipeline = Schemas$
|
|
18208
|
-
type PipelineDefinition = Schemas$
|
|
18209
|
-
type PipelineFilter = Schemas$
|
|
18210
|
-
type PipelineStatus = Schemas$
|
|
18211
|
-
type PipelineTriggerType = Schemas$
|
|
18212
|
-
type PipelineSummary = Schemas$
|
|
18213
|
-
type PipelineSummaryPage = Schemas$
|
|
18975
|
+
type Schemas$5 = components["schemas"];
|
|
18976
|
+
type Pipeline = Schemas$5["Pipeline"];
|
|
18977
|
+
type CreatePipeline = Schemas$5["CreatePipeline"];
|
|
18978
|
+
type UpdatePipeline = Schemas$5["UpdatePipeline"];
|
|
18979
|
+
type PipelineDefinition = Schemas$5["PipelineDefinition"];
|
|
18980
|
+
type PipelineFilter = Schemas$5["PipelineFilter"];
|
|
18981
|
+
type PipelineStatus = Schemas$5["PipelineStatus"];
|
|
18982
|
+
type PipelineTriggerType = Schemas$5["PipelineTriggerType"];
|
|
18983
|
+
type PipelineSummary = Schemas$5["PipelineSummary"];
|
|
18984
|
+
type PipelineSummaryPage = Schemas$5["PipelineSummaryPage"];
|
|
18214
18985
|
//#endregion
|
|
18215
18986
|
//#region src/datatypes/policy.d.ts
|
|
18987
|
+
type Schemas$4 = components["schemas"];
|
|
18988
|
+
type Policy = Schemas$4["Policy"];
|
|
18989
|
+
type PolicySummary = Schemas$4["PolicySummary"];
|
|
18990
|
+
type PolicySummaryPage = Schemas$4["PolicySummaryPage"];
|
|
18991
|
+
type PolicyDefinition = Schemas$4["PolicyDefinition"];
|
|
18992
|
+
type PolicyDraft = Schemas$4["PolicyDraft"];
|
|
18993
|
+
type CreatePolicy = Schemas$4["CreatePolicy"];
|
|
18994
|
+
type UpdatePolicy = Schemas$4["UpdatePolicy"];
|
|
18995
|
+
type PolicyRule = Schemas$4["PolicyRule"];
|
|
18996
|
+
type CustomMatcher = Schemas$4["CustomMatcher"];
|
|
18997
|
+
type PolicyTemplate = Schemas$4["PolicyTemplate"];
|
|
18998
|
+
type TemplateOrigin = Schemas$4["TemplateOrigin"];
|
|
18999
|
+
type HipaaDeidMethod = Schemas$4["HipaaDeidMethod"];
|
|
19000
|
+
type HipaaAccountNumbers = Schemas$4["HipaaAccountNumbers"];
|
|
19001
|
+
type GdprArticle9Treatment = Schemas$4["GdprArticle9Treatment"];
|
|
19002
|
+
type GdprSensitiveScope = Schemas$4["GdprSensitiveScope"];
|
|
19003
|
+
type PciDssPart = Schemas$4["PciDssPart"];
|
|
19004
|
+
type PciPanRender = Schemas$4["PciPanRender"];
|
|
19005
|
+
type Predicate = Schemas$4["Predicate"];
|
|
19006
|
+
type ModalityRedactions = Schemas$4["ModalityRedactions"];
|
|
19007
|
+
type TextRedaction = Schemas$4["TextRedaction"];
|
|
19008
|
+
type ImageRedaction = Schemas$4["ImageRedaction"];
|
|
19009
|
+
type AudioRedaction = Schemas$4["AudioRedaction"];
|
|
19010
|
+
type TabularRedaction = Schemas$4["TabularRedaction"];
|
|
19011
|
+
type LabelScope = Schemas$4["LabelScope"];
|
|
19012
|
+
type LabelEntry = Schemas$4["LabelEntry"];
|
|
19013
|
+
type LabelLocale = Schemas$4["LabelLocale"];
|
|
19014
|
+
type Label = Schemas$4["Label"];
|
|
19015
|
+
type LabelRef = Schemas$4["LabelRef"];
|
|
19016
|
+
type LocalizedText = Schemas$4["LocalizedText"];
|
|
19017
|
+
type Color = Schemas$4["Color"];
|
|
19018
|
+
type Waveform = Schemas$4["Waveform"];
|
|
19019
|
+
type ClampBucket = Schemas$4["ClampBucket"];
|
|
19020
|
+
type ConfidenceThreshold = Schemas$4["ConfidenceThreshold"];
|
|
19021
|
+
type DateStyle = Schemas$4["DateStyle"];
|
|
19022
|
+
type DateGranularity = Schemas$4["DateGranularity"];
|
|
19023
|
+
type LanguageTag = Schemas$4["LanguageTag"];
|
|
19024
|
+
type Sha2Algorithm = Schemas$4["Sha2Algorithm"];
|
|
19025
|
+
type TerminalFallback = Schemas$4["TerminalFallback"];
|
|
19026
|
+
//#endregion
|
|
19027
|
+
//#region src/datatypes/provider.d.ts
|
|
18216
19028
|
type Schemas$3 = components["schemas"];
|
|
18217
|
-
type
|
|
18218
|
-
type
|
|
18219
|
-
type
|
|
18220
|
-
type
|
|
18221
|
-
type
|
|
18222
|
-
type
|
|
18223
|
-
type
|
|
18224
|
-
type
|
|
18225
|
-
type
|
|
18226
|
-
type PolicyTemplate = Schemas$3["PolicyTemplate"];
|
|
18227
|
-
type TemplateOrigin = Schemas$3["TemplateOrigin"];
|
|
18228
|
-
type HipaaDeidMethod = Schemas$3["HipaaDeidMethod"];
|
|
18229
|
-
type HipaaAccountNumbers = Schemas$3["HipaaAccountNumbers"];
|
|
18230
|
-
type GdprArticle9Treatment = Schemas$3["GdprArticle9Treatment"];
|
|
18231
|
-
type GdprSensitiveScope = Schemas$3["GdprSensitiveScope"];
|
|
18232
|
-
type PciDssPart = Schemas$3["PciDssPart"];
|
|
18233
|
-
type PciPanRender = Schemas$3["PciPanRender"];
|
|
18234
|
-
type Predicate = Schemas$3["Predicate"];
|
|
18235
|
-
type ModalityRedactions = Schemas$3["ModalityRedactions"];
|
|
18236
|
-
type TextRedaction = Schemas$3["TextRedaction"];
|
|
18237
|
-
type ImageRedaction = Schemas$3["ImageRedaction"];
|
|
18238
|
-
type AudioRedaction = Schemas$3["AudioRedaction"];
|
|
18239
|
-
type TabularRedaction = Schemas$3["TabularRedaction"];
|
|
18240
|
-
type LabelScope = Schemas$3["LabelScope"];
|
|
18241
|
-
type LabelEntry = Schemas$3["LabelEntry"];
|
|
18242
|
-
type LabelLocale = Schemas$3["LabelLocale"];
|
|
18243
|
-
type Label = Schemas$3["Label"];
|
|
18244
|
-
type LabelRef = Schemas$3["LabelRef"];
|
|
18245
|
-
type LocalizedText = Schemas$3["LocalizedText"];
|
|
18246
|
-
type Color = Schemas$3["Color"];
|
|
18247
|
-
type Waveform = Schemas$3["Waveform"];
|
|
18248
|
-
type ClampBucket = Schemas$3["ClampBucket"];
|
|
18249
|
-
type ConfidenceThreshold = Schemas$3["ConfidenceThreshold"];
|
|
18250
|
-
type DateStyle = Schemas$3["DateStyle"];
|
|
18251
|
-
type DateGranularity = Schemas$3["DateGranularity"];
|
|
18252
|
-
type LanguageTag = Schemas$3["LanguageTag"];
|
|
18253
|
-
type Sha2Algorithm = Schemas$3["Sha2Algorithm"];
|
|
18254
|
-
type TerminalFallback = Schemas$3["TerminalFallback"];
|
|
19029
|
+
type ProviderId = Schemas$3["ProviderId"];
|
|
19030
|
+
type Provider = Schemas$3["Provider"];
|
|
19031
|
+
type CreateProvider = Schemas$3["CreateProvider"];
|
|
19032
|
+
type UpdateProvider = Schemas$3["UpdateProvider"];
|
|
19033
|
+
type ProvidersQuery = Schemas$3["ProvidersQuery"];
|
|
19034
|
+
type ProviderPage = Schemas$3["ProviderPage"];
|
|
19035
|
+
type ProviderType = Schemas$3["ProviderType"];
|
|
19036
|
+
type ProviderConfig = Schemas$3["ProviderConfig"];
|
|
19037
|
+
type InferenceConfig = Schemas$3["InferenceConfig"];
|
|
18255
19038
|
//#endregion
|
|
18256
19039
|
//#region src/datatypes/scope.d.ts
|
|
18257
19040
|
type Schemas$2 = components["schemas"];
|
|
@@ -18289,5 +19072,5 @@ type Retention = Schemas["Retention"];
|
|
|
18289
19072
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
18290
19073
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
18291
19074
|
//#endregion
|
|
18292
|
-
export {
|
|
18293
|
-
//# sourceMappingURL=index-
|
|
19075
|
+
export { LabelRef as $, ActivityFilterQuery as $a, TabularLocation as $i, CreateConnection as $n, Audit as $r, GenerateInviteCode as $t, Provider as A, ApiToken as Aa, LeakProfile as Ai, Detection as An, FileProviders as Ar, CursorPagination as At, ConfidenceThreshold as B, DetectionTimeSeries as Ba, Report as Bi, RedactionResultPage as Bn, AudioAuditEvent as Br, NotificationPage as Bt, Language as C, LayoutBlock as Ca, ImageHint as Ci, UpdateFile as Cn, paths as Co, ChatRole as Cr, PipelineDefinition as Ct, ScopeMetadata as D, TranscriptSegment as Da, ImagePattern as Di, ErrorResponse as Dn, CreateChatSession as Dr, PipelineSummaryPage as Dt, Languages as E, Tokens as Ea, ImageModel as Ei, ExportQuery as En, ChatToken as Er, PipelineSummary as Et, ProvidersQuery as F, TokenExpiration as Fa, Point as Fi, DetectionStatusEvent as Fn, DesktopTokenRequest as Fr, MarkedReadStatus as Ft, GdprArticle9Treatment as G, StorageKindEntry as Ga, Suppress as Gi, ConnectionConfig as Gn, AudioEntity as Gr, UnreadStatus as Gt, CustomMatcher as H, ModelUsageEntry as Ha, Selection as Hi, AuthenticatedProvider as Hn, AudioAuditLog as Hr, NotificationSettings as Ht, UpdateProvider as I, UpdateApiToken as Ia, Polygon as Ii, PipelineDetectionsQuery as In, Login as Ir, MemberInvitedParams as It, HipaaDeidMethod as J, UsageAnalytics as Ja, TabularAuditKind as Ji, ConnectionSync as Jn, AudioManual as Jr, Member as Jt, GdprSensitiveScope as K, TokenCounts as Ka, TabularAdd as Ki, ConnectionId as Kn, AudioHint as Kr, UpdateNotificationSettings as Kt, AudioRedaction as L, DetectionAnalytics as La, RangeOfUint as Li, RedactDetection as Ln, Signup as Lr, MemberJoinedParams as Lt, ProviderId as M, ApiTokenType as Ma, ModelEvent as Mi, DetectionMetadata as Mn, RecognizerCatalog as Mr, ConnectionSyncFailedParams as Mt, ProviderPage as N, ApiTokenWithJWT as Na, OperatorId as Ni, DetectionPage as Nn, RegisteredRecognizer as Nr, DetectionCompletedParams as Nt, CreateProvider as O, TranscriptWord as Oa, ImageRefinement as Oi, ValidationErrorDetail as On, SendChatMessage as Or, PipelineTriggerType as Ot, ProviderType as P, CreateApiToken as Pa, PatternEvent as Pi, DetectionStatus as Pn, DesktopToken as Pr, DetectionFailedParams as Pt, LabelLocale as Q, ActivityExportOptions as Qa, TabularHint as Qi, ConnectionsQuery as Qn, AudioRetag as Qr, CreateInvite as Qt, ClampBucket as R, DetectionDayEntry as Ra, RasterMode as Ri, RedactionId as Rn, Attribution as Rr, Notification as Rt, CountryCode as S, Layout as Sa, ImageEntity as Si, ModalityToken as Sn, UpdateAccount as So, ChatMessage as Sr, Pipeline as St, LanguageSpan as T, Token as Ta, ImageManual as Ti, ExportFormat as Tn, ChatSessionPage as Tr, PipelineStatus as Tt, DateGranularity as U, RecognizerId as Ua, SourceRef as Ui, AzureCredentials as Un, AudioData as Ur, RedactionCreatedParams as Ut, CreatePolicy as V, ModelUsage as Va, RuleMatch as Vi, WorkspaceDetectionsQuery as Vn, AudioAuditKind as Vr, NotificationPayload as Vt, DateStyle as W, StorageAnalytics as Wa, SourceSpan as Wi, Connection as Wn, AudioEdit as Wr, UnreadCountEvent as Wt, Label as X, WorkspaceAnalytics as Xa, TabularEdit as Xi, ConnectionType as Xn, AudioPattern as Xr, MemberSortField as Xt, ImageRedaction as Y, UsageReport as Ya, TabularAuditLog as Yi, ConnectionSyncPage as Yn, AudioModel as Yr, MemberPage as Yt, LabelEntry as Z, Activity as Za, TabularEntity as Zi, ConnectionVerification as Zn, AudioRefinement as Zr, UpdateMember as Zt, WebhookId as _, TextPattern as _a, ImageAuditEvent as _i, FileHash as _n, Handle as _o, SyncScheduleInput as _r, TerminalFallback as _t, RetentionSettings as a, TextAdd as aa, CodecParams as ai, InviteSent as an, FileActivityParams as ao, LlmConfig as ar, PciPanRender as at, WebhookStatus as b, TimeSpan as ba, ImageData as bi, FormatToken as bn, PublicAccount as bo, UnauthenticatedProvider as br, Waveform as bt, WorkspacePage as c, TextAuditLog as ca, DecodedSpan as ci, ListInvites as cn, PipelineActivityParams as co, PickedFile as cr, PolicyDraft as ct, CreateWebhook as d, TextEdit as da, DocumentContext as di, ComponentHealth as dn, WebhookActivityParams as do, S3Credentials as dr, PolicySummaryPage as dt, TabularManual as ea, AuditHash as ei, Invite as en, ActivityPage as eo, ExportFiles as er, LabelScope as et, TestWebhook as f, TextEntity as fa, Dpi as fi, Health as fn, WorkspaceActivityParams as fo, StartFileServiceOAuth as fr, PolicyTemplate as ft, WebhookEvent as g, TextModel as ga, ImageAdd as gi, File as gn, AccountRef as go, SyncSchedule as gr, TemplateOrigin as gt, WebhookCreated as h, TextManual as ha, FreeformAttribution as hi, DeletedFiles as hn, AccountIdentity as ho, SyncMode as hr, TabularRedaction as ht, RetentionOverride as i, TabularRetag as ia, CitedAttribution as ii, InvitePreview as in, DetectionActivityParams as io, ImportFiles as ir, PciDssPart as it, ProviderConfig as j, ApiTokenPage as ja, ManualIntent as ji, DetectionId as jn, LabelCatalog as jr, ConnectionSyncCompletedParams as jt, InferenceConfig as k, Transcription as ka, ImageRetag as ki, CreateDetection as kn, ConnectorCatalog as kr, UpdatePipeline as kt, WorkspaceRole as l, TextCoord as la, Deduplication as li, ReplyInvite as ln, PolicyActivityParams as lo, PickerToken as lr, PolicyRule as lt, Webhook as m, TextLocation as ma, EntityCoRef as mi, DeleteFiles as mn, AccountIdentities as mo, SyncDeletionPolicy as mr, Sha2Algorithm as mt, RasterPolicy as n, TabularPattern as na, Calibration as ni, InviteExpiration as nn, ActivityType as no, FileServiceProvider as nr, LocalizedText as nt, UpdateWorkspace as o, TextAuditEvent as oa, Conflict as oi, InviteSortField as on, InviteActivityParams as oo, OAuthStartResponse as or, Policy as ot, UpdateWebhook as p, TextHint as pa, EditSet as pi, HealthStatus as pn, Account as po, StorageConfig as pr, Predicate as pt, HipaaAccountNumbers as q, Usage as qa, TabularAuditEvent as qi, ConnectionPage as qn, AudioLocation as qr, ListMembers as qt, Retention as r, TabularRefinement as ra, Category as ri, InvitePage as rn, ConnectionActivityParams as ro, GcsCredentials as rr, ModalityRedactions as rt, Workspace as s, TextAuditKind as sa, Contested as si, InviteStatus as sn, MemberActivityParams as so, OAuthTokens as sr, PolicyDefinition as st, CreateWorkspace as t, TabularModel as ta, BoundingBox as ti, InviteCode as tn, ActivityPayload as to, FileServiceConfig as tr, LanguageTag as tt, WorkspaceSettings as u, TextData as ua, Dimensions as ui, SortOrder as un, RedactionActivityParams as uo, PickerTokenRequest as ur, PolicySummary as ut, WebhookPage as v, TextRefinement as va, ImageAuditKind as vi, FileKind as vn, IdentityProvider as vo, SyncStatus as vr, TextRedaction as vt, LanguageProvenance as w, LayoutWord as wa, ImageLocation as wi, DateWindow as wn, ChatSession as wr, PipelineFilter as wt, Confidence as x, ArtifactSet as xa, ImageEdit as xi, ListFiles as xn, SetPassword as xo, UpdateConnection as xr, CreatePipeline as xt, WebhookResult as y, TextRetag as ya, ImageAuditLog as yi, FilePage as yn, OidcStartResponse as yo, SyncTriggerType as yr, UpdatePolicy as yt, Color as z, DetectionStatusEntry as za, Redaction as zi, RedactionResult as zn, AudioAdd as zr, NotificationEvent as zt };
|
|
19076
|
+
//# sourceMappingURL=index-CNUnM9QG.d.ts.map
|