@amigo-ai/sdk 0.26.0 → 0.28.0

package/dist/types/generated/api-types.d.ts

@@ -737,7 +737,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/{requested_user_id}/user": {
+    "/v1/{organization}/user/invite": {
         parameters: {
             query?: never;
             header?: never;
@@ -747,21 +747,27 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Update user info
-         * @description Update information about an user. Only fields that are specified in the request are updated.
+         * Create a new user
+         * @deprecated
+         * @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
+         *     supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
+         *
+         *     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
+         *     and start their Amigo experience. Otherwise, no email will be sent.
          *
          *     #### Permissions
          *     This endpoint requires the following permissions:
-         *     * `User:UpdateUserInfo` for the user to update.
+         *     * `User:InviteUser` on the user to invite.
+         *     * The authenticated user must have greater privileges than the role assigned to the new user.
          */
-        post: operations["update-user-info"];
+        post: operations["create-invited-user-deprecated"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/{user_id}/user_model": {
+    "/v1/{organization}/user/": {
         parameters: {
             query?: never;
             header?: never;
@@ -769,23 +775,36 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get user model
-         * @description Retrieve the user models for an user.
+         * Get users
+         * @description Retrieve all users in an organization.
          *
          *     #### Permissions
-         *     This endpoint requires the following permissions:
-         *     * `User:GetUserModel` for the user to retrieve the user models for.
+         *     This endpoint is impacted by the following permissions:
+         *     * Only users that the authenticated user has the `User:GetUserInfo` permission for are returned.
          */
-        get: operations["get-user-model"];
+        get: operations["get-users"];
         put?: never;
-        post?: never;
+        /**
+         * Create a new user
+         * @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
+         *     supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
+         *
+         *     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
+         *     and start their Amigo experience. Otherwise, no email will be sent.
+         *
+         *     #### Permissions
+         *     This endpoint requires the following permissions:
+         *     * `User:InviteUser` on the user to invite.
+         *     * The authenticated user must have greater privileges than the role assigned to the new user.
+         */
+        post: operations["create-invited-user"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/signin": {
+    "/v1/{organization}/user/signin_with_api_key": {
         parameters: {
             query?: never;
             header?: never;
@@ -795,17 +814,19 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Sign in with email
-         * @description Send a magic link to the user's email to sign in.
+         * Sign in with API key
+         * @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.
+         *
+         *     This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.
          */
-        post: operations["sign-in-with-email"];
+        post: operations["sign-in-with-api-key"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/signin_with_api_key": {
+    "/v1/{organization}/user/signin": {
         parameters: {
             query?: never;
             header?: never;
@@ -815,43 +836,42 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Sign in with API key
-         * @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.
-         *
-         *     This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.
+         * Sign in with email
+         * @description Send a magic link to the user's email to sign in.
          */
-        post: operations["sign-in-with-api-key"];
+        post: operations["sign-in-with-email"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/": {
+    "/v1/{organization}/user/{requested_user_id}/user": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
+        get?: never;
+        put?: never;
         /**
-         * Get users
-         * @description Retrieve all users in an organization.
+         * Update user info
+         * @deprecated
+         * @description Update information about an user. Only fields that are specified in the request are updated.
          *
          *     #### Permissions
-         *     This endpoint is impacted by the following permissions:
-         *     * Only users that the authenticated user has the `User:GetUserInfo` permission for are returned.
+         *     This endpoint requires the following permissions:
+         *     * `User:UpdateUserInfo` for the user to update.
          */
-        get: operations["get-users"];
-        put?: never;
-        post?: never;
+        post: operations["update-user-info-deprecated"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/invite": {
+    "/v1/{organization}/user/{requested_user_id}": {
         parameters: {
             query?: never;
             header?: never;
@@ -861,44 +881,47 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Create a new user
-         * @description Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the
-         *     supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
+         * Update user info
+         * @description Update information about an user. Only fields that are specified in the request are updated.
          *
-         *     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
-         *     and start their Amigo experience. Otherwise, no email will be sent.
+         *     #### Permissions
+         *     This endpoint requires the following permissions:
+         *     * `User:UpdateUserInfo` for the user to update.
+         */
+        post: operations["update-user-info"];
+        /**
+         * Delete an user
+         * @description Delete an user. This endpoint deletes the user from the Amigo system.
          *
          *     #### Permissions
          *     This endpoint requires the following permissions:
-         *     * `User:InviteUser` on the user to invite.
-         *     * The authenticated user must have greater privileges than the role assigned to the new user.
+         *     * `User.DeleteUser` on the user to delete.
          */
-        post: operations["create-invited-user"];
-        delete?: never;
+        delete: operations["delete-user"];
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/user/{requested_user_id}": {
+    "/v1/{organization}/user/{user_id}/user_model": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get?: never;
-        put?: never;
-        post?: never;
         /**
-         * Delete an user
-         * @description Delete an user. This endpoint deletes the user from the Amigo system.
+         * Get user model
+         * @description Retrieve the user models for an user.
          *
          *     #### Permissions
          *     This endpoint requires the following permissions:
-         *     * `User.DeleteUser` on the user to delete.
+         *     * `User:GetUserModel` for the user to retrieve the user models for.
          */
-        delete: operations["delete-user"];
+        get: operations["get-user-model"];
+        put?: never;
+        post?: never;
+        delete?: never;
         options?: never;
         head?: never;
         patch?: never;
@@ -1039,26 +1062,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v1/{organization}/admin/ping": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Ping server
-         * @description Ping the server to retrieve basic information about it. This endpoint is always up regardless of whether the server is in maintenance mode.
-         */
-        get: operations["ping-server"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/v1/{organization}/admin/get_prompt_logs/": {
         parameters: {
             query?: never;
@@ -2302,6 +2305,11 @@ export interface components {
              * @description The role ID of the creator of this key.
              */
             role_id: string;
+            /**
+             * Index
+             * @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.
+             */
+            index: number;
         };
         /** ActionState */
         "ActionState-Input": {
@@ -6347,14 +6355,6 @@ export interface components {
         amigo_lib__pydantic__base_model__StrippedNonemptyString__2: string;
         amigo_lib__pydantic__base_model__StrippedNonemptyString__3: string;
         src__app__amigo__service__conversation__Action: components["schemas"]["SelectDynamicBehaviorAgentActionEvent"] | components["schemas"]["CheckIfActiveMemoryNeededAgentActionEvent"] | components["schemas"]["ExtractActiveMemoriesAgentActionEvent"] | components["schemas"]["NavigateStateMachineAgentActionEvent"] | components["schemas"]["EngageUserAgentActionEvent"];
-        /** Response */
-        admin__ping_server__Response: {
-            /**
-             * In Maintenance Mode
-             * @description Whether the server is in maintenance mode. This value may differ based on organizations.
-             */
-            in_maintenance_mode: boolean;
-        };
         /** Request */
         admin__submit_sql_query__Request: {
             /** @description The SQL query to execute. */
@@ -11414,7 +11414,7 @@ export interface operations {
             };
         };
     };
-    "update-user-info": {
+    "create-invited-user-deprecated": {
         parameters: {
             query?: never;
             header?: {
@@ -11423,24 +11423,24 @@ export interface operations {
                 "Sec-WebSocket-Protocol"?: string[];
             };
             path: {
-                /** @description The identifier of the user to update information for. */
-                requested_user_id: string;
                 organization: string;
             };
             cookie?: never;
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["user__update_user_info__Request"];
+                "application/json": components["schemas"]["user__create_invited_user__Request"];
             };
         };
         responses: {
-            /** @description Succeeded. */
-            204: {
+            /** @description Succeeded */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["user__create_invited_user__Response"];
+                };
             };
             /** @description Invalid authorization credentials. */
             401: {
@@ -11456,14 +11456,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Specified organization or user is not found. */
+            /** @description Specified organization or role is not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description A related operation is in progress. */
+            /** @description User with the same email already exists in this organization, or a related operation is in progress. */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -11493,9 +11493,22 @@ export interface operations {
             };
         };
     };
-    "get-user-model": {
+    "get-users": {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Whether the user is verified. */
+                is_verified?: boolean | null;
+                /** @description The ID of the user. */
+                user_id?: string[];
+                /** @description The email of the user, */
+                email?: string[];
+                /** @description The maximum number of users to retrieve. */
+                limit?: number;
+                /** @description The token from the previous request to return the next page of users. */
+                continuation_token?: number;
+                /** @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. */
+                sort_by?: string[];
+            };
             header?: {
                 /** @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. */
                 "x-mongo-cluster-name"?: string | null;
@@ -11503,8 +11516,6 @@ export interface operations {
             };
             path: {
                 organization: string;
-                /** @description The ID of the user whose user models to retrieve. */
-                user_id: string;
             };
             cookie?: never;
         };
@@ -11516,7 +11527,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["user__get_user_model__Response"];
+                    "application/json": components["schemas"]["user__get_users__Response"];
                 };
             };
             /** @description Invalid authorization credentials. */
@@ -11533,14 +11544,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Specified organization or user is not found. */
+            /** @description Specified organization is not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Invalid request path parameter failed validation. */
+            /** @description Invalid request path parameter or request query parameter failed validation. */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -11563,7 +11574,7 @@ export interface operations {
             };
         };
     };
-    "sign-in-with-email": {
+    "create-invited-user": {
         parameters: {
             query?: never;
             header?: {
@@ -11578,26 +11589,47 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["user__sign_in_with_email__Request"];
+                "application/json": components["schemas"]["user__create_invited_user__Request"];
             };
         };
         responses: {
-            /** @description Succeeded. */
-            200: {
+            /** @description Succeeded */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["user__sign_in_with_email__Response"];
+                    "application/json": components["schemas"]["user__create_invited_user__Response"];
                 };
             };
-            /** @description Specified organization or user is not found. */
+            /** @description Invalid authorization credentials. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Missing required permissions. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Specified organization or role is not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
+            /** @description User with the same email already exists in this organization, or a related operation is in progress. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Invalid request path parameter or request body failed validation. */
             422: {
                 headers: {
@@ -11605,6 +11637,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description The service is going through temporary maintenance. */
             503: {
                 headers: {
@@ -11675,22 +11714,9 @@ export interface operations {
             };
         };
     };
-    "get-users": {
+    "sign-in-with-email": {
         parameters: {
-            query?: {
-                /** @description Whether the user is verified. */
-                is_verified?: boolean | null;
-                /** @description The ID of the user. */
-                user_id?: string[];
-                /** @description The email of the user, */
-                email?: string[];
-                /** @description The maximum number of users to retrieve. */
-                limit?: number;
-                /** @description The token from the previous request to return the next page of users. */
-                continuation_token?: number;
-                /** @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. */
-                sort_by?: string[];
-            };
+            query?: never;
             header?: {
                 /** @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. */
                 "x-mongo-cluster-name"?: string | null;
@@ -11701,7 +11727,11 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["user__sign_in_with_email__Request"];
+            };
+        };
         responses: {
             /** @description Succeeded. */
             200: {
@@ -11709,9 +11739,60 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["user__get_users__Response"];
+                    "application/json": components["schemas"]["user__sign_in_with_email__Response"];
                 };
             };
+            /** @description Specified organization or user is not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request path parameter or request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The service is going through temporary maintenance. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    "update-user-info-deprecated": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @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. */
+                "x-mongo-cluster-name"?: string | null;
+                "Sec-WebSocket-Protocol"?: string[];
+            };
+            path: {
+                /** @description The identifier of the user to update information for. */
+                requested_user_id: string;
+                organization: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["user__update_user_info__Request"];
+            };
+        };
+        responses: {
+            /** @description Succeeded. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Invalid authorization credentials. */
             401: {
                 headers: {
@@ -11726,21 +11807,28 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Specified organization is not found. */
+            /** @description Specified organization or user is not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Invalid request path parameter or request query parameter failed validation. */
+            /** @description A related operation is in progress. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request path parameter or request body failed validation. */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
+            /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
             429: {
                 headers: {
                     [name: string]: unknown;
@@ -11756,7 +11844,7 @@ export interface operations {
             };
         };
     };
-    "create-invited-user": {
+    "update-user-info": {
         parameters: {
             query?: never;
             header?: {
@@ -11765,24 +11853,24 @@ export interface operations {
                 "Sec-WebSocket-Protocol"?: string[];
             };
             path: {
+                /** @description The identifier of the user to update information for. */
+                requested_user_id: string;
                 organization: string;
             };
             cookie?: never;
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["user__create_invited_user__Request"];
+                "application/json": components["schemas"]["user__update_user_info__Request"];
             };
         };
         responses: {
-            /** @description Succeeded */
-            201: {
+            /** @description Succeeded. */
+            204: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["user__create_invited_user__Response"];
-                };
+                content?: never;
             };
             /** @description Invalid authorization credentials. */
             401: {
@@ -11798,14 +11886,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Specified organization or role is not found. */
+            /** @description Specified organization or user is not found. */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description User with the same email already exists in this organization, or a related operation is in progress. */
+            /** @description A related operation is in progress. */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -11910,6 +11998,76 @@ export interface operations {
             };
         };
     };
+    "get-user-model": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @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. */
+                "x-mongo-cluster-name"?: string | null;
+                "Sec-WebSocket-Protocol"?: string[];
+            };
+            path: {
+                organization: string;
+                /** @description The ID of the user whose user models to retrieve. */
+                user_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["user__get_user_model__Response"];
+                };
+            };
+            /** @description Invalid authorization credentials. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Missing required permissions. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Specified organization or user is not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request path parameter failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The user has exceeded the rate limit of 60 requests per minute for this endpoint. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The service is going through temporary maintenance. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     "get-memories": {
         parameters: {
             query?: {
@@ -12371,46 +12529,6 @@ export interface operations {
             };
         };
     };
-    "ping-server": {
-        parameters: {
-            query?: never;
-            header?: {
-                /** @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. */
-                "x-mongo-cluster-name"?: string | null;
-                "Sec-WebSocket-Protocol"?: string[];
-            };
-            path: {
-                organization: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Succeeded. */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["admin__ping_server__Response"];
-                };
-            };
-            /** @description The specified organization does not exist. */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Invalid request path parameter failed validation. */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
     "get-prompt-logs": {
         parameters: {
             query: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amigo-ai/sdk",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "description": "Amigo TypeScript SDK",
   "publishConfig": {
     "access": "public"