syllable-sdk 0.1.0-alpha.200 → 0.1.0-alpha.207

package/docs/sdks/targets/README.md

@@ -30,7 +30,7 @@ async function run() {
   const result = await syllableSDK.channels.targets.availableTargets({
     page: 0,
     searchFields: [
-      "target",
+      "channel_name",
     ],
     searchFieldValues: [
       "Some Object Name",
@@ -39,6 +39,7 @@ async function run() {
     endDatetime: "2024-01-01T00:00:00Z",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -63,7 +64,7 @@ async function run() {
   const res = await channelsTargetsAvailableTargets(syllableSDK, {
     page: 0,
     searchFields: [
-      "target",
+      "channel_name",
     ],
     searchFieldValues: [
       "Some Object Name",
@@ -71,12 +72,15 @@ async function run() {
     startDatetime: "2023-01-01T00:00:00Z",
     endDatetime: "2024-01-01T00:00:00Z",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTargetsAvailableTargets failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -119,7 +123,7 @@ async function run() {
   const result = await syllableSDK.channels.targets.list({
     page: 0,
     searchFields: [
-      "agent_id",
+      "fallback_target",
     ],
     searchFieldValues: [
       "Some Object Name",
@@ -128,6 +132,7 @@ async function run() {
     endDatetime: "2024-01-01T00:00:00Z",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -152,7 +157,7 @@ async function run() {
   const res = await channelsTargetsList(syllableSDK, {
     page: 0,
     searchFields: [
-      "agent_id",
+      "fallback_target",
     ],
     searchFieldValues: [
       "Some Object Name",
@@ -160,12 +165,15 @@ async function run() {
     startDatetime: "2023-01-01T00:00:00Z",
     endDatetime: "2024-01-01T00:00:00Z",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTargetsList failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -206,17 +214,17 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.channels.targets.create({
-    channelId: 824809,
+    channelId: 638424,
     channelTargetCreateRequest: {
       agentId: 1,
       channelId: 1,
       target: "+19995551234",
-      targetMode: "email",
+      targetMode: "chat",
       fallbackTarget: "+19995551235",
-      isTest: true,
     },
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -239,22 +247,24 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await channelsTargetsCreate(syllableSDK, {
-    channelId: 824809,
+    channelId: 638424,
     channelTargetCreateRequest: {
       agentId: 1,
       channelId: 1,
       target: "+19995551234",
-      targetMode: "email",
+      targetMode: "chat",
       fallbackTarget: "+19995551235",
-      isTest: true,
     },
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTargetsCreate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -295,10 +305,11 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.channels.targets.getById({
-    channelId: 184507,
-    targetId: 235358,
+    channelId: 931598,
+    targetId: 505057,
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -321,15 +332,18 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await channelsTargetsGetById(syllableSDK, {
-    channelId: 184507,
-    targetId: 235358,
+    channelId: 931598,
+    targetId: 505057,
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTargetsGetById failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -370,19 +384,19 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.channels.targets.update({
-    channelId: 508167,
-    targetId: 880236,
+    channelId: 597129,
+    targetId: 344620,
     channelTargetUpdateRequest: {
       agentId: 1,
       channelId: 1,
       target: "+19995551234",
       targetMode: "email",
       fallbackTarget: "+19995551235",
-      isTest: true,
       id: 1,
     },
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -405,24 +419,26 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await channelsTargetsUpdate(syllableSDK, {
-    channelId: 508167,
-    targetId: 880236,
+    channelId: 597129,
+    targetId: 344620,
     channelTargetUpdateRequest: {
       agentId: 1,
       channelId: 1,
       target: "+19995551234",
       targetMode: "email",
       fallbackTarget: "+19995551235",
-      isTest: true,
       id: 1,
     },
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTargetsUpdate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/docs/sdks/test/README.md

@@ -31,6 +31,7 @@ async function run() {
     agentId: "<id>",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -59,12 +60,15 @@ async function run() {
     testId: "<id>",
     agentId: "<id>",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("agentsTestSendTestMessage failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/docs/sdks/tools/README.md

@@ -39,6 +39,7 @@ async function run() {
     endDatetime: "2024-01-01T00:00:00Z",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -71,12 +72,15 @@ async function run() {
     startDatetime: "2023-01-01T00:00:00Z",
     endDatetime: "2024-01-01T00:00:00Z",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("toolsList failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -131,15 +135,15 @@ async function run() {
       },
       endpoint: {
         url: "https://api.example.com",
-        method: "post",
+        method: "get",
         argumentLocation: "path",
       },
       defaults: "<value>",
       staticParameters: [
         {
           name: "temperature_unit",
-          description: "Whether the temperature information should be fetched in Celsius or Fahrenheit",
-          required: false,
+          description: "Whether the temperature information should be fetched in celsius or fahrenheit.",
+          required: true,
           type: "string",
           default: "fahrenheit",
         },
@@ -148,6 +152,7 @@ async function run() {
     serviceId: 1,
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -184,15 +189,15 @@ async function run() {
       },
       endpoint: {
         url: "https://api.example.com",
-        method: "post",
+        method: "get",
         argumentLocation: "path",
       },
       defaults: "<value>",
       staticParameters: [
         {
           name: "temperature_unit",
-          description: "Whether the temperature information should be fetched in Celsius or Fahrenheit",
-          required: false,
+          description: "Whether the temperature information should be fetched in celsius or fahrenheit.",
+          required: true,
           type: "string",
           default: "fahrenheit",
         },
@@ -200,12 +205,15 @@ async function run() {
     },
     serviceId: 1,
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("toolsCreate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -260,15 +268,15 @@ async function run() {
       },
       endpoint: {
         url: "https://api.example.com",
-        method: "get",
-        argumentLocation: "form",
+        method: "post",
+        argumentLocation: "path",
       },
       defaults: "<value>",
       staticParameters: [
         {
           name: "temperature_unit",
-          description: "Whether the temperature information should be fetched in Celsius or Fahrenheit",
-          required: false,
+          description: "Whether the temperature information should be fetched in celsius or fahrenheit.",
+          required: true,
           type: "string",
           default: "fahrenheit",
         },
@@ -279,6 +287,7 @@ async function run() {
     lastUpdatedComments: "Updated to use new API endpoint",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -315,15 +324,15 @@ async function run() {
       },
       endpoint: {
         url: "https://api.example.com",
-        method: "get",
-        argumentLocation: "form",
+        method: "post",
+        argumentLocation: "path",
       },
       defaults: "<value>",
       staticParameters: [
         {
           name: "temperature_unit",
-          description: "Whether the temperature information should be fetched in Celsius or Fahrenheit",
-          required: false,
+          description: "Whether the temperature information should be fetched in celsius or fahrenheit.",
+          required: true,
           type: "string",
           default: "fahrenheit",
         },
@@ -333,12 +342,15 @@ async function run() {
     id: 1,
     lastUpdatedComments: "Updated to use new API endpoint",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("toolsUpdate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -382,6 +394,7 @@ async function run() {
     toolName: "<value>",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -406,12 +419,15 @@ async function run() {
   const res = await toolsGetByName(syllableSDK, {
     toolName: "<value>",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("toolsGetByName failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -456,6 +472,7 @@ async function run() {
     reason: "<value>",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -481,12 +498,15 @@ async function run() {
     toolName: "<value>",
     reason: "<value>",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("toolsDelete failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/docs/sdks/transcript/README.md

@@ -25,6 +25,7 @@ async function run() {
     sessionId: "<id>",
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -49,12 +50,15 @@ async function run() {
   const res = await sessionsTranscriptGetById(syllableSDK, {
     sessionId: "<id>",
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("sessionsTranscriptGetById failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/docs/sdks/twilio/README.md

@@ -26,9 +26,10 @@ const syllableSDK = new SyllableSDK({
 
 async function run() {
   const result = await syllableSDK.channels.twilio.getById({
-    channelId: 627671,
+    channelId: 931598,
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -51,14 +52,17 @@ const syllableSDK = new SyllableSDKCore({
 
 async function run() {
   const res = await channelsTwilioGetById(syllableSDK, {
-    channelId: 627671,
+    channelId: 931598,
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTwilioGetById failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -101,9 +105,13 @@ async function run() {
   const result = await syllableSDK.channels.twilio.update({
     id: 1,
     name: "syllable-webchat",
-    config: null,
+    config: {
+      accountSid: "AC123...",
+      authToken: "sometoken",
+    },
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -128,14 +136,20 @@ async function run() {
   const res = await channelsTwilioUpdate(syllableSDK, {
     id: 1,
     name: "syllable-webchat",
-    config: null,
+    config: {
+      accountSid: "AC123...",
+      authToken: "sometoken",
+    },
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTwilioUpdate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -183,6 +197,7 @@ async function run() {
     },
   });
 
+  // Handle the result
   console.log(result);
 }
 
@@ -211,12 +226,15 @@ async function run() {
       authToken: "sometoken",
     },
   });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("channelsTwilioCreate failed:", res.error);
+
+  if (!res.ok) {
+    throw res.error;
   }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
 }
 
 run();