@amigo-ai/sdk 0.27.0 → 0.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types/generated/api-types.d.ts +231 -223
- package/package.json +1 -1
|
@@ -737,7 +737,7 @@ export interface paths {
|
|
|
737
737
|
patch?: never;
|
|
738
738
|
trace?: never;
|
|
739
739
|
};
|
|
740
|
-
"/v1/{organization}/user/
|
|
740
|
+
"/v1/{organization}/user/invite": {
|
|
741
741
|
parameters: {
|
|
742
742
|
query?: never;
|
|
743
743
|
header?: never;
|
|
@@ -747,39 +747,64 @@ export interface paths {
|
|
|
747
747
|
get?: never;
|
|
748
748
|
put?: never;
|
|
749
749
|
/**
|
|
750
|
-
*
|
|
751
|
-
* @
|
|
750
|
+
* Create a new user
|
|
751
|
+
* @deprecated
|
|
752
|
+
* @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
|
|
753
|
+
* supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
|
|
752
754
|
*
|
|
753
|
-
*
|
|
755
|
+
* If `login_link` is not-`None`, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
|
|
756
|
+
* and start their Amigo experience. Otherwise, no email will be sent.
|
|
757
|
+
*
|
|
758
|
+
* #### Permissions
|
|
759
|
+
* This endpoint requires the following permissions:
|
|
760
|
+
* * `User:InviteUser` on the user to invite.
|
|
761
|
+
* * The authenticated user must have greater privileges than the role assigned to the new user.
|
|
754
762
|
*/
|
|
755
|
-
post: operations["
|
|
763
|
+
post: operations["create-invited-user-deprecated"];
|
|
756
764
|
delete?: never;
|
|
757
765
|
options?: never;
|
|
758
766
|
head?: never;
|
|
759
767
|
patch?: never;
|
|
760
768
|
trace?: never;
|
|
761
769
|
};
|
|
762
|
-
"/v1/{organization}/user/
|
|
770
|
+
"/v1/{organization}/user/": {
|
|
763
771
|
parameters: {
|
|
764
772
|
query?: never;
|
|
765
773
|
header?: never;
|
|
766
774
|
path?: never;
|
|
767
775
|
cookie?: never;
|
|
768
776
|
};
|
|
769
|
-
|
|
777
|
+
/**
|
|
778
|
+
* Get users
|
|
779
|
+
* @description Retrieve all users in an organization.
|
|
780
|
+
*
|
|
781
|
+
* #### Permissions
|
|
782
|
+
* This endpoint is impacted by the following permissions:
|
|
783
|
+
* * Only users that the authenticated user has the `User:GetUserInfo` permission for are returned.
|
|
784
|
+
*/
|
|
785
|
+
get: operations["get-users"];
|
|
770
786
|
put?: never;
|
|
771
787
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @description
|
|
788
|
+
* Create a new user
|
|
789
|
+
* @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
|
|
790
|
+
* supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
|
|
791
|
+
*
|
|
792
|
+
* If `login_link` is not-`None`, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
|
|
793
|
+
* and start their Amigo experience. Otherwise, no email will be sent.
|
|
794
|
+
*
|
|
795
|
+
* #### Permissions
|
|
796
|
+
* This endpoint requires the following permissions:
|
|
797
|
+
* * `User:InviteUser` on the user to invite.
|
|
798
|
+
* * The authenticated user must have greater privileges than the role assigned to the new user.
|
|
774
799
|
*/
|
|
775
|
-
post: operations["
|
|
800
|
+
post: operations["create-invited-user"];
|
|
776
801
|
delete?: never;
|
|
777
802
|
options?: never;
|
|
778
803
|
head?: never;
|
|
779
804
|
patch?: never;
|
|
780
805
|
trace?: never;
|
|
781
806
|
};
|
|
782
|
-
"/v1/{organization}/user/
|
|
807
|
+
"/v1/{organization}/user/signin_with_api_key": {
|
|
783
808
|
parameters: {
|
|
784
809
|
query?: never;
|
|
785
810
|
header?: never;
|
|
@@ -789,29 +814,19 @@ export interface paths {
|
|
|
789
814
|
get?: never;
|
|
790
815
|
put?: never;
|
|
791
816
|
/**
|
|
792
|
-
*
|
|
793
|
-
* @description
|
|
794
|
-
*
|
|
795
|
-
* #### Permissions
|
|
796
|
-
* This endpoint requires the following permissions:
|
|
797
|
-
* * `User:UpdateUserInfo` for the user to update.
|
|
798
|
-
*/
|
|
799
|
-
post: operations["update-user-info"];
|
|
800
|
-
/**
|
|
801
|
-
* Delete an user
|
|
802
|
-
* @description Delete an user. This endpoint deletes the user from the Amigo system.
|
|
817
|
+
* Sign in with API key
|
|
818
|
+
* @description Given an organization API key, issue an authorization token for the specified user. The token should then be attached to the `Authorization` header in subsequent Amigo API calls.
|
|
803
819
|
*
|
|
804
|
-
*
|
|
805
|
-
* This endpoint requires the following permissions:
|
|
806
|
-
* * `User.DeleteUser` on the user to delete.
|
|
820
|
+
* This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.
|
|
807
821
|
*/
|
|
808
|
-
|
|
822
|
+
post: operations["sign-in-with-api-key"];
|
|
823
|
+
delete?: never;
|
|
809
824
|
options?: never;
|
|
810
825
|
head?: never;
|
|
811
826
|
patch?: never;
|
|
812
827
|
trace?: never;
|
|
813
828
|
};
|
|
814
|
-
"/v1/{organization}/user/
|
|
829
|
+
"/v1/{organization}/user/signin": {
|
|
815
830
|
parameters: {
|
|
816
831
|
query?: never;
|
|
817
832
|
header?: never;
|
|
@@ -821,106 +836,91 @@ export interface paths {
|
|
|
821
836
|
get?: never;
|
|
822
837
|
put?: never;
|
|
823
838
|
/**
|
|
824
|
-
*
|
|
825
|
-
* @
|
|
826
|
-
* @description Update information about an user. Only fields that are specified in the request are updated.
|
|
827
|
-
*
|
|
828
|
-
* #### Permissions
|
|
829
|
-
* This endpoint requires the following permissions:
|
|
830
|
-
* * `User:UpdateUserInfo` for the user to update.
|
|
839
|
+
* Sign in with email
|
|
840
|
+
* @description Send a magic link to the user's email to sign in.
|
|
831
841
|
*/
|
|
832
|
-
post: operations["
|
|
842
|
+
post: operations["sign-in-with-email"];
|
|
833
843
|
delete?: never;
|
|
834
844
|
options?: never;
|
|
835
845
|
head?: never;
|
|
836
846
|
patch?: never;
|
|
837
847
|
trace?: never;
|
|
838
848
|
};
|
|
839
|
-
"/v1/{organization}/user/{
|
|
849
|
+
"/v1/{organization}/user/{requested_user_id}/user": {
|
|
840
850
|
parameters: {
|
|
841
851
|
query?: never;
|
|
842
852
|
header?: never;
|
|
843
853
|
path?: never;
|
|
844
854
|
cookie?: never;
|
|
845
855
|
};
|
|
856
|
+
get?: never;
|
|
857
|
+
put?: never;
|
|
846
858
|
/**
|
|
847
|
-
*
|
|
848
|
-
* @
|
|
859
|
+
* Update user info
|
|
860
|
+
* @deprecated
|
|
861
|
+
* @description Update information about an user. Only fields that are specified in the request are updated.
|
|
849
862
|
*
|
|
850
863
|
* #### Permissions
|
|
851
864
|
* This endpoint requires the following permissions:
|
|
852
|
-
* * `User:
|
|
865
|
+
* * `User:UpdateUserInfo` for the user to update.
|
|
853
866
|
*/
|
|
854
|
-
|
|
855
|
-
put?: never;
|
|
856
|
-
post?: never;
|
|
867
|
+
post: operations["update-user-info-deprecated"];
|
|
857
868
|
delete?: never;
|
|
858
869
|
options?: never;
|
|
859
870
|
head?: never;
|
|
860
871
|
patch?: never;
|
|
861
872
|
trace?: never;
|
|
862
873
|
};
|
|
863
|
-
"/v1/{organization}/user/": {
|
|
874
|
+
"/v1/{organization}/user/{requested_user_id}": {
|
|
864
875
|
parameters: {
|
|
865
876
|
query?: never;
|
|
866
877
|
header?: never;
|
|
867
878
|
path?: never;
|
|
868
879
|
cookie?: never;
|
|
869
880
|
};
|
|
881
|
+
get?: never;
|
|
882
|
+
put?: never;
|
|
870
883
|
/**
|
|
871
|
-
*
|
|
872
|
-
* @description
|
|
884
|
+
* Update user info
|
|
885
|
+
* @description Update information about an user. Only fields that are specified in the request are updated.
|
|
873
886
|
*
|
|
874
887
|
* #### Permissions
|
|
875
|
-
* This endpoint
|
|
876
|
-
* *
|
|
888
|
+
* This endpoint requires the following permissions:
|
|
889
|
+
* * `User:UpdateUserInfo` for the user to update.
|
|
877
890
|
*/
|
|
878
|
-
|
|
879
|
-
put?: never;
|
|
891
|
+
post: operations["update-user-info"];
|
|
880
892
|
/**
|
|
881
|
-
*
|
|
882
|
-
* @description
|
|
883
|
-
* supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
|
|
884
|
-
*
|
|
885
|
-
* If `login_link` is not-`None`, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
|
|
886
|
-
* and start their Amigo experience. Otherwise, no email will be sent.
|
|
893
|
+
* Delete an user
|
|
894
|
+
* @description Delete an user. This endpoint deletes the user from the Amigo system.
|
|
887
895
|
*
|
|
888
896
|
* #### Permissions
|
|
889
897
|
* This endpoint requires the following permissions:
|
|
890
|
-
* * `User
|
|
891
|
-
* * The authenticated user must have greater privileges than the role assigned to the new user.
|
|
898
|
+
* * `User.DeleteUser` on the user to delete.
|
|
892
899
|
*/
|
|
893
|
-
|
|
894
|
-
delete?: never;
|
|
900
|
+
delete: operations["delete-user"];
|
|
895
901
|
options?: never;
|
|
896
902
|
head?: never;
|
|
897
903
|
patch?: never;
|
|
898
904
|
trace?: never;
|
|
899
905
|
};
|
|
900
|
-
"/v1/{organization}/user/
|
|
906
|
+
"/v1/{organization}/user/{user_id}/user_model": {
|
|
901
907
|
parameters: {
|
|
902
908
|
query?: never;
|
|
903
909
|
header?: never;
|
|
904
910
|
path?: never;
|
|
905
911
|
cookie?: never;
|
|
906
912
|
};
|
|
907
|
-
get?: never;
|
|
908
|
-
put?: never;
|
|
909
913
|
/**
|
|
910
|
-
*
|
|
911
|
-
* @
|
|
912
|
-
* @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
|
|
913
|
-
* supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
|
|
914
|
-
*
|
|
915
|
-
* If `login_link` is not-`None`, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
|
|
916
|
-
* and start their Amigo experience. Otherwise, no email will be sent.
|
|
914
|
+
* Get user model
|
|
915
|
+
* @description Retrieve the user models for an user.
|
|
917
916
|
*
|
|
918
917
|
* #### Permissions
|
|
919
918
|
* This endpoint requires the following permissions:
|
|
920
|
-
* * `User:
|
|
921
|
-
* * The authenticated user must have greater privileges than the role assigned to the new user.
|
|
919
|
+
* * `User:GetUserModel` for the user to retrieve the user models for.
|
|
922
920
|
*/
|
|
923
|
-
|
|
921
|
+
get: operations["get-user-model"];
|
|
922
|
+
put?: never;
|
|
923
|
+
post?: never;
|
|
924
924
|
delete?: never;
|
|
925
925
|
options?: never;
|
|
926
926
|
head?: never;
|
|
@@ -2305,6 +2305,11 @@ export interface components {
|
|
|
2305
2305
|
* @description The role ID of the creator of this key.
|
|
2306
2306
|
*/
|
|
2307
2307
|
role_id: string;
|
|
2308
|
+
/**
|
|
2309
|
+
* Index
|
|
2310
|
+
* @description The index of this API key, which is an integer between 0 to 19. An org cannot have more than 1 API key with the same index.
|
|
2311
|
+
*/
|
|
2312
|
+
index: number;
|
|
2308
2313
|
};
|
|
2309
2314
|
/** ActionState */
|
|
2310
2315
|
"ActionState-Input": {
|
|
@@ -11409,7 +11414,7 @@ export interface operations {
|
|
|
11409
11414
|
};
|
|
11410
11415
|
};
|
|
11411
11416
|
};
|
|
11412
|
-
"
|
|
11417
|
+
"create-invited-user-deprecated": {
|
|
11413
11418
|
parameters: {
|
|
11414
11419
|
query?: never;
|
|
11415
11420
|
header?: {
|
|
@@ -11422,39 +11427,57 @@ export interface operations {
|
|
|
11422
11427
|
};
|
|
11423
11428
|
cookie?: never;
|
|
11424
11429
|
};
|
|
11425
|
-
requestBody
|
|
11430
|
+
requestBody: {
|
|
11431
|
+
content: {
|
|
11432
|
+
"application/json": components["schemas"]["user__create_invited_user__Request"];
|
|
11433
|
+
};
|
|
11434
|
+
};
|
|
11426
11435
|
responses: {
|
|
11427
|
-
/** @description Succeeded
|
|
11428
|
-
|
|
11436
|
+
/** @description Succeeded */
|
|
11437
|
+
201: {
|
|
11429
11438
|
headers: {
|
|
11430
11439
|
[name: string]: unknown;
|
|
11431
11440
|
};
|
|
11432
11441
|
content: {
|
|
11433
|
-
"application/json": components["schemas"]["
|
|
11442
|
+
"application/json": components["schemas"]["user__create_invited_user__Response"];
|
|
11434
11443
|
};
|
|
11435
11444
|
};
|
|
11436
|
-
/** @description
|
|
11445
|
+
/** @description Invalid authorization credentials. */
|
|
11437
11446
|
401: {
|
|
11438
11447
|
headers: {
|
|
11439
11448
|
[name: string]: unknown;
|
|
11440
11449
|
};
|
|
11441
11450
|
content?: never;
|
|
11442
11451
|
};
|
|
11443
|
-
/** @description
|
|
11452
|
+
/** @description Missing required permissions. */
|
|
11453
|
+
403: {
|
|
11454
|
+
headers: {
|
|
11455
|
+
[name: string]: unknown;
|
|
11456
|
+
};
|
|
11457
|
+
content?: never;
|
|
11458
|
+
};
|
|
11459
|
+
/** @description Specified organization or role is not found. */
|
|
11444
11460
|
404: {
|
|
11445
11461
|
headers: {
|
|
11446
11462
|
[name: string]: unknown;
|
|
11447
11463
|
};
|
|
11448
11464
|
content?: never;
|
|
11449
11465
|
};
|
|
11450
|
-
/** @description
|
|
11466
|
+
/** @description User with the same email already exists in this organization, or a related operation is in progress. */
|
|
11467
|
+
409: {
|
|
11468
|
+
headers: {
|
|
11469
|
+
[name: string]: unknown;
|
|
11470
|
+
};
|
|
11471
|
+
content?: never;
|
|
11472
|
+
};
|
|
11473
|
+
/** @description Invalid request path parameter or request body failed validation. */
|
|
11451
11474
|
422: {
|
|
11452
11475
|
headers: {
|
|
11453
11476
|
[name: string]: unknown;
|
|
11454
11477
|
};
|
|
11455
11478
|
content?: never;
|
|
11456
11479
|
};
|
|
11457
|
-
/** @description The user has exceeded the rate limit of
|
|
11480
|
+
/** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
|
|
11458
11481
|
429: {
|
|
11459
11482
|
headers: {
|
|
11460
11483
|
[name: string]: unknown;
|
|
@@ -11470,9 +11493,22 @@ export interface operations {
|
|
|
11470
11493
|
};
|
|
11471
11494
|
};
|
|
11472
11495
|
};
|
|
11473
|
-
"
|
|
11496
|
+
"get-users": {
|
|
11474
11497
|
parameters: {
|
|
11475
|
-
query?:
|
|
11498
|
+
query?: {
|
|
11499
|
+
/** @description Whether the user is verified. */
|
|
11500
|
+
is_verified?: boolean | null;
|
|
11501
|
+
/** @description The ID of the user. */
|
|
11502
|
+
user_id?: string[];
|
|
11503
|
+
/** @description The email of the user, */
|
|
11504
|
+
email?: string[];
|
|
11505
|
+
/** @description The maximum number of users to retrieve. */
|
|
11506
|
+
limit?: number;
|
|
11507
|
+
/** @description The token from the previous request to return the next page of users. */
|
|
11508
|
+
continuation_token?: number;
|
|
11509
|
+
/** @description The fields to sort the users by. Supported fields are `first_name`, `last_name`, `email`, `user_stats.num_conversations`, `user_stats.num_messages`, and `user_stats.last_message_time`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties. */
|
|
11510
|
+
sort_by?: string[];
|
|
11511
|
+
};
|
|
11476
11512
|
header?: {
|
|
11477
11513
|
/** @description The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database. */
|
|
11478
11514
|
"x-mongo-cluster-name"?: string | null;
|
|
@@ -11483,11 +11519,7 @@ export interface operations {
|
|
|
11483
11519
|
};
|
|
11484
11520
|
cookie?: never;
|
|
11485
11521
|
};
|
|
11486
|
-
requestBody
|
|
11487
|
-
content: {
|
|
11488
|
-
"application/json": components["schemas"]["user__sign_in_with_email__Request"];
|
|
11489
|
-
};
|
|
11490
|
-
};
|
|
11522
|
+
requestBody?: never;
|
|
11491
11523
|
responses: {
|
|
11492
11524
|
/** @description Succeeded. */
|
|
11493
11525
|
200: {
|
|
@@ -11495,23 +11527,44 @@ export interface operations {
|
|
|
11495
11527
|
[name: string]: unknown;
|
|
11496
11528
|
};
|
|
11497
11529
|
content: {
|
|
11498
|
-
"application/json": components["schemas"]["
|
|
11530
|
+
"application/json": components["schemas"]["user__get_users__Response"];
|
|
11499
11531
|
};
|
|
11500
11532
|
};
|
|
11501
|
-
/** @description
|
|
11533
|
+
/** @description Invalid authorization credentials. */
|
|
11534
|
+
401: {
|
|
11535
|
+
headers: {
|
|
11536
|
+
[name: string]: unknown;
|
|
11537
|
+
};
|
|
11538
|
+
content?: never;
|
|
11539
|
+
};
|
|
11540
|
+
/** @description Missing required permissions. */
|
|
11541
|
+
403: {
|
|
11542
|
+
headers: {
|
|
11543
|
+
[name: string]: unknown;
|
|
11544
|
+
};
|
|
11545
|
+
content?: never;
|
|
11546
|
+
};
|
|
11547
|
+
/** @description Specified organization is not found. */
|
|
11502
11548
|
404: {
|
|
11503
11549
|
headers: {
|
|
11504
11550
|
[name: string]: unknown;
|
|
11505
11551
|
};
|
|
11506
11552
|
content?: never;
|
|
11507
11553
|
};
|
|
11508
|
-
/** @description Invalid request path parameter or request
|
|
11554
|
+
/** @description Invalid request path parameter or request query parameter failed validation. */
|
|
11509
11555
|
422: {
|
|
11510
11556
|
headers: {
|
|
11511
11557
|
[name: string]: unknown;
|
|
11512
11558
|
};
|
|
11513
11559
|
content?: never;
|
|
11514
11560
|
};
|
|
11561
|
+
/** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
|
|
11562
|
+
429: {
|
|
11563
|
+
headers: {
|
|
11564
|
+
[name: string]: unknown;
|
|
11565
|
+
};
|
|
11566
|
+
content?: never;
|
|
11567
|
+
};
|
|
11515
11568
|
/** @description The service is going through temporary maintenance. */
|
|
11516
11569
|
503: {
|
|
11517
11570
|
headers: {
|
|
@@ -11521,7 +11574,7 @@ export interface operations {
|
|
|
11521
11574
|
};
|
|
11522
11575
|
};
|
|
11523
11576
|
};
|
|
11524
|
-
"
|
|
11577
|
+
"create-invited-user": {
|
|
11525
11578
|
parameters: {
|
|
11526
11579
|
query?: never;
|
|
11527
11580
|
header?: {
|
|
@@ -11530,24 +11583,24 @@ export interface operations {
|
|
|
11530
11583
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11531
11584
|
};
|
|
11532
11585
|
path: {
|
|
11533
|
-
/** @description The identifier of the user to update information for. */
|
|
11534
|
-
requested_user_id: string;
|
|
11535
11586
|
organization: string;
|
|
11536
11587
|
};
|
|
11537
11588
|
cookie?: never;
|
|
11538
11589
|
};
|
|
11539
11590
|
requestBody: {
|
|
11540
11591
|
content: {
|
|
11541
|
-
"application/json": components["schemas"]["
|
|
11592
|
+
"application/json": components["schemas"]["user__create_invited_user__Request"];
|
|
11542
11593
|
};
|
|
11543
11594
|
};
|
|
11544
11595
|
responses: {
|
|
11545
|
-
/** @description Succeeded
|
|
11546
|
-
|
|
11596
|
+
/** @description Succeeded */
|
|
11597
|
+
201: {
|
|
11547
11598
|
headers: {
|
|
11548
11599
|
[name: string]: unknown;
|
|
11549
11600
|
};
|
|
11550
|
-
content
|
|
11601
|
+
content: {
|
|
11602
|
+
"application/json": components["schemas"]["user__create_invited_user__Response"];
|
|
11603
|
+
};
|
|
11551
11604
|
};
|
|
11552
11605
|
/** @description Invalid authorization credentials. */
|
|
11553
11606
|
401: {
|
|
@@ -11563,14 +11616,14 @@ export interface operations {
|
|
|
11563
11616
|
};
|
|
11564
11617
|
content?: never;
|
|
11565
11618
|
};
|
|
11566
|
-
/** @description Specified organization or
|
|
11619
|
+
/** @description Specified organization or role is not found. */
|
|
11567
11620
|
404: {
|
|
11568
11621
|
headers: {
|
|
11569
11622
|
[name: string]: unknown;
|
|
11570
11623
|
};
|
|
11571
11624
|
content?: never;
|
|
11572
11625
|
};
|
|
11573
|
-
/** @description
|
|
11626
|
+
/** @description User with the same email already exists in this organization, or a related operation is in progress. */
|
|
11574
11627
|
409: {
|
|
11575
11628
|
headers: {
|
|
11576
11629
|
[name: string]: unknown;
|
|
@@ -11600,17 +11653,18 @@ export interface operations {
|
|
|
11600
11653
|
};
|
|
11601
11654
|
};
|
|
11602
11655
|
};
|
|
11603
|
-
"
|
|
11656
|
+
"sign-in-with-api-key": {
|
|
11604
11657
|
parameters: {
|
|
11605
11658
|
query?: never;
|
|
11606
|
-
header
|
|
11659
|
+
header: {
|
|
11660
|
+
"x-api-key": string;
|
|
11661
|
+
"x-api-key-id": string;
|
|
11662
|
+
"x-user-id": string;
|
|
11607
11663
|
/** @description The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database. */
|
|
11608
11664
|
"x-mongo-cluster-name"?: string | null;
|
|
11609
11665
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11610
11666
|
};
|
|
11611
11667
|
path: {
|
|
11612
|
-
/** @description The identifier of the user to delete. */
|
|
11613
|
-
requested_user_id: string;
|
|
11614
11668
|
organization: string;
|
|
11615
11669
|
};
|
|
11616
11670
|
cookie?: never;
|
|
@@ -11618,40 +11672,28 @@ export interface operations {
|
|
|
11618
11672
|
requestBody?: never;
|
|
11619
11673
|
responses: {
|
|
11620
11674
|
/** @description Succeeded. */
|
|
11621
|
-
|
|
11675
|
+
200: {
|
|
11622
11676
|
headers: {
|
|
11623
11677
|
[name: string]: unknown;
|
|
11624
11678
|
};
|
|
11625
|
-
content
|
|
11626
|
-
|
|
11627
|
-
/** @description Invalid authorization credentials. */
|
|
11628
|
-
401: {
|
|
11629
|
-
headers: {
|
|
11630
|
-
[name: string]: unknown;
|
|
11679
|
+
content: {
|
|
11680
|
+
"application/json": components["schemas"]["user__sign_in_with_api_key__Response"];
|
|
11631
11681
|
};
|
|
11632
|
-
content?: never;
|
|
11633
11682
|
};
|
|
11634
|
-
/** @description
|
|
11635
|
-
|
|
11683
|
+
/** @description API key not found, is incorrect, or the requested user is not found. */
|
|
11684
|
+
401: {
|
|
11636
11685
|
headers: {
|
|
11637
11686
|
[name: string]: unknown;
|
|
11638
11687
|
};
|
|
11639
11688
|
content?: never;
|
|
11640
11689
|
};
|
|
11641
|
-
/** @description Specified organization
|
|
11690
|
+
/** @description Specified organization is not found. */
|
|
11642
11691
|
404: {
|
|
11643
11692
|
headers: {
|
|
11644
11693
|
[name: string]: unknown;
|
|
11645
11694
|
};
|
|
11646
11695
|
content?: never;
|
|
11647
11696
|
};
|
|
11648
|
-
/** @description A related operation is in progress. */
|
|
11649
|
-
409: {
|
|
11650
|
-
headers: {
|
|
11651
|
-
[name: string]: unknown;
|
|
11652
|
-
};
|
|
11653
|
-
content?: never;
|
|
11654
|
-
};
|
|
11655
11697
|
/** @description Invalid request path parameter failed validation. */
|
|
11656
11698
|
422: {
|
|
11657
11699
|
headers: {
|
|
@@ -11659,7 +11701,7 @@ export interface operations {
|
|
|
11659
11701
|
};
|
|
11660
11702
|
content?: never;
|
|
11661
11703
|
};
|
|
11662
|
-
/** @description The user has exceeded the rate limit of
|
|
11704
|
+
/** @description The user has exceeded the rate limit of 5 requests per minute for this endpoint. */
|
|
11663
11705
|
429: {
|
|
11664
11706
|
headers: {
|
|
11665
11707
|
[name: string]: unknown;
|
|
@@ -11675,7 +11717,7 @@ export interface operations {
|
|
|
11675
11717
|
};
|
|
11676
11718
|
};
|
|
11677
11719
|
};
|
|
11678
|
-
"
|
|
11720
|
+
"sign-in-with-email": {
|
|
11679
11721
|
parameters: {
|
|
11680
11722
|
query?: never;
|
|
11681
11723
|
header?: {
|
|
@@ -11684,38 +11726,24 @@ export interface operations {
|
|
|
11684
11726
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11685
11727
|
};
|
|
11686
11728
|
path: {
|
|
11687
|
-
/** @description The identifier of the user to update information for. */
|
|
11688
|
-
requested_user_id: string;
|
|
11689
11729
|
organization: string;
|
|
11690
11730
|
};
|
|
11691
11731
|
cookie?: never;
|
|
11692
11732
|
};
|
|
11693
11733
|
requestBody: {
|
|
11694
11734
|
content: {
|
|
11695
|
-
"application/json": components["schemas"]["
|
|
11735
|
+
"application/json": components["schemas"]["user__sign_in_with_email__Request"];
|
|
11696
11736
|
};
|
|
11697
11737
|
};
|
|
11698
11738
|
responses: {
|
|
11699
11739
|
/** @description Succeeded. */
|
|
11700
|
-
|
|
11701
|
-
headers: {
|
|
11702
|
-
[name: string]: unknown;
|
|
11703
|
-
};
|
|
11704
|
-
content?: never;
|
|
11705
|
-
};
|
|
11706
|
-
/** @description Invalid authorization credentials. */
|
|
11707
|
-
401: {
|
|
11740
|
+
200: {
|
|
11708
11741
|
headers: {
|
|
11709
11742
|
[name: string]: unknown;
|
|
11710
11743
|
};
|
|
11711
|
-
content
|
|
11712
|
-
|
|
11713
|
-
/** @description Missing required permissions. */
|
|
11714
|
-
403: {
|
|
11715
|
-
headers: {
|
|
11716
|
-
[name: string]: unknown;
|
|
11744
|
+
content: {
|
|
11745
|
+
"application/json": components["schemas"]["user__sign_in_with_email__Response"];
|
|
11717
11746
|
};
|
|
11718
|
-
content?: never;
|
|
11719
11747
|
};
|
|
11720
11748
|
/** @description Specified organization or user is not found. */
|
|
11721
11749
|
404: {
|
|
@@ -11724,13 +11752,6 @@ export interface operations {
|
|
|
11724
11752
|
};
|
|
11725
11753
|
content?: never;
|
|
11726
11754
|
};
|
|
11727
|
-
/** @description A related operation is in progress. */
|
|
11728
|
-
409: {
|
|
11729
|
-
headers: {
|
|
11730
|
-
[name: string]: unknown;
|
|
11731
|
-
};
|
|
11732
|
-
content?: never;
|
|
11733
|
-
};
|
|
11734
11755
|
/** @description Invalid request path parameter or request body failed validation. */
|
|
11735
11756
|
422: {
|
|
11736
11757
|
headers: {
|
|
@@ -11738,13 +11759,6 @@ export interface operations {
|
|
|
11738
11759
|
};
|
|
11739
11760
|
content?: never;
|
|
11740
11761
|
};
|
|
11741
|
-
/** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
|
|
11742
|
-
429: {
|
|
11743
|
-
headers: {
|
|
11744
|
-
[name: string]: unknown;
|
|
11745
|
-
};
|
|
11746
|
-
content?: never;
|
|
11747
|
-
};
|
|
11748
11762
|
/** @description The service is going through temporary maintenance. */
|
|
11749
11763
|
503: {
|
|
11750
11764
|
headers: {
|
|
@@ -11754,7 +11768,7 @@ export interface operations {
|
|
|
11754
11768
|
};
|
|
11755
11769
|
};
|
|
11756
11770
|
};
|
|
11757
|
-
"
|
|
11771
|
+
"update-user-info-deprecated": {
|
|
11758
11772
|
parameters: {
|
|
11759
11773
|
query?: never;
|
|
11760
11774
|
header?: {
|
|
@@ -11763,22 +11777,24 @@ export interface operations {
|
|
|
11763
11777
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11764
11778
|
};
|
|
11765
11779
|
path: {
|
|
11780
|
+
/** @description The identifier of the user to update information for. */
|
|
11781
|
+
requested_user_id: string;
|
|
11766
11782
|
organization: string;
|
|
11767
|
-
/** @description The ID of the user whose user models to retrieve. */
|
|
11768
|
-
user_id: string;
|
|
11769
11783
|
};
|
|
11770
11784
|
cookie?: never;
|
|
11771
11785
|
};
|
|
11772
|
-
requestBody
|
|
11786
|
+
requestBody: {
|
|
11787
|
+
content: {
|
|
11788
|
+
"application/json": components["schemas"]["user__update_user_info__Request"];
|
|
11789
|
+
};
|
|
11790
|
+
};
|
|
11773
11791
|
responses: {
|
|
11774
11792
|
/** @description Succeeded. */
|
|
11775
|
-
|
|
11793
|
+
204: {
|
|
11776
11794
|
headers: {
|
|
11777
11795
|
[name: string]: unknown;
|
|
11778
11796
|
};
|
|
11779
|
-
content
|
|
11780
|
-
"application/json": components["schemas"]["user__get_user_model__Response"];
|
|
11781
|
-
};
|
|
11797
|
+
content?: never;
|
|
11782
11798
|
};
|
|
11783
11799
|
/** @description Invalid authorization credentials. */
|
|
11784
11800
|
401: {
|
|
@@ -11801,14 +11817,21 @@ export interface operations {
|
|
|
11801
11817
|
};
|
|
11802
11818
|
content?: never;
|
|
11803
11819
|
};
|
|
11804
|
-
/** @description
|
|
11820
|
+
/** @description A related operation is in progress. */
|
|
11821
|
+
409: {
|
|
11822
|
+
headers: {
|
|
11823
|
+
[name: string]: unknown;
|
|
11824
|
+
};
|
|
11825
|
+
content?: never;
|
|
11826
|
+
};
|
|
11827
|
+
/** @description Invalid request path parameter or request body failed validation. */
|
|
11805
11828
|
422: {
|
|
11806
11829
|
headers: {
|
|
11807
11830
|
[name: string]: unknown;
|
|
11808
11831
|
};
|
|
11809
11832
|
content?: never;
|
|
11810
11833
|
};
|
|
11811
|
-
/** @description The user has exceeded the rate limit of
|
|
11834
|
+
/** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
|
|
11812
11835
|
429: {
|
|
11813
11836
|
headers: {
|
|
11814
11837
|
[name: string]: unknown;
|
|
@@ -11824,42 +11847,33 @@ export interface operations {
|
|
|
11824
11847
|
};
|
|
11825
11848
|
};
|
|
11826
11849
|
};
|
|
11827
|
-
"
|
|
11850
|
+
"update-user-info": {
|
|
11828
11851
|
parameters: {
|
|
11829
|
-
query?:
|
|
11830
|
-
/** @description Whether the user is verified. */
|
|
11831
|
-
is_verified?: boolean | null;
|
|
11832
|
-
/** @description The ID of the user. */
|
|
11833
|
-
user_id?: string[];
|
|
11834
|
-
/** @description The email of the user, */
|
|
11835
|
-
email?: string[];
|
|
11836
|
-
/** @description The maximum number of users to retrieve. */
|
|
11837
|
-
limit?: number;
|
|
11838
|
-
/** @description The token from the previous request to return the next page of users. */
|
|
11839
|
-
continuation_token?: number;
|
|
11840
|
-
/** @description The fields to sort the users by. Supported fields are `first_name`, `last_name`, `email`, `user_stats.num_conversations`, `user_stats.num_messages`, and `user_stats.last_message_time`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties. */
|
|
11841
|
-
sort_by?: string[];
|
|
11842
|
-
};
|
|
11852
|
+
query?: never;
|
|
11843
11853
|
header?: {
|
|
11844
11854
|
/** @description The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database. */
|
|
11845
11855
|
"x-mongo-cluster-name"?: string | null;
|
|
11846
11856
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11847
11857
|
};
|
|
11848
11858
|
path: {
|
|
11859
|
+
/** @description The identifier of the user to update information for. */
|
|
11860
|
+
requested_user_id: string;
|
|
11849
11861
|
organization: string;
|
|
11850
11862
|
};
|
|
11851
11863
|
cookie?: never;
|
|
11852
11864
|
};
|
|
11853
|
-
requestBody
|
|
11865
|
+
requestBody: {
|
|
11866
|
+
content: {
|
|
11867
|
+
"application/json": components["schemas"]["user__update_user_info__Request"];
|
|
11868
|
+
};
|
|
11869
|
+
};
|
|
11854
11870
|
responses: {
|
|
11855
11871
|
/** @description Succeeded. */
|
|
11856
|
-
|
|
11872
|
+
204: {
|
|
11857
11873
|
headers: {
|
|
11858
11874
|
[name: string]: unknown;
|
|
11859
11875
|
};
|
|
11860
|
-
content
|
|
11861
|
-
"application/json": components["schemas"]["user__get_users__Response"];
|
|
11862
|
-
};
|
|
11876
|
+
content?: never;
|
|
11863
11877
|
};
|
|
11864
11878
|
/** @description Invalid authorization credentials. */
|
|
11865
11879
|
401: {
|
|
@@ -11875,21 +11889,28 @@ export interface operations {
|
|
|
11875
11889
|
};
|
|
11876
11890
|
content?: never;
|
|
11877
11891
|
};
|
|
11878
|
-
/** @description Specified organization is not found. */
|
|
11892
|
+
/** @description Specified organization or user is not found. */
|
|
11879
11893
|
404: {
|
|
11880
11894
|
headers: {
|
|
11881
11895
|
[name: string]: unknown;
|
|
11882
11896
|
};
|
|
11883
11897
|
content?: never;
|
|
11884
11898
|
};
|
|
11885
|
-
/** @description
|
|
11899
|
+
/** @description A related operation is in progress. */
|
|
11900
|
+
409: {
|
|
11901
|
+
headers: {
|
|
11902
|
+
[name: string]: unknown;
|
|
11903
|
+
};
|
|
11904
|
+
content?: never;
|
|
11905
|
+
};
|
|
11906
|
+
/** @description Invalid request path parameter or request body failed validation. */
|
|
11886
11907
|
422: {
|
|
11887
11908
|
headers: {
|
|
11888
11909
|
[name: string]: unknown;
|
|
11889
11910
|
};
|
|
11890
11911
|
content?: never;
|
|
11891
11912
|
};
|
|
11892
|
-
/** @description The user has exceeded the rate limit of
|
|
11913
|
+
/** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
|
|
11893
11914
|
429: {
|
|
11894
11915
|
headers: {
|
|
11895
11916
|
[name: string]: unknown;
|
|
@@ -11905,7 +11926,7 @@ export interface operations {
|
|
|
11905
11926
|
};
|
|
11906
11927
|
};
|
|
11907
11928
|
};
|
|
11908
|
-
"
|
|
11929
|
+
"delete-user": {
|
|
11909
11930
|
parameters: {
|
|
11910
11931
|
query?: never;
|
|
11911
11932
|
header?: {
|
|
@@ -11914,24 +11935,20 @@ export interface operations {
|
|
|
11914
11935
|
"Sec-WebSocket-Protocol"?: string[];
|
|
11915
11936
|
};
|
|
11916
11937
|
path: {
|
|
11938
|
+
/** @description The identifier of the user to delete. */
|
|
11939
|
+
requested_user_id: string;
|
|
11917
11940
|
organization: string;
|
|
11918
11941
|
};
|
|
11919
11942
|
cookie?: never;
|
|
11920
11943
|
};
|
|
11921
|
-
requestBody
|
|
11922
|
-
content: {
|
|
11923
|
-
"application/json": components["schemas"]["user__create_invited_user__Request"];
|
|
11924
|
-
};
|
|
11925
|
-
};
|
|
11944
|
+
requestBody?: never;
|
|
11926
11945
|
responses: {
|
|
11927
|
-
/** @description Succeeded */
|
|
11928
|
-
|
|
11946
|
+
/** @description Succeeded. */
|
|
11947
|
+
204: {
|
|
11929
11948
|
headers: {
|
|
11930
11949
|
[name: string]: unknown;
|
|
11931
11950
|
};
|
|
11932
|
-
content
|
|
11933
|
-
"application/json": components["schemas"]["user__create_invited_user__Response"];
|
|
11934
|
-
};
|
|
11951
|
+
content?: never;
|
|
11935
11952
|
};
|
|
11936
11953
|
/** @description Invalid authorization credentials. */
|
|
11937
11954
|
401: {
|
|
@@ -11947,28 +11964,28 @@ export interface operations {
|
|
|
11947
11964
|
};
|
|
11948
11965
|
content?: never;
|
|
11949
11966
|
};
|
|
11950
|
-
/** @description Specified organization or
|
|
11967
|
+
/** @description Specified organization or user is not found. */
|
|
11951
11968
|
404: {
|
|
11952
11969
|
headers: {
|
|
11953
11970
|
[name: string]: unknown;
|
|
11954
11971
|
};
|
|
11955
11972
|
content?: never;
|
|
11956
11973
|
};
|
|
11957
|
-
/** @description
|
|
11974
|
+
/** @description A related operation is in progress. */
|
|
11958
11975
|
409: {
|
|
11959
11976
|
headers: {
|
|
11960
11977
|
[name: string]: unknown;
|
|
11961
11978
|
};
|
|
11962
11979
|
content?: never;
|
|
11963
11980
|
};
|
|
11964
|
-
/** @description Invalid request path parameter
|
|
11981
|
+
/** @description Invalid request path parameter failed validation. */
|
|
11965
11982
|
422: {
|
|
11966
11983
|
headers: {
|
|
11967
11984
|
[name: string]: unknown;
|
|
11968
11985
|
};
|
|
11969
11986
|
content?: never;
|
|
11970
11987
|
};
|
|
11971
|
-
/** @description The user has exceeded the rate limit of
|
|
11988
|
+
/** @description The user has exceeded the rate limit of 500 requests per minute for this endpoint. */
|
|
11972
11989
|
429: {
|
|
11973
11990
|
headers: {
|
|
11974
11991
|
[name: string]: unknown;
|
|
@@ -11984,7 +12001,7 @@ export interface operations {
|
|
|
11984
12001
|
};
|
|
11985
12002
|
};
|
|
11986
12003
|
};
|
|
11987
|
-
"
|
|
12004
|
+
"get-user-model": {
|
|
11988
12005
|
parameters: {
|
|
11989
12006
|
query?: never;
|
|
11990
12007
|
header?: {
|
|
@@ -11994,22 +12011,20 @@ export interface operations {
|
|
|
11994
12011
|
};
|
|
11995
12012
|
path: {
|
|
11996
12013
|
organization: string;
|
|
12014
|
+
/** @description The ID of the user whose user models to retrieve. */
|
|
12015
|
+
user_id: string;
|
|
11997
12016
|
};
|
|
11998
12017
|
cookie?: never;
|
|
11999
12018
|
};
|
|
12000
|
-
requestBody
|
|
12001
|
-
content: {
|
|
12002
|
-
"application/json": components["schemas"]["user__create_invited_user__Request"];
|
|
12003
|
-
};
|
|
12004
|
-
};
|
|
12019
|
+
requestBody?: never;
|
|
12005
12020
|
responses: {
|
|
12006
|
-
/** @description Succeeded */
|
|
12007
|
-
|
|
12021
|
+
/** @description Succeeded. */
|
|
12022
|
+
200: {
|
|
12008
12023
|
headers: {
|
|
12009
12024
|
[name: string]: unknown;
|
|
12010
12025
|
};
|
|
12011
12026
|
content: {
|
|
12012
|
-
"application/json": components["schemas"]["
|
|
12027
|
+
"application/json": components["schemas"]["user__get_user_model__Response"];
|
|
12013
12028
|
};
|
|
12014
12029
|
};
|
|
12015
12030
|
/** @description Invalid authorization credentials. */
|
|
@@ -12026,28 +12041,21 @@ export interface operations {
|
|
|
12026
12041
|
};
|
|
12027
12042
|
content?: never;
|
|
12028
12043
|
};
|
|
12029
|
-
/** @description Specified organization or
|
|
12044
|
+
/** @description Specified organization or user is not found. */
|
|
12030
12045
|
404: {
|
|
12031
12046
|
headers: {
|
|
12032
12047
|
[name: string]: unknown;
|
|
12033
12048
|
};
|
|
12034
12049
|
content?: never;
|
|
12035
12050
|
};
|
|
12036
|
-
/** @description
|
|
12037
|
-
409: {
|
|
12038
|
-
headers: {
|
|
12039
|
-
[name: string]: unknown;
|
|
12040
|
-
};
|
|
12041
|
-
content?: never;
|
|
12042
|
-
};
|
|
12043
|
-
/** @description Invalid request path parameter or request body failed validation. */
|
|
12051
|
+
/** @description Invalid request path parameter failed validation. */
|
|
12044
12052
|
422: {
|
|
12045
12053
|
headers: {
|
|
12046
12054
|
[name: string]: unknown;
|
|
12047
12055
|
};
|
|
12048
12056
|
content?: never;
|
|
12049
12057
|
};
|
|
12050
|
-
/** @description The user has exceeded the rate limit of
|
|
12058
|
+
/** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
|
|
12051
12059
|
429: {
|
|
12052
12060
|
headers: {
|
|
12053
12061
|
[name: string]: unknown;
|