syllable-sdk 0.1.0-alpha.70 → 0.1.0-alpha.71

package/README.md

@@ -196,6 +196,7 @@ run();
 
 ### [insights](docs/sdks/insights/README.md)
 
+* [list](docs/sdks/insights/README.md#list) - Insights List
 
 #### [insights.tools](docs/sdks/syllablesdktools/README.md)
 
@@ -229,6 +230,7 @@ run();
 * [getById](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
 * [delete](docs/sdks/prompts/README.md#delete) - Delete Prompt
 * [promptsHistory](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
+* [promptGetSupportedLlms](docs/sdks/prompts/README.md#promptgetsupportedllms) - Get Supported Llm Configs
 
 ### [services](docs/sdks/services/README.md)
 
@@ -270,6 +272,11 @@ run();
 * [getById](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
 
 
+### [takeouts](docs/sdks/takeouts/README.md)
+
+* [createTakeoutApiV1TakeoutsCreatePost](docs/sdks/takeouts/README.md#createtakeoutapiv1takeoutscreatepost) - Create Takeout
+* [getTakeoutApiV1TakeoutsGetJobIdGet](docs/sdks/takeouts/README.md#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
+
 ### [tools](docs/sdks/tools/README.md)
 
 * [list](docs/sdks/tools/README.md#list) - Tool List
@@ -280,12 +287,15 @@ run();
 
 ### [v1](docs/sdks/v1/README.md)
 
+* [list](docs/sdks/v1/README.md#list) - Insights List
 * [postListDashboard](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
 * [postGetDashboard](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
 * [~~postSessionEventsDashboard~~](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
 * [~~postSessionSummaryDashboard~~](docs/sdks/v1/README.md#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
 * [~~postSessionTransfersDashboard~~](docs/sdks/v1/README.md#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
 * [~~postSessionsDashboard~~](docs/sdks/v1/README.md#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
+* [createTakeoutApiV1TakeoutsCreatePost](docs/sdks/v1/README.md#createtakeoutapiv1takeoutscreatepost) - Create Takeout
+* [getTakeoutApiV1TakeoutsGetJobIdGet](docs/sdks/v1/README.md#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -333,6 +343,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`dataSourcesList`](docs/sdks/datasources/README.md#list) - List Data Sources
 - [`dataSourcesUpdate`](docs/sdks/datasources/README.md#update) - Update Data Source
 - [`eventsList`](docs/sdks/events/README.md#list) - Events List
+- [`insightsList`](docs/sdks/insights/README.md#list) - Insights List
 - [`insightsToolsCreate`](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
 - [`insightsToolsGetById`](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
 - [`insightsToolsInsightToolGetDefinitions`](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
@@ -352,6 +363,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
 - [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
 - [`promptsList`](docs/sdks/prompts/README.md#list) - Prompt List
+- [`promptsPromptGetSupportedLlms`](docs/sdks/prompts/README.md#promptgetsupportedllms) - Get Supported Llm Configs
 - [`promptsPromptsHistory`](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
 - [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update Prompt
 - [`servicesCreate`](docs/sdks/services/README.md#create) - Create Service
@@ -372,11 +384,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
 - [`sessionsSummaryGetById`](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
 - [`sessionsTranscriptGetById`](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
+- [`takeoutsCreateTakeoutApiV1TakeoutsCreatePost`](docs/sdks/takeouts/README.md#createtakeoutapiv1takeoutscreatepost) - Create Takeout
+- [`takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet`](docs/sdks/takeouts/README.md#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
 - [`toolsCreate`](docs/sdks/tools/README.md#create) - Create Tool
 - [`toolsDelete`](docs/sdks/tools/README.md#delete) - Delete Tool
 - [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
 - [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
 - [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
+- [`v1CreateTakeoutApiV1TakeoutsCreatePost`](docs/sdks/v1/README.md#createtakeoutapiv1takeoutscreatepost) - Create Takeout
+- [`v1GetTakeoutApiV1TakeoutsGetJobIdGet`](docs/sdks/v1/README.md#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
+- [`v1List`](docs/sdks/v1/README.md#list) - Insights List
 - [`v1PostGetDashboard`](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
 - [`v1PostListDashboard`](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
 - ~~[`dashboardsPostSessionEventsDashboard`](docs/sdks/dashboards/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**

package/docs/sdks/insights/README.md

@@ -3,4 +3,101 @@
 
 ## Overview
 
+Operations related to insights results. An insight is a tool that processes          conversation data to extract information and generate reports.
+
 ### Available Operations
+
+* [list](#list) - Insights List
+
+## list
+
+List the existing insight_tools
+
+### 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.insights.list({
+    page: 0,
+    searchFields: [
+      "insight_tool_id",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
+
+  // 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 { insightsList } from "syllable-sdk/funcs/insightsList.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 insightsList(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "insight_tool_id",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.InsightsListRequest](../../models/operations/insightslistrequest.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.ListResponseInsightsOutput](../../models/components/listresponseinsightsoutput.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/prompts/README.md

@@ -13,6 +13,7 @@ Operations related to prompts. A prompt defines the behavior of an           age
 * [getById](#getbyid) - Get Prompt By Id
 * [delete](#delete) - Delete Prompt
 * [promptsHistory](#promptshistory) - Get Prompt History
+* [promptGetSupportedLlms](#promptgetsupportedllms) - Get Supported Llm Configs
 
 ## list
 
@@ -127,7 +128,8 @@ async function run() {
     type: "prompt_v1",
     context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
     tools: [
-      "summary, hangup",
+      "summary",
+      "hangup",
     ],
     llmConfig: {
       version: "2024-05-13",
@@ -165,7 +167,8 @@ async function run() {
     type: "prompt_v1",
     context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
     tools: [
-      "summary, hangup",
+      "summary",
+      "hangup",
     ],
     llmConfig: {
       version: "2024-05-13",
@@ -228,7 +231,8 @@ async function run() {
     type: "prompt_v1",
     context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
     tools: [
-      "summary, hangup",
+      "summary",
+      "hangup",
     ],
     llmConfig: {
       version: "2024-05-13",
@@ -268,7 +272,8 @@ async function run() {
     type: "prompt_v1",
     context: "You are a weather agent. Answer the user's questions about weather and nothing else.",
     tools: [
-      "summary, hangup",
+      "summary",
+      "hangup",
     ],
     llmConfig: {
       version: "2024-05-13",
@@ -544,4 +549,75 @@ run();
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## promptGetSupportedLlms
+
+Get supported LLM configs.
+
+### 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.prompts.promptGetSupportedLlms();
+
+  // 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 { promptsPromptGetSupportedLlms } from "syllable-sdk/funcs/promptsPromptGetSupportedLlms.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 promptsPromptGetSupportedLlms(syllableSDK);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.SupportedLlm[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/takeouts/README.md

@@ -0,0 +1,163 @@
+# Takeouts
+(*takeouts*)
+
+## Overview
+
+### Available Operations
+
+* [createTakeoutApiV1TakeoutsCreatePost](#createtakeoutapiv1takeoutscreatepost) - Create Takeout
+* [getTakeoutApiV1TakeoutsGetJobIdGet](#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
+
+## createTakeoutApiV1TakeoutsCreatePost
+
+Create Takeout
+
+### 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.takeouts.createTakeoutApiV1TakeoutsCreatePost({
+    subOrganizationId: 38300,
+  });
+
+  // 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 { takeoutsCreateTakeoutApiV1TakeoutsCreatePost } from "syllable-sdk/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.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 takeoutsCreateTakeoutApiV1TakeoutsCreatePost(syllableSDK, {
+    subOrganizationId: 38300,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.DaoTakeoutCreate](../../models/components/daotakeoutcreate.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.CreateTakeoutResponse](../../models/components/createtakeoutresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## getTakeoutApiV1TakeoutsGetJobIdGet
+
+Get Takeout
+
+### 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.takeouts.getTakeoutApiV1TakeoutsGetJobIdGet({
+    jobId: "<id>",
+  });
+
+  // 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 { takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet } from "syllable-sdk/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.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 takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet(syllableSDK, {
+    jobId: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetTakeoutApiV1TakeoutsGetJobIdGetRequest](../../models/operations/gettakeoutapiv1takeoutsgetjobidgetrequest.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.TakeoutStatusResponse](../../models/components/takeoutstatusresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |