syllable-sdk 0.1.0-alpha.3 → 0.1.0-alpha.31

package/docs/sdks/dashboards/README.md

@@ -3,22 +3,21 @@
 
 ## 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
+* [postSessionEventsDashboard](#postsessioneventsdashboard) - Post Session Events
+* [postSessionSummaryDashboard](#postsessionsummarydashboard) - Post Session Summary
+* [postSessionTransfersDashboard](#postsessiontransfersdashboard) - Post Session Transfers
+* [postSessionsDashboard](#postsessionsdashboard) - Post Sessions
 
-## totalCallVolumeByWeekday
+## postSessionEventsDashboard
 
-Get total call volume by weekday.
+METHOD: POST
+URL: /dashboard/session_events
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
 
 ### Example Usage
 
@@ -30,7 +29,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.totalCallVolumeByWeekday();
+  const result = await syllableSDK.dashboards.postSessionEventsDashboard();
 
   // Handle the result
   console.log(result);
@@ -45,7 +44,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 { 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.
@@ -54,7 +53,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsTotalCallVolumeByWeekday(syllableSDK);
+  const res = await dashboardsPostSessionEventsDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -79,7 +78,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday](../../models/operations/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -87,9 +86,12 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getTotalCallVolumeByHour
+## postSessionSummaryDashboard
 
-Get total call volume by hour.
+METHOD: POST
+URL: /dashboard/session_summary
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
 
 ### Example Usage
 
@@ -101,7 +103,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getTotalCallVolumeByHour();
+  const result = await syllableSDK.dashboards.postSessionSummaryDashboard();
 
   // Handle the result
   console.log(result);
@@ -116,7 +118,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 { 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.
@@ -125,7 +127,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetTotalCallVolumeByHour(syllableSDK);
+  const res = await dashboardsPostSessionSummaryDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -150,7 +152,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour](../../models/operations/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -158,9 +160,12 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getWeeklyCallVolumeByWeekday
+## postSessionTransfersDashboard
 
-Get weekly call volume by weekday.
+METHOD: POST
+URL: /dashboard/session_transfers
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
 
 ### Example Usage
 
@@ -172,7 +177,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getWeeklyCallVolumeByWeekday();
+  const result = await syllableSDK.dashboards.postSessionTransfersDashboard();
 
   // Handle the result
   console.log(result);
@@ -187,7 +192,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { dashboardsGetWeeklyCallVolumeByWeekday } from "syllable-sdk/funcs/dashboardsGetWeeklyCallVolumeByWeekday.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.
@@ -196,7 +201,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetWeeklyCallVolumeByWeekday(syllableSDK);
+  const res = await dashboardsPostSessionTransfersDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -221,7 +226,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday](../../models/operations/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 
@@ -229,9 +234,12 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## getDailyCallVolumeByHour
+## postSessionsDashboard
 
-Get daily call volume by hour.
+METHOD: POST
+URL: /dashboard/sessions
+ARGUMENTS: None
+RETURNS: Dashboard info for embedding
 
 ### Example Usage
 
@@ -243,7 +251,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.dashboards.getDailyCallVolumeByHour();
+  const result = await syllableSDK.dashboards.postSessionsDashboard();
 
   // Handle the result
   console.log(result);
@@ -258,7 +266,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 { 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.
@@ -267,7 +275,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await dashboardsGetDailyCallVolumeByHour(syllableSDK);
+  const res = await dashboardsPostSessionsDashboard(syllableSDK);
 
   if (!res.ok) {
     throw res.error;
@@ -292,293 +300,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour](../../models/operations/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
-
-## getMonthlyCallVolumeByWeek
-
-Get monthly cal volume by week.
-
-### 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.getMonthlyCallVolumeByWeek();
-
-  // 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 { dashboardsGetMonthlyCallVolumeByWeek } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByWeek.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 dashboardsGetMonthlyCallVolumeByWeek(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.GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek](../../models/operations/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
-
-## getMonthlyCallVolumeByDay
-
-Get monthly call volume by day.
-
-### 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.getMonthlyCallVolumeByDay();
-
-  // 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 { dashboardsGetMonthlyCallVolumeByDay } from "syllable-sdk/funcs/dashboardsGetMonthlyCallVolumeByDay.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 dashboardsGetMonthlyCallVolumeByDay(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.GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay](../../models/operations/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| 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                   | \*/\*                      |
-
-## getSessionAgents
-
-Get list of agents for session summary dropdown
-
-### 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.getSessionAgents();
-
-  // 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 { dashboardsGetSessionAgents } from "syllable-sdk/funcs/dashboardsGetSessionAgents.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 dashboardsGetSessionAgents(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.GetSessionAgentsResponseGetSessionAgents](../../models/operations/getsessionagentsresponsegetsessionagents.md)\>**
+**Promise\<[components.Dashboard](../../models/components/dashboard.md)\>**
 
 ### Errors
 

package/docs/sdks/events/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to agent events
+Operations related to events. An event represents a specific occurrence           during a session. Currently the API/SDK only supports fetching logged events.
 
 ### Available Operations