@salsita-ai/sdk 0.50.0-develop.c28cfb7ded → 0.50.0-develop.c402728d10

package/dist/client/phoenix-api.d.ts

@@ -55,6 +55,38 @@ export interface paths {
     readonly patch?: never
     readonly trace?: never
   }
+  readonly '/auth/callback': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly get: operations['completeBrowserLogin']
+    readonly put?: never
+    readonly post?: never
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
+  readonly '/auth/config': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly get: operations['getBrowserAuthConfig']
+    readonly put?: never
+    readonly post?: never
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
   readonly '/auth/identity': {
     readonly parameters: {
       readonly query?: never
@@ -72,6 +104,39 @@ export interface paths {
     readonly patch?: never
     readonly trace?: never
   }
+  readonly '/auth/login': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly get: operations['startBrowserLogin']
+    readonly put?: never
+    readonly post?: never
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
+  readonly '/auth/logout': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly get?: never
+    readonly put?: never
+    /** @description Destroy the local session and return the fixed Cognito hosted logout URL. Requires the exact shared Studio Origin. */
+    readonly post: operations['endBrowserSession']
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
   readonly '/auth/me': {
     readonly parameters: {
       readonly query?: never
@@ -89,6 +154,23 @@ export interface paths {
     readonly patch?: never
     readonly trace?: never
   }
+  readonly '/auth/session': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    /** @description Read the opaque browser session and current account status/memberships. Requires the exact shared Studio Origin. */
+    readonly get: operations['getBrowserSession']
+    readonly put?: never
+    readonly post?: never
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
   readonly '/auth/token': {
     readonly parameters: {
       readonly query?: never
@@ -297,6 +379,40 @@ export interface paths {
     readonly patch?: never
     readonly trace?: never
   }
+  readonly '/configurations/{configurationId}/assistant/images': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly get?: never
+    readonly put?: never
+    /** @description Store an image in the caller's thread on the configuration: a screenshot the browser took for a run of the assistant, or an image the user attaches to the message they are about to send. Creates the thread when the caller has none yet. The body is the raw JPEG or PNG image of at most 2 MB, with its type as the content type. The answer carries the id that messages and tool results reference the image by, as `assistant-image:<imageId>`. Answers 409 with the `x-assistant-thread-continuable: false` response header when the thread cannot take a new message of the user (closed, started with another setup or at its size limit) and is not in the middle of a reply (no run running and no client tool call waiting); the thread takes images again once it is compacted. Answers 413 for a body over 2 MB and 415 for any other content type. */
+    readonly post: operations['uploadAssistantImage']
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
+  readonly '/configurations/{configurationId}/assistant/images/{imageId}': {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    /** @description Load an image of one of the caller's assistant threads on the configuration, a screenshot or an image the user attached, the earlier threads of the chain included. The bytes never change, so the answer may be cached for good. Answers 404 for an image that is not in one of the caller's threads on this configuration. */
+    readonly get: operations['getAssistantImage']
+    readonly put?: never
+    readonly post?: never
+    readonly delete?: never
+    readonly options?: never
+    readonly head?: never
+    readonly patch?: never
+    readonly trace?: never
+  }
   readonly '/configurations/{configurationId}/chat': {
     readonly parameters: {
       readonly query?: never
@@ -1379,6 +1495,13 @@ export interface components {
        */
       readonly scopes?: readonly string[]
     }
+    /** @description Payload Too Large: The request body is larger than the route's limit. */
+    readonly PayloadTooLargeError: {
+      /** @example Request body is too large */
+      readonly message: string
+      /** @enum {number} */
+      readonly statusCode: 413
+    }
     /**
      * @description The slug of the project, used for repository and domain creation.
      * @example my-project
@@ -1421,6 +1544,13 @@ export interface components {
       /** @enum {number} */
       readonly statusCode: 401
     }
+    /** @description Unsupported Media Type: The request body is of a content type the route does not accept. */
+    readonly UnsupportedMediaTypeError: {
+      /** @example Unsupported Media Type! */
+      readonly message: string
+      /** @enum {number} */
+      readonly statusCode: 415
+    }
     /** @description A webhook resource to which the deployment can send requests. */
     readonly Webhook: {
       /**
@@ -1600,15 +1730,363 @@ export interface operations {
           readonly 'application/json': components['schemas']['UnauthorizedError']
         }
       }
-      /** @description Forbidden! */
-      readonly 403: {
-        headers: {
-          readonly [name: string]: unknown
-        }
-        content: {
-          readonly 'application/json': components['schemas']['ForbiddenError']
-        }
-      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly completeBrowserLogin: {
+    readonly parameters: {
+      readonly query: {
+        readonly code: string
+        readonly state: string
+      }
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description Redirect to the configured sign-in or Studio destination. */
+      readonly 302: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': Record<string, unknown>
+        }
+      }
+      /** @description Bad Request! */
+      readonly 400: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadRequestError']
+        }
+      }
+      /** @description Unauthorized! */
+      readonly 401: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnauthorizedError']
+        }
+      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description Service Unavailable! */
+      readonly 503: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ServiceUnavailableError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly getBrowserAuthConfig: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description Shared Studio origin when browser sign-in is configured; null otherwise. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': {
+            readonly studioOrigin: string | null
+          }
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly resolveIdentity: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description The Phoenix account and its active Cognito customer memberships. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': {
+            /** Format: uuid */
+            readonly userId: string
+            readonly workspaces: readonly {
+              /** Format: uuid */
+              readonly customerId: string
+              readonly name: string
+              /** @enum {string} */
+              readonly role: 'user' | 'admin' | 'superadmin'
+              readonly slug: string
+              readonly tags: readonly string[]
+              /** @enum {string} */
+              readonly type: 'standard' | 'sdk_builder'
+            }[]
+          }
+        }
+      }
+      /** @description Unauthorized! */
+      readonly 401: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnauthorizedError']
+        }
+      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description Service Unavailable! */
+      readonly 503: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ServiceUnavailableError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly startBrowserLogin: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description Redirect to the configured sign-in or Studio destination. */
+      readonly 302: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': Record<string, unknown>
+        }
+      }
+      /** @description Bad Request! */
+      readonly 400: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadRequestError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly endBrowserSession: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description Navigate to this URL to finish hosted logout. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': {
+            /** Format: uri */
+            readonly logoutUrl: string
+          }
+        }
+      }
+      /** @description Bad Request! */
+      readonly 400: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadRequestError']
+        }
+      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly getApiSession: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path?: never
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description The session of the API token. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': {
+            /** @description The SDK-builder customer (workspace) the API token acts in. */
+            readonly customer: {
+              /**
+               * Format: uuid
+               * @description Internal UUID of the SDK-builder workspace.
+               */
+              readonly id: string
+              /**
+               * @description Display name of the SDK-builder workspace.
+               * @example Acme
+               */
+              readonly name: string
+              readonly slug: components['schemas']['CustomeSlug']
+            }
+            /** @description Stable ID of the authenticated builder user. */
+            readonly userId: string
+          }
+        }
+      }
+      /** @description Unauthorized! */
+      readonly 401: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnauthorizedError']
+        }
+      }
       /** @description An unexpected error occurred! */
       readonly default: {
         headers: {
@@ -1620,7 +2098,7 @@ export interface operations {
       }
     }
   }
-  readonly resolveIdentity: {
+  readonly getBrowserSession: {
     readonly parameters: {
       readonly query?: never
       readonly header?: never
@@ -1629,13 +2107,14 @@ export interface operations {
     }
     readonly requestBody?: never
     readonly responses: {
-      /** @description The Phoenix account and its active Cognito customer memberships. */
+      /** @description Current account and fixed session expiry, in Unix milliseconds. */
       readonly 200: {
         headers: {
           readonly [name: string]: unknown
         }
         content: {
           readonly 'application/json': {
+            readonly expiresAt: number
             /** Format: uuid */
             readonly userId: string
             readonly workspaces: readonly {
@@ -1679,64 +2158,6 @@ export interface operations {
           readonly 'application/json': components['schemas']['NotFoundError']
         }
       }
-      /** @description Service Unavailable! */
-      readonly 503: {
-        headers: {
-          readonly [name: string]: unknown
-        }
-        content: {
-          readonly 'application/json': components['schemas']['ServiceUnavailableError']
-        }
-      }
-      /** @description An unexpected error occurred! */
-      readonly default: {
-        headers: {
-          readonly [name: string]: unknown
-        }
-        content: {
-          readonly 'application/json': components['schemas']['DefaultResponse']
-        }
-      }
-    }
-  }
-  readonly getApiSession: {
-    readonly parameters: {
-      readonly query?: never
-      readonly header?: never
-      readonly path?: never
-      readonly cookie?: never
-    }
-    readonly requestBody?: never
-    readonly responses: {
-      /** @description The session of the API token. */
-      readonly 200: {
-        headers: {
-          readonly [name: string]: unknown
-        }
-        content: {
-          readonly 'application/json': {
-            /** @description The SDK-builder customer (workspace) the API token acts in. */
-            readonly customer: {
-              /**
-               * @description Display name of the SDK-builder workspace.
-               * @example Acme
-               */
-              readonly name: string
-              readonly slug: components['schemas']['CustomeSlug']
-            }
-            readonly userId: string
-          }
-        }
-      }
-      /** @description Unauthorized! */
-      readonly 401: {
-        headers: {
-          readonly [name: string]: unknown
-        }
-        content: {
-          readonly 'application/json': components['schemas']['UnauthorizedError']
-        }
-      }
       /** @description An unexpected error occurred! */
       readonly default: {
         headers: {
@@ -1785,6 +2206,11 @@ export interface operations {
           readonly 'application/json': {
             /** @description The SDK-builder customer (workspace) the API token acts in. */
             readonly customer: {
+              /**
+               * Format: uuid
+               * @description Internal UUID of the SDK-builder workspace.
+               */
+              readonly id: string
               /**
                * @description Display name of the SDK-builder workspace.
                * @example Acme
@@ -1794,7 +2220,7 @@ export interface operations {
             }
             /** @description The API token (`phx_...`). */
             readonly token: string
-            /** @description The user who approved the sign-in. */
+            /** @description Stable ID of the builder user who approved the sign-in. */
             readonly userId: string
           }
         }
@@ -3030,6 +3456,202 @@ export interface operations {
       }
     }
   }
+  readonly uploadAssistantImage: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path: {
+        /** @description The configuration on which the caller's assistant thread is used. */
+        readonly configurationId: components['schemas']['ConfigurationUuid']
+      }
+      readonly cookie?: never
+    }
+    /** @description The JPEG or PNG image. */
+    readonly requestBody: {
+      readonly content: {
+        readonly 'image/jpeg': string
+        readonly 'image/png': string
+      }
+    }
+    readonly responses: {
+      /** @description The image was stored in the thread. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': {
+            /**
+             * Format: uuid
+             * @description The id messages and tool results reference the image by.
+             */
+            readonly imageId: string
+          }
+        }
+      }
+      /** @description Bad Request! */
+      readonly 400: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadRequestError']
+        }
+      }
+      /** @description Unauthorized! */
+      readonly 401: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnauthorizedError']
+        }
+      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description Conflict! */
+      readonly 409: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ConflictError']
+        }
+      }
+      /** @description Payload Too Large! */
+      readonly 413: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['PayloadTooLargeError']
+        }
+      }
+      /** @description Unsupported Media Type! */
+      readonly 415: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnsupportedMediaTypeError']
+        }
+      }
+      /** @description Bad Gateway! */
+      readonly 502: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadGatewayError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
+  readonly getAssistantImage: {
+    readonly parameters: {
+      readonly query?: never
+      readonly header?: never
+      readonly path: {
+        /** @description The configuration on which the caller's assistant thread is used. */
+        readonly configurationId: components['schemas']['ConfigurationUuid']
+        /** @description The image, as a message or a tool result references it. */
+        readonly imageId: string
+      }
+      readonly cookie?: never
+    }
+    readonly requestBody?: never
+    readonly responses: {
+      /** @description The image. */
+      readonly 200: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'image/jpeg': unknown
+          readonly 'image/png': unknown
+        }
+      }
+      /** @description Bad Request! */
+      readonly 400: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadRequestError']
+        }
+      }
+      /** @description Unauthorized! */
+      readonly 401: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['UnauthorizedError']
+        }
+      }
+      /** @description Forbidden! */
+      readonly 403: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['ForbiddenError']
+        }
+      }
+      /** @description Not Found! */
+      readonly 404: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['NotFoundError']
+        }
+      }
+      /** @description Bad Gateway! */
+      readonly 502: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['BadGatewayError']
+        }
+      }
+      /** @description An unexpected error occurred! */
+      readonly default: {
+        headers: {
+          readonly [name: string]: unknown
+        }
+        content: {
+          readonly 'application/json': components['schemas']['DefaultResponse']
+        }
+      }
+    }
+  }
   readonly getChatConversation: {
     readonly parameters: {
       readonly query?: never
@@ -4522,6 +5144,8 @@ export interface operations {
     readonly requestBody: {
       readonly content: {
         readonly 'application/json': {
+          /** @enum {string} */
+          readonly acceptResponseEncoding?: 'gzip'
           readonly sessionId: string
         }
       }
@@ -4619,6 +5243,7 @@ export interface operations {
           readonly headers?: {
             readonly [key: string]: string
           }
+          readonly isBase64Encoded?: boolean
           readonly requestId: string
           readonly sessionId: string
           readonly status: number