syllable-sdk 0.1.0-alpha.4 → 0.1.0-alpha.41

package/docs/sdks/dashboards/README.md

@@ -3,22 +3,23 @@
 
 ## Overview
 
-Operations related to system dashboard
+Operations related to dashboards. Currently the API/SDK           only supports fetching basic information about dashboards.
 
 ### Available Operations
 
-* [totalCallVolumeByWeekday](#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
-* [getTotalCallVolumeByHour](#gettotalcallvolumebyhour) - Get Total Call Volume By Hour
-* [getWeeklyCallVolumeByWeekday](#getweeklycallvolumebyweekday) - Get Weekly Call Volume By Weekday
-* [getDailyCallVolumeByHour](#getdailycallvolumebyhour) - Get Daily Call Volume By Hour
-* [getMonthlyCallVolumeByWeek](#getmonthlycallvolumebyweek) - Get Monthly Call Volume By Week
-* [getMonthlyCallVolumeByDay](#getmonthlycallvolumebyday) - Get Monthly Call Volume By Day
-* [getSessionSummary](#getsessionsummary) - Get Session Summary
-* [getSessionAgents](#getsessionagents) - Get Agents
+* [postListDashboard](#postlistdashboard) - Post List Dashboards
+* [postGetDashboard](#postgetdashboard) - Post Fetch Info
+* [~~postSessionEventsDashboard~~](#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
+* [~~postSessionSummaryDashboard~~](#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
+* [~~postSessionTransfersDashboard~~](#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
+* [~~postSessionsDashboard~~](#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
 
-## totalCallVolumeByWeekday
+## postListDashboard
 
-Get total call volume by weekday.
+METHOD: POST
+URL: /dashboard/list
+ARGUMENTS: None
+RETURNS: List of dashboards
 
 ### Example Usage
 
@@ -30,7 +31,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.totalCallVolumeByWeekday();
+  const result = await syllableSDK.dashboards.postListDashboard({});
 
   // Handle the result
   console.log(result);
@@ -45,7 +46,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsTotalCallVolumeByWeekday } from "syllable-sdk/funcs/dashboardsTotalCallVolumeByWeekday.js";
+import { dashboardsPostListDashboard } from "syllable-sdk/funcs/dashboardsPostListDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -54,7 +55,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsTotalCallVolumeByWeekday(syllableSDK);
+  const res = await dashboardsPostListDashboard(syllableSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -73,23 +74,28 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostListDashboardRequest](../../models/operations/postlistdashboardrequest.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.TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday](../../models/operations/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md)\>**
+**Promise\<[components.ListResponseDashboardResponse](../../models/components/listresponsedashboardresponse.md)\>**
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
-## getTotalCallVolumeByHour
+## postGetDashboard
 
-Get total call volume by hour.
+METHOD: POST
+URL: /dashboard/fetch_info
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
 
 ### Example Usage
 
@@ -101,7 +107,9 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getTotalCallVolumeByHour();
+  const result = await syllableSDK.dashboards.postGetDashboard({
+    dashboardName: "<value>",
+  });
 
   // Handle the result
   console.log(result);
@@ -116,7 +124,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetTotalCallVolumeByHour } from "syllable-sdk/funcs/dashboardsGetTotalCallVolumeByHour.js";
+import { dashboardsPostGetDashboard } from "syllable-sdk/funcs/dashboardsPostGetDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -125,7 +133,9 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetTotalCallVolumeByHour(syllableSDK);
+  const res = await dashboardsPostGetDashboard(syllableSDK, {
+    dashboardName: "<value>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -144,94 +154,31 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostGetDashboardRequest](../../models/operations/postgetdashboardrequest.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.GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour](../../models/operations/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md)\>**
+**Promise\<[components.DashboardTokenResponse](../../models/components/dashboardtokenresponse.md)\>**
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
-
-## getWeeklyCallVolumeByWeekday
-
-Get weekly call volume by weekday.
-
-### 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.dashboards.getWeeklyCallVolumeByWeekday();
-
-  // 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 { dashboardsGetWeeklyCallVolumeByWeekday } from "syllable-sdk/funcs/dashboardsGetWeeklyCallVolumeByWeekday.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 dashboardsGetWeeklyCallVolumeByWeekday(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\<[operations.GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday](../../models/operations/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md)\>**
-
-### Errors
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+## ~~postSessionEventsDashboard~~
 
-## getDailyCallVolumeByHour
+METHOD: POST
+URL: /dashboard/session_events
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
+DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
 
-Get daily call volume by hour.
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
 
 ### Example Usage
 
@@ -243,7 +190,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getDailyCallVolumeByHour();
+  const result = await syllableSDK.dashboards.postSessionEventsDashboard();
 
   // Handle the result
   console.log(result);
@@ -258,7 +205,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetDailyCallVolumeByHour } from "syllable-sdk/funcs/dashboardsGetDailyCallVolumeByHour.js";
+import { dashboardsPostSessionEventsDashboard } from "syllable-sdk/funcs/dashboardsPostSessionEventsDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -267,7 +214,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetDailyCallVolumeByHour(syllableSDK);
+  const res = await dashboardsPostSessionEventsDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -292,7 +239,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour](../../models/operations/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -300,9 +247,15 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getMonthlyCallVolumeByWeek
+## ~~postSessionSummaryDashboard~~
 
-Get monthly cal volume by week.
+METHOD: POST
+URL: /dashboard/session_summary
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
+DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
 
 ### Example Usage
 
@@ -314,7 +267,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getMonthlyCallVolumeByWeek();
+  const result = await syllableSDK.dashboards.postSessionSummaryDashboard();
 
   // Handle the result
   console.log(result);
@@ -329,7 +282,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetMonthlyCallVolumeByWeek } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByWeek.js";
+import { dashboardsPostSessionSummaryDashboard } from "syllable-sdk/funcs/dashboardsPostSessionSummaryDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -338,7 +291,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetMonthlyCallVolumeByWeek(syllableSDK);
+  const res = await dashboardsPostSessionSummaryDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -363,7 +316,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek](../../models/operations/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -371,9 +324,15 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getMonthlyCallVolumeByDay
+## ~~postSessionTransfersDashboard~~
+
+METHOD: POST
+URL: /dashboard/session_transfers
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
+DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
 
-Get monthly call volume by day.
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
 
 ### Example Usage
 
@@ -385,7 +344,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getMonthlyCallVolumeByDay();
+  const result = await syllableSDK.dashboards.postSessionTransfersDashboard();
 
   // Handle the result
   console.log(result);
@@ -400,7 +359,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetMonthlyCallVolumeByDay } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByDay.js";
+import { dashboardsPostSessionTransfersDashboard } from "syllable-sdk/funcs/dashboardsPostSessionTransfersDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -409,7 +368,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetMonthlyCallVolumeByDay(syllableSDK);
+  const res = await dashboardsPostSessionTransfersDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -434,7 +393,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay](../../models/operations/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -442,82 +401,15 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getSessionSummary
-
-Get session summary data
-
-### 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.dashboards.getSessionSummary({});
-
-  // 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 { dashboardsGetSessionSummary } from "syllable-sdk/funcs/dashboardsGetSessionSummary.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 dashboardsGetSessionSummary(syllableSDK, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetSessionSummaryRequest](../../models/operations/getsessionsummaryrequest.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.GetSessionSummaryResponseGetSessionSummary](../../models/operations/getsessionsummaryresponsegetsessionsummary.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+## ~~postSessionsDashboard~~
 
-## getSessionAgents
+METHOD: POST
+URL: /dashboard/sessions
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
+DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
 
-Get list of agents for session summary dropdown
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
 
 ### Example Usage
 
@@ -529,7 +421,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getSessionAgents();
+  const result = await syllableSDK.dashboards.postSessionsDashboard();
 
   // Handle the result
   console.log(result);
@@ -544,7 +436,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetSessionAgents } from "syllable-sdk/funcs/dashboardsGetSessionAgents.js";
+import { dashboardsPostSessionsDashboard } from "syllable-sdk/funcs/dashboardsPostSessionsDashboard.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -553,7 +445,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetSessionAgents(syllableSDK);
+  const res = await dashboardsPostSessionsDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -578,7 +470,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetSessionAgentsResponseGetSessionAgents](../../models/operations/getsessionagentsresponsegetsessionagents.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors