syllable-sdk 0.1.0-alpha.6 → 0.1.0-alpha.61

package/docs/sdks/targets/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to channel targets
+Operations related to channel target configuration. A channel target           links a channel to an agent, allowing users to communicate with the agent through that           channel. For more information, see           [Console docs](https://docs.syllable.ai/Resources/Channels).
 
 ### Available Operations
 
@@ -27,7 +27,17 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.channels.targets.availableTargets({});
+  const result = await syllableSDK.channels.targets.availableTargets({
+    page: 0,
+    searchFields: [
+      "channel_name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   // Handle the result
   console.log(result);
@@ -51,7 +61,17 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await channelsTargetsAvailableTargets(syllableSDK, {});
+  const res = await channelsTargetsAvailableTargets(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "channel_name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -100,7 +120,17 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.channels.targets.list({});
+  const result = await syllableSDK.channels.targets.list({
+    page: 0,
+    searchFields: [
+      "fallback_target",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   // Handle the result
   console.log(result);
@@ -124,7 +154,17 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await channelsTargetsList(syllableSDK, {});
+  const res = await channelsTargetsList(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "fallback_target",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -150,7 +190,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponseChannelTarget](../../models/components/listresponsechanneltarget.md)\>**
+**Promise\<[components.ListResponseChannelTargetResponse](../../models/components/listresponsechanneltargetresponse.md)\>**
 
 ### Errors
 
@@ -176,12 +216,10 @@ async function run() {
   const result = await syllableSDK.channels.targets.create({
     channelId: 134365,
     channelTargetCreateRequest: {
-      channelId: 486589,
-      agentId: 638424,
+      agentId: 486589,
+      channelId: 638424,
       target: "<value>",
-      targetMode: "<value>",
-      fallbackTarget: "<value>",
-      isTest: true,
+      targetMode: "chat",
     },
   });
 
@@ -210,12 +248,10 @@ async function run() {
   const res = await channelsTargetsCreate(syllableSDK, {
     channelId: 134365,
     channelTargetCreateRequest: {
-      channelId: 486589,
-      agentId: 638424,
+      agentId: 486589,
+      channelId: 638424,
       target: "<value>",
-      targetMode: "<value>",
-      fallbackTarget: "<value>",
-      isTest: true,
+      targetMode: "chat",
     },
   });
 
@@ -243,7 +279,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 
@@ -322,7 +358,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 
@@ -348,15 +384,12 @@ async function run() {
   const result = await syllableSDK.channels.targets.update({
     channelId: 627690,
     targetId: 488852,
-    channelTarget: {
-      id: 857478,
+    channelTargetUpdateRequest: {
+      agentId: 857478,
       channelId: 597129,
-      channelName: "<value>",
-      agentId: 344620,
       target: "<value>",
-      targetMode: "<value>",
-      fallbackTarget: "<value>",
-      isTest: false,
+      targetMode: "chat",
+      id: 991464,
     },
   });
 
@@ -385,15 +418,12 @@ async function run() {
   const res = await channelsTargetsUpdate(syllableSDK, {
     channelId: 627690,
     targetId: 488852,
-    channelTarget: {
-      id: 857478,
+    channelTargetUpdateRequest: {
+      agentId: 857478,
       channelId: 597129,
-      channelName: "<value>",
-      agentId: 344620,
       target: "<value>",
-      targetMode: "<value>",
-      fallbackTarget: "<value>",
-      isTest: false,
+      targetMode: "chat",
+      id: 991464,
     },
   });
 
@@ -421,7 +451,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/test/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations for testing agents with live text
+Operations for testing agents with live text.           These endpoints allow sending messages to an agent and receiving its responses.
 
 ### Available Operations
 

package/docs/sdks/tools/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to tools
+Operations related to tool configuration. A tool is a function that an           agent can call to perform actions like accessing databases, making API calls, or           processing data. For an agent to have access to a tool, the prompt associated with that           agent should be linked to the tool and include instructions to use it. For more           information, see [Console docs](https://docs.syllable.ai/Resources/Tools).
 
 ### Available Operations
 
@@ -11,6 +11,7 @@ Operations related to tools
 * [create](#create) - Create Tool
 * [update](#update) - Update Tool
 * [getByName](#getbyname) - Tool Info
+* [delete](#delete) - Delete Tool
 
 ## list
 
@@ -26,7 +27,17 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.tools.list({});
+  const result = await syllableSDK.tools.list({
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   // Handle the result
   console.log(result);
@@ -50,7 +61,17 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await toolsList(syllableSDK, {});
+  const res = await toolsList(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -76,7 +97,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponseTool](../../models/components/listresponsetool.md)\>**
+**Promise\<[components.ListResponseToolResponse](../../models/components/listresponsetoolresponse.md)\>**
 
 ### Errors
 
@@ -100,8 +121,25 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.tools.create({
-    name: "<value>",
-    serviceId: 486589,
+    name: "Weather Fetcher",
+    definition: {
+      tool: {
+        function: {
+          name: "weather_fetcher",
+          description: "Fetches weather data",
+          parameters: {
+
+          },
+        },
+      },
+      endpoint: {
+        url: "https://api.example.com",
+        method: "get",
+        argumentLocation: "path",
+      },
+      defaults: "<value>",
+    },
+    serviceId: 920994,
   });
 
   // Handle the result
@@ -127,8 +165,25 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await toolsCreate(syllableSDK, {
-    name: "<value>",
-    serviceId: 486589,
+    name: "Weather Fetcher",
+    definition: {
+      tool: {
+        function: {
+          name: "weather_fetcher",
+          description: "Fetches weather data",
+          parameters: {
+  
+          },
+        },
+      },
+      endpoint: {
+        url: "https://api.example.com",
+        method: "get",
+        argumentLocation: "path",
+      },
+      defaults: "<value>",
+    },
+    serviceId: 920994,
   });
 
   if (!res.ok) {
@@ -148,14 +203,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ToolCreate](../../models/components/toolcreate.md)                                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.ToolCreateRequest](../../models/components/toolcreaterequest.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\<[components.Tool](../../models/components/tool.md)\>**
+**Promise\<[components.ToolResponse](../../models/components/toolresponse.md)\>**
 
 ### Errors
 
@@ -179,9 +234,26 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.tools.update({
-    name: "<value>",
-    serviceId: 857478,
-    id: 597129,
+    name: "Weather Fetcher",
+    definition: {
+      tool: {
+        function: {
+          name: "weather_fetcher",
+          description: "Fetches weather data",
+          parameters: {
+
+          },
+        },
+      },
+      endpoint: {
+        url: "https://api.example.com",
+        method: "post",
+        argumentLocation: "path",
+      },
+      defaults: "<value>",
+    },
+    serviceId: 243447,
+    id: 265006,
   });
 
   // Handle the result
@@ -207,9 +279,26 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await toolsUpdate(syllableSDK, {
-    name: "<value>",
-    serviceId: 857478,
-    id: 597129,
+    name: "Weather Fetcher",
+    definition: {
+      tool: {
+        function: {
+          name: "weather_fetcher",
+          description: "Fetches weather data",
+          parameters: {
+  
+          },
+        },
+      },
+      endpoint: {
+        url: "https://api.example.com",
+        method: "post",
+        argumentLocation: "path",
+      },
+      defaults: "<value>",
+    },
+    serviceId: 243447,
+    id: 265006,
   });
 
   if (!res.ok) {
@@ -229,14 +318,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ToolUpdate](../../models/components/toolupdate.md)                                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.ToolUpdateRequest](../../models/components/toolupdaterequest.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\<[components.Tool](../../models/components/tool.md)\>**
+**Promise\<[components.ToolResponse](../../models/components/toolresponse.md)\>**
 
 ### Errors
 
@@ -317,6 +406,85 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## delete
+
+Delete a tool.
+
+### Example Usage
+
+```typescript
+import { SyllableSDK } from "syllable-sdk";
+
+const syllableSDK = new SyllableSDK({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const result = await syllableSDK.tools.delete({
+    toolName: "<value>",
+    reason: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SyllableSDKCore } from "syllable-sdk/core.js";
+import { toolsDelete } from "syllable-sdk/funcs/toolsDelete.js";
+
+// Use `SyllableSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const syllableSDK = new SyllableSDKCore({
+  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
+});
+
+async function run() {
+  const res = await toolsDelete(syllableSDK, {
+    toolName: "<value>",
+    reason: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ToolDeleteRequest](../../models/operations/tooldeleterequest.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\<[any](../../models/.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |

package/docs/sdks/transcript/README.md

@@ -3,8 +3,6 @@
 
 ## Overview
 
-Operations related to session transcription
-
 ### Available Operations
 
 * [getById](#getbyid) - Get Session Transcript By Id