@orq-ai/node 3.4.0-rc.36 → 3.5.11

package/{docs/sdks/sessions → packages/orq-rc/docs/sdks/files}/README.md

@@ -1,31 +1,33 @@
-# Sessions
-(*sessions*)
+# Files
+(*files*)
 
 ## Overview
 
 ### Available Operations
 
-* [create](#create) - Create Trace Session
-* [delete](#delete) - Delete Trace Session
-* [get](#get) - Get Trace Session
-* [update](#update) - Update Trace Session
-* [list](#list) - List sessions
+* [create](#create) - Create file
+* [list](#list) - List all files
+* [get](#get) - Retrieve a file
+* [delete](#delete) - Delete file
 
 ## create
 
-Create a session for traces
+Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/deploymentinvoke-1).
 
 ### Example Usage
 
 ```typescript
 import { Orq } from "@orq-ai/node";
+import { openAsBlob } from "node:fs";
 
 const orq = new Orq({
   apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
 async function run() {
-  const result = await orq.sessions.create();
+  const result = await orq.files.create({
+    file: await openAsBlob("example.file"),
+  });
 
   // Handle the result
   console.log(result);
@@ -40,7 +42,8 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { sessionsCreate } from "@orq-ai/node/funcs/sessionsCreate.js";
+import { filesCreate } from "@orq-ai/node/funcs/filesCreate.js";
+import { openAsBlob } from "node:fs";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -49,7 +52,9 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await sessionsCreate(orq);
+  const res = await filesCreate(orq, {
+    file: await openAsBlob("example.file"),
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -68,14 +73,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateSessionRequestBody](../../models/operations/createsessionrequestbody.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.FileUploadRequestBody](../../models/operations/fileuploadrequestbody.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.CreateSessionResponseBody](../../models/operations/createsessionresponsebody.md)\>**
+**Promise\<[operations.FileUploadResponseBody](../../models/operations/fileuploadresponsebody.md)\>**
 
 ### Errors
 
@@ -83,84 +88,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## delete
-
-Delete a trace session
-
-### Example Usage
-
-```typescript
-import { Orq } from "@orq-ai/node";
-
-const orq = new Orq({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  await orq.sessions.delete({
-    sessionId: "<id>",
-  });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { sessionsDelete } from "@orq-ai/node/funcs/sessionsDelete.js";
-
-// Use `OrqCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await sessionsDelete(orq, {
-    sessionId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeleteSessionRequest](../../models/operations/deletesessionrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<void\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.HonoApiError | 404                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
-
-## get
+## list
 
-Get a trace session
+Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.
 
 ### Example Usage
 
@@ -172,9 +102,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.sessions.get({
-    sessionId: "<id>",
-  });
+  const result = await orq.files.list({});
 
   // Handle the result
   console.log(result);
@@ -189,7 +117,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { sessionsGet } from "@orq-ai/node/funcs/sessionsGet.js";
+import { filesList } from "@orq-ai/node/funcs/filesList.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -198,9 +126,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await sessionsGet(orq, {
-    sessionId: "<id>",
-  });
+  const res = await filesList(orq, {});
 
   if (!res.ok) {
     throw res.error;
@@ -219,25 +145,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetSessionRequest](../../models/operations/getsessionrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.FileListRequest](../../models/operations/filelistrequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetSessionResponseBody](../../models/operations/getsessionresponsebody.md)\>**
+**Promise\<[operations.FileListResponseBody](../../models/operations/filelistresponsebody.md)\>**
 
 ### Errors
 
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.HonoApiError | 404                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## update
+## get
 
-Update a trace session
+Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object
 
 ### Example Usage
 
@@ -249,8 +174,8 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.sessions.update({
-    sessionId: "<id>",
+  const result = await orq.files.get({
+    fileId: "<id>",
   });
 
   // Handle the result
@@ -266,7 +191,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { sessionsUpdate } from "@orq-ai/node/funcs/sessionsUpdate.js";
+import { filesGet } from "@orq-ai/node/funcs/filesGet.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -275,8 +200,8 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await sessionsUpdate(orq, {
-    sessionId: "<id>",
+  const res = await filesGet(orq, {
+    fileId: "<id>",
   });
 
   if (!res.ok) {
@@ -296,25 +221,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.UpdateSessionRequest](../../models/operations/updatesessionrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.FileGetRequest](../../models/operations/filegetrequest.md)                                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.UpdateSessionResponseBody](../../models/operations/updatesessionresponsebody.md)\>**
+**Promise\<[operations.FileGetResponseBody](../../models/operations/filegetresponsebody.md)\>**
 
 ### Errors
 
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.HonoApiError | 404                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## list
+## delete
 
-Retrieves a paginated list of sessions for the current workspace.
+Delete file
 
 ### Example Usage
 
@@ -326,10 +250,11 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.sessions.list();
+  await orq.files.delete({
+    fileId: "<id>",
+  });
+
 
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -341,7 +266,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { sessionsList } from "@orq-ai/node/funcs/sessionsList.js";
+import { filesDelete } from "@orq-ai/node/funcs/filesDelete.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -350,7 +275,9 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await sessionsList(orq);
+  const res = await filesDelete(orq, {
+    fileId: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -358,8 +285,7 @@ async function run() {
 
   const { value: result } = res;
 
-  // Handle the result
-  console.log(result);
+  
 }
 
 run();
@@ -369,14 +295,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListSessionsRequestBody](../../models/operations/listsessionsrequestbody.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.FileDeleteRequest](../../models/operations/filedeleterequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.ListSessionsResponseBody](../../models/operations/listsessionsresponsebody.md)\>**
+**Promise\<void\>**
 
 ### Errors