@amigo-ai/sdk 0.27.0 → 0.28.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.
@@ -737,7 +737,7 @@ export interface paths {
737
737
  patch?: never;
738
738
  trace?: never;
739
739
  };
740
- "/v1/{organization}/user/signin_with_api_key": {
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
- * Sign in with API key
751
- * @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.
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
- * This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.
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["sign-in-with-api-key"];
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/signin": {
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
- get?: never;
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
- * Sign in with email
773
- * @description Send a magic link to the user's email to sign in.
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["sign-in-with-email"];
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/{requested_user_id}": {
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
- * Update user info
793
- * @description Update information about an user. Only fields that are specified in the request are updated.
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
- * #### Permissions
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
- delete: operations["delete-user"];
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/{requested_user_id}/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
- * Update user info
825
- * @deprecated
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["update-user-info-deprecated"];
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/{user_id}/user_model": {
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
- * Get user model
848
- * @description Retrieve the user models for an user.
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:GetUserModel` for the user to retrieve the user models for.
865
+ * * `User:UpdateUserInfo` for the user to update.
853
866
  */
854
- get: operations["get-user-model"];
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
- * Get users
872
- * @description Retrieve all users in an organization.
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 is impacted by the following permissions:
876
- * * Only users that the authenticated user has the `User:GetUserInfo` permission for are returned.
888
+ * This endpoint requires the following permissions:
889
+ * * `User:UpdateUserInfo` for the user to update.
877
890
  */
878
- get: operations["get-users"];
879
- put?: never;
891
+ post: operations["update-user-info"];
880
892
  /**
881
- * Create a new user
882
- * @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
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:InviteUser` on the user to invite.
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
- post: operations["create-invited-user"];
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/invite": {
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
- * Create a new user
911
- * @deprecated
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:InviteUser` on the user to invite.
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
- post: operations["create-invited-user-deprecated"];
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
- "sign-in-with-api-key": {
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?: never;
11430
+ requestBody: {
11431
+ content: {
11432
+ "application/json": components["schemas"]["user__create_invited_user__Request"];
11433
+ };
11434
+ };
11426
11435
  responses: {
11427
- /** @description Succeeded. */
11428
- 200: {
11436
+ /** @description Succeeded */
11437
+ 201: {
11429
11438
  headers: {
11430
11439
  [name: string]: unknown;
11431
11440
  };
11432
11441
  content: {
11433
- "application/json": components["schemas"]["user__sign_in_with_api_key__Response"];
11442
+ "application/json": components["schemas"]["user__create_invited_user__Response"];
11434
11443
  };
11435
11444
  };
11436
- /** @description API key not found, is incorrect, or the requested user is not found. */
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 Specified organization is not found. */
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 Invalid request path parameter failed validation. */
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 5 requests per minute for this endpoint. */
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
- "sign-in-with-email": {
11496
+ "get-users": {
11474
11497
  parameters: {
11475
- query?: never;
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"]["user__sign_in_with_email__Response"];
11530
+ "application/json": components["schemas"]["user__get_users__Response"];
11499
11531
  };
11500
11532
  };
11501
- /** @description Specified organization or user is not found. */
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 body failed validation. */
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
- "update-user-info": {
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"]["user__update_user_info__Request"];
11592
+ "application/json": components["schemas"]["user__create_invited_user__Request"];
11542
11593
  };
11543
11594
  };
11544
11595
  responses: {
11545
- /** @description Succeeded. */
11546
- 204: {
11596
+ /** @description Succeeded */
11597
+ 201: {
11547
11598
  headers: {
11548
11599
  [name: string]: unknown;
11549
11600
  };
11550
- content?: never;
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 user is not found. */
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 A related operation is in progress. */
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,7 +11653,7 @@ export interface operations {
11600
11653
  };
11601
11654
  };
11602
11655
  };
11603
- "delete-user": {
11656
+ "sign-in-with-api-key": {
11604
11657
  parameters: {
11605
11658
  query?: never;
11606
11659
  header?: {
@@ -11609,8 +11662,6 @@ export interface operations {
11609
11662
  "Sec-WebSocket-Protocol"?: string[];
11610
11663
  };
11611
11664
  path: {
11612
- /** @description The identifier of the user to delete. */
11613
- requested_user_id: string;
11614
11665
  organization: string;
11615
11666
  };
11616
11667
  cookie?: never;
@@ -11618,40 +11669,28 @@ export interface operations {
11618
11669
  requestBody?: never;
11619
11670
  responses: {
11620
11671
  /** @description Succeeded. */
11621
- 204: {
11672
+ 200: {
11622
11673
  headers: {
11623
11674
  [name: string]: unknown;
11624
11675
  };
11625
- content?: never;
11626
- };
11627
- /** @description Invalid authorization credentials. */
11628
- 401: {
11629
- headers: {
11630
- [name: string]: unknown;
11676
+ content: {
11677
+ "application/json": components["schemas"]["user__sign_in_with_api_key__Response"];
11631
11678
  };
11632
- content?: never;
11633
11679
  };
11634
- /** @description Missing required permissions. */
11635
- 403: {
11680
+ /** @description API key not found, is incorrect, or the requested user is not found. */
11681
+ 401: {
11636
11682
  headers: {
11637
11683
  [name: string]: unknown;
11638
11684
  };
11639
11685
  content?: never;
11640
11686
  };
11641
- /** @description Specified organization or user is not found. */
11687
+ /** @description Specified organization is not found. */
11642
11688
  404: {
11643
11689
  headers: {
11644
11690
  [name: string]: unknown;
11645
11691
  };
11646
11692
  content?: never;
11647
11693
  };
11648
- /** @description A related operation is in progress. */
11649
- 409: {
11650
- headers: {
11651
- [name: string]: unknown;
11652
- };
11653
- content?: never;
11654
- };
11655
11694
  /** @description Invalid request path parameter failed validation. */
11656
11695
  422: {
11657
11696
  headers: {
@@ -11659,7 +11698,7 @@ export interface operations {
11659
11698
  };
11660
11699
  content?: never;
11661
11700
  };
11662
- /** @description The user has exceeded the rate limit of 500 requests per minute for this endpoint. */
11701
+ /** @description The user has exceeded the rate limit of 5 requests per minute for this endpoint. */
11663
11702
  429: {
11664
11703
  headers: {
11665
11704
  [name: string]: unknown;
@@ -11675,7 +11714,7 @@ export interface operations {
11675
11714
  };
11676
11715
  };
11677
11716
  };
11678
- "update-user-info-deprecated": {
11717
+ "sign-in-with-email": {
11679
11718
  parameters: {
11680
11719
  query?: never;
11681
11720
  header?: {
@@ -11684,38 +11723,24 @@ export interface operations {
11684
11723
  "Sec-WebSocket-Protocol"?: string[];
11685
11724
  };
11686
11725
  path: {
11687
- /** @description The identifier of the user to update information for. */
11688
- requested_user_id: string;
11689
11726
  organization: string;
11690
11727
  };
11691
11728
  cookie?: never;
11692
11729
  };
11693
11730
  requestBody: {
11694
11731
  content: {
11695
- "application/json": components["schemas"]["user__update_user_info__Request"];
11732
+ "application/json": components["schemas"]["user__sign_in_with_email__Request"];
11696
11733
  };
11697
11734
  };
11698
11735
  responses: {
11699
11736
  /** @description Succeeded. */
11700
- 204: {
11701
- headers: {
11702
- [name: string]: unknown;
11703
- };
11704
- content?: never;
11705
- };
11706
- /** @description Invalid authorization credentials. */
11707
- 401: {
11737
+ 200: {
11708
11738
  headers: {
11709
11739
  [name: string]: unknown;
11710
11740
  };
11711
- content?: never;
11712
- };
11713
- /** @description Missing required permissions. */
11714
- 403: {
11715
- headers: {
11716
- [name: string]: unknown;
11741
+ content: {
11742
+ "application/json": components["schemas"]["user__sign_in_with_email__Response"];
11717
11743
  };
11718
- content?: never;
11719
11744
  };
11720
11745
  /** @description Specified organization or user is not found. */
11721
11746
  404: {
@@ -11724,13 +11749,6 @@ export interface operations {
11724
11749
  };
11725
11750
  content?: never;
11726
11751
  };
11727
- /** @description A related operation is in progress. */
11728
- 409: {
11729
- headers: {
11730
- [name: string]: unknown;
11731
- };
11732
- content?: never;
11733
- };
11734
11752
  /** @description Invalid request path parameter or request body failed validation. */
11735
11753
  422: {
11736
11754
  headers: {
@@ -11738,13 +11756,6 @@ export interface operations {
11738
11756
  };
11739
11757
  content?: never;
11740
11758
  };
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
11759
  /** @description The service is going through temporary maintenance. */
11749
11760
  503: {
11750
11761
  headers: {
@@ -11754,7 +11765,7 @@ export interface operations {
11754
11765
  };
11755
11766
  };
11756
11767
  };
11757
- "get-user-model": {
11768
+ "update-user-info-deprecated": {
11758
11769
  parameters: {
11759
11770
  query?: never;
11760
11771
  header?: {
@@ -11763,22 +11774,24 @@ export interface operations {
11763
11774
  "Sec-WebSocket-Protocol"?: string[];
11764
11775
  };
11765
11776
  path: {
11777
+ /** @description The identifier of the user to update information for. */
11778
+ requested_user_id: string;
11766
11779
  organization: string;
11767
- /** @description The ID of the user whose user models to retrieve. */
11768
- user_id: string;
11769
11780
  };
11770
11781
  cookie?: never;
11771
11782
  };
11772
- requestBody?: never;
11783
+ requestBody: {
11784
+ content: {
11785
+ "application/json": components["schemas"]["user__update_user_info__Request"];
11786
+ };
11787
+ };
11773
11788
  responses: {
11774
11789
  /** @description Succeeded. */
11775
- 200: {
11790
+ 204: {
11776
11791
  headers: {
11777
11792
  [name: string]: unknown;
11778
11793
  };
11779
- content: {
11780
- "application/json": components["schemas"]["user__get_user_model__Response"];
11781
- };
11794
+ content?: never;
11782
11795
  };
11783
11796
  /** @description Invalid authorization credentials. */
11784
11797
  401: {
@@ -11801,14 +11814,21 @@ export interface operations {
11801
11814
  };
11802
11815
  content?: never;
11803
11816
  };
11804
- /** @description Invalid request path parameter failed validation. */
11817
+ /** @description A related operation is in progress. */
11818
+ 409: {
11819
+ headers: {
11820
+ [name: string]: unknown;
11821
+ };
11822
+ content?: never;
11823
+ };
11824
+ /** @description Invalid request path parameter or request body failed validation. */
11805
11825
  422: {
11806
11826
  headers: {
11807
11827
  [name: string]: unknown;
11808
11828
  };
11809
11829
  content?: never;
11810
11830
  };
11811
- /** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
11831
+ /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
11812
11832
  429: {
11813
11833
  headers: {
11814
11834
  [name: string]: unknown;
@@ -11824,42 +11844,33 @@ export interface operations {
11824
11844
  };
11825
11845
  };
11826
11846
  };
11827
- "get-users": {
11847
+ "update-user-info": {
11828
11848
  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
- };
11849
+ query?: never;
11843
11850
  header?: {
11844
11851
  /** @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
11852
  "x-mongo-cluster-name"?: string | null;
11846
11853
  "Sec-WebSocket-Protocol"?: string[];
11847
11854
  };
11848
11855
  path: {
11856
+ /** @description The identifier of the user to update information for. */
11857
+ requested_user_id: string;
11849
11858
  organization: string;
11850
11859
  };
11851
11860
  cookie?: never;
11852
11861
  };
11853
- requestBody?: never;
11862
+ requestBody: {
11863
+ content: {
11864
+ "application/json": components["schemas"]["user__update_user_info__Request"];
11865
+ };
11866
+ };
11854
11867
  responses: {
11855
11868
  /** @description Succeeded. */
11856
- 200: {
11869
+ 204: {
11857
11870
  headers: {
11858
11871
  [name: string]: unknown;
11859
11872
  };
11860
- content: {
11861
- "application/json": components["schemas"]["user__get_users__Response"];
11862
- };
11873
+ content?: never;
11863
11874
  };
11864
11875
  /** @description Invalid authorization credentials. */
11865
11876
  401: {
@@ -11875,21 +11886,28 @@ export interface operations {
11875
11886
  };
11876
11887
  content?: never;
11877
11888
  };
11878
- /** @description Specified organization is not found. */
11889
+ /** @description Specified organization or user is not found. */
11879
11890
  404: {
11880
11891
  headers: {
11881
11892
  [name: string]: unknown;
11882
11893
  };
11883
11894
  content?: never;
11884
11895
  };
11885
- /** @description Invalid request path parameter or request query parameter failed validation. */
11896
+ /** @description A related operation is in progress. */
11897
+ 409: {
11898
+ headers: {
11899
+ [name: string]: unknown;
11900
+ };
11901
+ content?: never;
11902
+ };
11903
+ /** @description Invalid request path parameter or request body failed validation. */
11886
11904
  422: {
11887
11905
  headers: {
11888
11906
  [name: string]: unknown;
11889
11907
  };
11890
11908
  content?: never;
11891
11909
  };
11892
- /** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
11910
+ /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
11893
11911
  429: {
11894
11912
  headers: {
11895
11913
  [name: string]: unknown;
@@ -11905,7 +11923,7 @@ export interface operations {
11905
11923
  };
11906
11924
  };
11907
11925
  };
11908
- "create-invited-user": {
11926
+ "delete-user": {
11909
11927
  parameters: {
11910
11928
  query?: never;
11911
11929
  header?: {
@@ -11914,24 +11932,20 @@ export interface operations {
11914
11932
  "Sec-WebSocket-Protocol"?: string[];
11915
11933
  };
11916
11934
  path: {
11935
+ /** @description The identifier of the user to delete. */
11936
+ requested_user_id: string;
11917
11937
  organization: string;
11918
11938
  };
11919
11939
  cookie?: never;
11920
11940
  };
11921
- requestBody: {
11922
- content: {
11923
- "application/json": components["schemas"]["user__create_invited_user__Request"];
11924
- };
11925
- };
11941
+ requestBody?: never;
11926
11942
  responses: {
11927
- /** @description Succeeded */
11928
- 201: {
11943
+ /** @description Succeeded. */
11944
+ 204: {
11929
11945
  headers: {
11930
11946
  [name: string]: unknown;
11931
11947
  };
11932
- content: {
11933
- "application/json": components["schemas"]["user__create_invited_user__Response"];
11934
- };
11948
+ content?: never;
11935
11949
  };
11936
11950
  /** @description Invalid authorization credentials. */
11937
11951
  401: {
@@ -11947,28 +11961,28 @@ export interface operations {
11947
11961
  };
11948
11962
  content?: never;
11949
11963
  };
11950
- /** @description Specified organization or role is not found. */
11964
+ /** @description Specified organization or user is not found. */
11951
11965
  404: {
11952
11966
  headers: {
11953
11967
  [name: string]: unknown;
11954
11968
  };
11955
11969
  content?: never;
11956
11970
  };
11957
- /** @description User with the same email already exists in this organization, or a related operation is in progress. */
11971
+ /** @description A related operation is in progress. */
11958
11972
  409: {
11959
11973
  headers: {
11960
11974
  [name: string]: unknown;
11961
11975
  };
11962
11976
  content?: never;
11963
11977
  };
11964
- /** @description Invalid request path parameter or request body failed validation. */
11978
+ /** @description Invalid request path parameter failed validation. */
11965
11979
  422: {
11966
11980
  headers: {
11967
11981
  [name: string]: unknown;
11968
11982
  };
11969
11983
  content?: never;
11970
11984
  };
11971
- /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
11985
+ /** @description The user has exceeded the rate limit of 500 requests per minute for this endpoint. */
11972
11986
  429: {
11973
11987
  headers: {
11974
11988
  [name: string]: unknown;
@@ -11984,7 +11998,7 @@ export interface operations {
11984
11998
  };
11985
11999
  };
11986
12000
  };
11987
- "create-invited-user-deprecated": {
12001
+ "get-user-model": {
11988
12002
  parameters: {
11989
12003
  query?: never;
11990
12004
  header?: {
@@ -11994,22 +12008,20 @@ export interface operations {
11994
12008
  };
11995
12009
  path: {
11996
12010
  organization: string;
12011
+ /** @description The ID of the user whose user models to retrieve. */
12012
+ user_id: string;
11997
12013
  };
11998
12014
  cookie?: never;
11999
12015
  };
12000
- requestBody: {
12001
- content: {
12002
- "application/json": components["schemas"]["user__create_invited_user__Request"];
12003
- };
12004
- };
12016
+ requestBody?: never;
12005
12017
  responses: {
12006
- /** @description Succeeded */
12007
- 201: {
12018
+ /** @description Succeeded. */
12019
+ 200: {
12008
12020
  headers: {
12009
12021
  [name: string]: unknown;
12010
12022
  };
12011
12023
  content: {
12012
- "application/json": components["schemas"]["user__create_invited_user__Response"];
12024
+ "application/json": components["schemas"]["user__get_user_model__Response"];
12013
12025
  };
12014
12026
  };
12015
12027
  /** @description Invalid authorization credentials. */
@@ -12026,28 +12038,21 @@ export interface operations {
12026
12038
  };
12027
12039
  content?: never;
12028
12040
  };
12029
- /** @description Specified organization or role is not found. */
12041
+ /** @description Specified organization or user is not found. */
12030
12042
  404: {
12031
12043
  headers: {
12032
12044
  [name: string]: unknown;
12033
12045
  };
12034
12046
  content?: never;
12035
12047
  };
12036
- /** @description User with the same email already exists in this organization, or a related operation is in progress. */
12037
- 409: {
12038
- headers: {
12039
- [name: string]: unknown;
12040
- };
12041
- content?: never;
12042
- };
12043
- /** @description Invalid request path parameter or request body failed validation. */
12048
+ /** @description Invalid request path parameter failed validation. */
12044
12049
  422: {
12045
12050
  headers: {
12046
12051
  [name: string]: unknown;
12047
12052
  };
12048
12053
  content?: never;
12049
12054
  };
12050
- /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
12055
+ /** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
12051
12056
  429: {
12052
12057
  headers: {
12053
12058
  [name: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amigo-ai/sdk",
3
- "version": "0.27.0",
3
+ "version": "0.28.0",
4
4
  "description": "Amigo TypeScript SDK",
5
5
  "publishConfig": {
6
6
  "access": "public"