syllable-sdk 0.1.0-alpha.73 → 0.1.0-alpha.75

package/README.md

@@ -197,11 +197,12 @@ run();
 
 ### [incidents](docs/sdks/incidents/README.md)
 
-* [getById](docs/sdks/incidents/README.md#getbyid) - Get Incident By Id
+* [list](docs/sdks/incidents/README.md#list) - List Incidents
+* [create](docs/sdks/incidents/README.md#create) - Create Incident
 * [update](docs/sdks/incidents/README.md#update) - Update Incident
+* [incidentGetOrganizations](docs/sdks/incidents/README.md#incidentgetorganizations) - Get Organizations
+* [getById](docs/sdks/incidents/README.md#getbyid) - Get Incident By Id
 * [delete](docs/sdks/incidents/README.md#delete) - Delete Incident
-* [create](docs/sdks/incidents/README.md#create) - Create Incident
-* [list](docs/sdks/incidents/README.md#list) - List Incidents
 
 ### [insights](docs/sdks/insights/README.md)
 
@@ -213,6 +214,7 @@ run();
 * [create](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
 * [getById](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
 * [update](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
+* [insightsToolTest](docs/sdks/syllablesdktools/README.md#insightstooltest) - Test Insights Tool
 * [insightToolGetDefinitions](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
 
 #### [insights.workflows](docs/sdks/workflows/README.md)
@@ -243,9 +245,9 @@ run();
 * [update](docs/sdks/batches/README.md#update) - Update Outbound Communication Batch
 * [delete](docs/sdks/batches/README.md#delete) - Delete Outbound Communication Batch
 * [upload](docs/sdks/batches/README.md#upload) - Upload Outbound Communication Batch
-* [outboundBatchResults](docs/sdks/batches/README.md#outboundbatchresults) - Fetch Outbound Communication Batch Results
-* [outboundBatchAdd](docs/sdks/batches/README.md#outboundbatchadd) - Create Outbound Communication Request
-* [outboundBatchRemove](docs/sdks/batches/README.md#outboundbatchremove) - Delete Requests By List Of Reference Ids
+* [results](docs/sdks/batches/README.md#results) - Fetch Outbound Communication Batch Results
+* [add](docs/sdks/batches/README.md#add) - Create Outbound Communication Request
+* [remove](docs/sdks/batches/README.md#remove) - Delete Requests By List Of Reference Ids
 
 #### [outbound.campaigns](docs/sdks/campaigns/README.md)
 
@@ -295,6 +297,10 @@ run();
 
 * [getById](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
 
+#### [sessions.latency](docs/sdks/latency/README.md)
+
+* [getById](docs/sdks/latency/README.md#getbyid) - Inspect Latency For Session
+
 #### [sessions.transcript](docs/sdks/transcript/README.md)
 
 * [getById](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
@@ -302,8 +308,8 @@ run();
 
 ### [takeouts](docs/sdks/takeouts/README.md)
 
-* [createTakeoutApiV1TakeoutsCreatePost](docs/sdks/takeouts/README.md#createtakeoutapiv1takeoutscreatepost) - Create Takeout
-* [getTakeoutApiV1TakeoutsGetJobIdGet](docs/sdks/takeouts/README.md#gettakeoutapiv1takeoutsgetjobidget) - Get Takeout
+* [create](docs/sdks/takeouts/README.md#create) - Create Takeout
+* [takeoutsGetByJobId](docs/sdks/takeouts/README.md#takeoutsgetbyjobid) - Get Takeout
 
 ### [tools](docs/sdks/tools/README.md)
 
@@ -313,15 +319,6 @@ run();
 * [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
 * [delete](docs/sdks/tools/README.md#delete) - Delete Tool
 
-### [v1](docs/sdks/v1/README.md)
-
-* [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**
-
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -371,11 +368,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`incidentsCreate`](docs/sdks/incidents/README.md#create) - Create Incident
 - [`incidentsDelete`](docs/sdks/incidents/README.md#delete) - Delete Incident
 - [`incidentsGetById`](docs/sdks/incidents/README.md#getbyid) - Get Incident By Id
+- [`incidentsIncidentGetOrganizations`](docs/sdks/incidents/README.md#incidentgetorganizations) - Get Organizations
 - [`incidentsList`](docs/sdks/incidents/README.md#list) - List Incidents
 - [`incidentsUpdate`](docs/sdks/incidents/README.md#update) - Update Incident
 - [`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
+- [`insightsToolsInsightsToolTest`](docs/sdks/syllablesdktools/README.md#insightstooltest) - Test Insights Tool
 - [`insightsToolsInsightToolGetDefinitions`](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
 - [`insightsToolsList`](docs/sdks/syllablesdktools/README.md#list) - Insight Tool List
 - [`insightsToolsUpdate`](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
@@ -390,13 +389,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`languageGroupsGetById`](docs/sdks/languagegroups/README.md#getbyid) - Get Language Group
 - [`languageGroupsList`](docs/sdks/languagegroups/README.md#list) - List Language Groups
 - [`languageGroupsUpdate`](docs/sdks/languagegroups/README.md#update) - Update Language Group
+- [`outboundBatchesAdd`](docs/sdks/batches/README.md#add) - Create Outbound Communication Request
 - [`outboundBatchesCreate`](docs/sdks/batches/README.md#create) - Create Outbound Communication Batch
 - [`outboundBatchesDelete`](docs/sdks/batches/README.md#delete) - Delete Outbound Communication Batch
 - [`outboundBatchesGetById`](docs/sdks/batches/README.md#getbyid) - Get Outbound Communication Batch
 - [`outboundBatchesList`](docs/sdks/batches/README.md#list) - List Outbound Communication Batches
-- [`outboundBatchesOutboundBatchAdd`](docs/sdks/batches/README.md#outboundbatchadd) - Create Outbound Communication Request
-- [`outboundBatchesOutboundBatchRemove`](docs/sdks/batches/README.md#outboundbatchremove) - Delete Requests By List Of Reference Ids
-- [`outboundBatchesOutboundBatchResults`](docs/sdks/batches/README.md#outboundbatchresults) - Fetch Outbound Communication Batch Results
+- [`outboundBatchesRemove`](docs/sdks/batches/README.md#remove) - Delete Requests By List Of Reference Ids
+- [`outboundBatchesResults`](docs/sdks/batches/README.md#results) - Fetch Outbound Communication Batch Results
 - [`outboundBatchesUpdate`](docs/sdks/batches/README.md#update) - Update Outbound Communication Batch
 - [`outboundBatchesUpload`](docs/sdks/batches/README.md#upload) - Upload Outbound Communication Batch
 - [`outboundCampaignsCreate`](docs/sdks/campaigns/README.md#create) - Create Outbound Communication Campaign
@@ -424,26 +423,21 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`sessionsFullSummaryGetById`](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
 - [`sessionsGenerateSessionRecordingUrls`](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
 - [`sessionsGetById`](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
+- [`sessionsLatencyGetById`](docs/sdks/latency/README.md#getbyid) - Inspect Latency For Session
 - [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
 - [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
 - [`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
+- [`takeoutsCreate`](docs/sdks/takeouts/README.md#create) - Create Takeout
+- [`takeoutsTakeoutsGetByJobId`](docs/sdks/takeouts/README.md#takeoutsgetbyjobid) - 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
-- [`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**
 - ~~[`dashboardsPostSessionsDashboard`](docs/sdks/dashboards/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
 - ~~[`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
 - ~~[`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
-- ~~[`v1PostSessionEventsDashboard`](docs/sdks/v1/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
-- ~~[`v1PostSessionsDashboard`](docs/sdks/v1/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
-- ~~[`v1PostSessionSummaryDashboard`](docs/sdks/v1/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
-- ~~[`v1PostSessionTransfersDashboard`](docs/sdks/v1/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->

package/docs/sdks/batches/README.md

@@ -13,9 +13,9 @@ Operations related to outbound campaign batches
 * [update](#update) - Update Outbound Communication Batch
 * [delete](#delete) - Delete Outbound Communication Batch
 * [upload](#upload) - Upload Outbound Communication Batch
-* [outboundBatchResults](#outboundbatchresults) - Fetch Outbound Communication Batch Results
-* [outboundBatchAdd](#outboundbatchadd) - Create Outbound Communication Request
-* [outboundBatchRemove](#outboundbatchremove) - Delete Requests By List Of Reference Ids
+* [results](#results) - Fetch Outbound Communication Batch Results
+* [add](#add) - Create Outbound Communication Request
+* [remove](#remove) - Delete Requests By List Of Reference Ids
 
 ## list
 
@@ -101,7 +101,7 @@ run();
 
 ### Response
 
-**Promise\<[components.CommunicationBatch[]](../../models/.md)\>**
+**Promise\<[components.ListResponseCommunicationBatch](../../models/components/listresponsecommunicationbatch.md)\>**
 
 ### Errors
 
@@ -125,9 +125,9 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.outbound.batches.create({
-    batchId: "20250117.9",
+    batchId: "20250409.9",
     campaignId: 1,
-    expiresOn: "2024-01-01T00:00:00Z",
+    expiresOn: "2025-04-10T00:00:00Z",
   });
 
   // Handle the result
@@ -153,9 +153,9 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await outboundBatchesCreate(syllableSDK, {
-    batchId: "20250117.9",
+    batchId: "20250409.9",
     campaignId: 1,
-    expiresOn: "2024-01-01T00:00:00Z",
+    expiresOn: "2025-04-10T00:00:00Z",
   });
 
   if (!res.ok) {
@@ -284,16 +284,9 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.outbound.batches.update({
     batchId: "<id>",
-    communicationBatch: {
-      batchId: "20250117.9",
-      campaignId: 1,
-      expiresOn: "2024-01-01T00:00:00Z",
-      count: 152,
-      createdAt: "2024-01-01T00:00:00Z",
-      deletedAt: "2024-01-01T00:00:00Z",
-      deletedReason: "User request",
-      lastWorkedOn: "2024-01-01T00:00:00Z",
-      lastUpdatedBy: "user@email.com",
+    communicationBatchUpdate: {
+      paused: false,
+      expiresOn: "2027-01-01T06:00:00Z",
     },
   });
 
@@ -321,16 +314,9 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await outboundBatchesUpdate(syllableSDK, {
     batchId: "<id>",
-    communicationBatch: {
-      batchId: "20250117.9",
-      campaignId: 1,
-      expiresOn: "2024-01-01T00:00:00Z",
-      count: 152,
-      createdAt: "2024-01-01T00:00:00Z",
-      deletedAt: "2024-01-01T00:00:00Z",
-      deletedReason: "User request",
-      lastWorkedOn: "2024-01-01T00:00:00Z",
-      lastUpdatedBy: "user@email.com",
+    communicationBatchUpdate: {
+      paused: false,
+      expiresOn: "2027-01-01T06:00:00Z",
     },
   });
 
@@ -535,7 +521,7 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
-## outboundBatchResults
+## results
 
 Fetch Outbound Communication Batch Results
 
@@ -549,7 +535,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.outbound.batches.outboundBatchResults({
+  const result = await syllableSDK.outbound.batches.results({
     batchId: "<id>",
   });
 
@@ -566,7 +552,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { outboundBatchesOutboundBatchResults } from "syllable-sdk/funcs/outboundBatchesOutboundBatchResults.js";
+import { outboundBatchesResults } from "syllable-sdk/funcs/outboundBatchesResults.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -575,7 +561,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await outboundBatchesOutboundBatchResults(syllableSDK, {
+  const res = await outboundBatchesResults(syllableSDK, {
     batchId: "<id>",
   });
 
@@ -612,7 +598,7 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
-## outboundBatchAdd
+## add
 
 Create Outbound Communication Request
 
@@ -626,10 +612,9 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.outbound.batches.outboundBatchAdd({
+  const result = await syllableSDK.outbound.batches.add({
     batchId: "<id>",
     communicationRequest: {
-      batchId: "20250117.9",
       referenceId: "12345",
       target: "user@email.com",
       requestVariables: {},
@@ -649,7 +634,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { outboundBatchesOutboundBatchAdd } from "syllable-sdk/funcs/outboundBatchesOutboundBatchAdd.js";
+import { outboundBatchesAdd } from "syllable-sdk/funcs/outboundBatchesAdd.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -658,10 +643,9 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await outboundBatchesOutboundBatchAdd(syllableSDK, {
+  const res = await outboundBatchesAdd(syllableSDK, {
     batchId: "<id>",
     communicationRequest: {
-      batchId: "20250117.9",
       referenceId: "12345",
       target: "user@email.com",
       requestVariables: {},
@@ -701,7 +685,7 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
-## outboundBatchRemove
+## remove
 
 Delete Requests By List Of Reference Ids
 
@@ -715,7 +699,7 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.outbound.batches.outboundBatchRemove({
+  const result = await syllableSDK.outbound.batches.remove({
     batchId: "<id>",
     requestBody: [
       "<value>",
@@ -736,7 +720,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SyllableSDKCore } from "syllable-sdk/core.js";
-import { outboundBatchesOutboundBatchRemove } from "syllable-sdk/funcs/outboundBatchesOutboundBatchRemove.js";
+import { outboundBatchesRemove } from "syllable-sdk/funcs/outboundBatchesRemove.js";
 
 // Use `SyllableSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -745,7 +729,7 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await outboundBatchesOutboundBatchRemove(syllableSDK, {
+  const res = await outboundBatchesRemove(syllableSDK, {
     batchId: "<id>",
     requestBody: [
       "<value>",

package/docs/sdks/campaigns/README.md

@@ -96,7 +96,7 @@ run();
 
 ### Response
 
-**Promise\<[components.OutboundCampaign[]](../../models/.md)\>**
+**Promise\<[components.ListResponseOutboundCampaign](../../models/components/listresponseoutboundcampaign.md)\>**
 
 ### Errors
 
@@ -121,14 +121,18 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.outbound.campaigns.create({
     campaignName: "Outbound Campaign 1",
+    description: "This is a test campaign",
+    label: "test",
     campaignVariables: {},
     dailyStartTime: "09:00:00",
     dailyEndTime: "17:00:00",
     timezone: "America/New_York",
-    source: "+19032900844",
+    source: "account@email.com",
     callerId: "19995551234",
     retryInterval: "12h",
-    pauseSeconds: 30,
+    activeDays: [
+      "mon",
+    ],
   });
 
   // Handle the result
@@ -155,14 +159,18 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await outboundCampaignsCreate(syllableSDK, {
     campaignName: "Outbound Campaign 1",
+    description: "This is a test campaign",
+    label: "test",
     campaignVariables: {},
     dailyStartTime: "09:00:00",
     dailyEndTime: "17:00:00",
     timezone: "America/New_York",
-    source: "+19032900844",
+    source: "account@email.com",
     callerId: "19995551234",
     retryInterval: "12h",
-    pauseSeconds: 30,
+    activeDays: [
+      "mon",
+    ],
   });
 
   if (!res.ok) {
@@ -213,7 +221,7 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.outbound.campaigns.getById({
-    campaignId: "<id>",
+    campaignId: <id>,
   });
 
   // Handle the result
@@ -239,7 +247,7 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await outboundCampaignsGetById(syllableSDK, {
-    campaignId: "<id>",
+    campaignId: <id>,
   });
 
   if (!res.ok) {
@@ -293,6 +301,8 @@ async function run() {
     campaignId: 344620,
     outboundCampaignInput: {
       campaignName: "Outbound Campaign 1",
+      description: "This is a test campaign",
+      label: "demo",
       campaignVariables: {},
       dailyStartTime: "09:00:00",
       dailyEndTime: "17:00:00",
@@ -300,7 +310,9 @@ async function run() {
       source: "account@email.com",
       callerId: "19995551234",
       retryInterval: "12h",
-      pauseSeconds: 30,
+      activeDays: [
+        "sun",
+      ],
     },
   });
 
@@ -330,6 +342,8 @@ async function run() {
     campaignId: 344620,
     outboundCampaignInput: {
       campaignName: "Outbound Campaign 1",
+      description: "This is a test campaign",
+      label: "demo",
       campaignVariables: {},
       dailyStartTime: "09:00:00",
       dailyEndTime: "17:00:00",
@@ -337,7 +351,9 @@ async function run() {
       source: "account@email.com",
       callerId: "19995551234",
       retryInterval: "12h",
-      pauseSeconds: 30,
+      activeDays: [
+        "sun",
+      ],
     },
   });