syllable-sdk 0.1.0-alpha.6 → 0.1.0-alpha.61

package/docs/sdks/custommessages/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to custom messages
+Operations related to custom message configuration.           A custom message is a pre-configured message delivered by an agent as a greeting at the           beginning of a conversation. Multiple agents can use the same custom mesasage. A custom           message has one or more rules defined, which allow for different messages to be           dynamically selected and delivered at runtime based on the current time and either           date or day of the week. For more information, see           [Console docs](https://docs.syllable.ai/Resources/Messages).
 
 ### Available Operations
 
@@ -27,7 +27,17 @@ const syllableSDK = new SyllableSDK({
 });
 
 async function run() {
-  const result = await syllableSDK.customMessages.list({});
+  const result = await syllableSDK.customMessages.list({
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   // Handle the result
   console.log(result);
@@ -51,7 +61,17 @@ const syllableSDK = new SyllableSDKCore({
 });
 
 async function run() {
-  const res = await customMessagesList(syllableSDK, {});
+  const res = await customMessagesList(syllableSDK, {
+    page: 0,
+    searchFields: [
+      "name",
+    ],
+    searchFieldValues: [
+      "Some Object Name",
+    ],
+    startDatetime: "2023-01-01T00:00:00Z",
+    endDatetime: "2024-01-01T00:00:00Z",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -77,7 +97,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponseCustomMessage](../../models/components/listresponsecustommessage.md)\>**
+**Promise\<[components.ListResponseCustomMessageResponse](../../models/components/listresponsecustommessageresponse.md)\>**
 
 ### Errors
 
@@ -88,7 +108,7 @@ run();
 
 ## create
 
-Create a new greeting
+Create a new custom message
 
 ### Example Usage
 
@@ -103,6 +123,38 @@ async function run() {
   const result = await syllableSDK.customMessages.create({
     name: "<value>",
     text: "<value>",
+    rules: [
+      {
+        description: "delightfully fumigate convection though zowie up bulky electronics",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: false,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "yuck forager beneath please shadowy foodstuffs welcome",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+    ],
   });
 
   // Handle the result
@@ -130,6 +182,38 @@ async function run() {
   const res = await customMessagesCreate(syllableSDK, {
     name: "<value>",
     text: "<value>",
+    rules: [
+      {
+        description: "delightfully fumigate convection though zowie up bulky electronics",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: false,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "yuck forager beneath please shadowy foodstuffs welcome",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+    ],
   });
 
   if (!res.ok) {
@@ -149,14 +233,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CustomMessageCreate](../../models/components/custommessagecreate.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.CustomMessageCreateRequest](../../models/components/custommessagecreaterequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.CustomMessage](../../models/components/custommessage.md)\>**
+**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
 
 ### Errors
 
@@ -167,7 +251,7 @@ run();
 
 ## update
 
-Update a greeting
+Update a custom message
 
 ### Example Usage
 
@@ -182,7 +266,54 @@ async function run() {
   const result = await syllableSDK.customMessages.update({
     name: "<value>",
     text: "<value>",
-    id: 857478,
+    rules: [
+      {
+        description: "technician eulogise whereas till mild than during",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "qualified cycle woot abseil perfumed fisherman with duh",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "ultimately in likely opera please antelope",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+    ],
+    id: 975440,
   });
 
   // Handle the result
@@ -210,7 +341,54 @@ async function run() {
   const res = await customMessagesUpdate(syllableSDK, {
     name: "<value>",
     text: "<value>",
-    id: 857478,
+    rules: [
+      {
+        description: "technician eulogise whereas till mild than during",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "qualified cycle woot abseil perfumed fisherman with duh",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+      {
+        description: "ultimately in likely opera please antelope",
+        timeRangeStart: "09:00",
+        timeRangeEnd: "17:00",
+        date: "2025-01-01",
+        daysOfWeek: [
+          "mo",
+          "tu",
+          "we",
+          "th",
+          "fr",
+        ],
+        invert: true,
+        text: "Sorry, we're closed today",
+      },
+    ],
+    id: 975440,
   });
 
   if (!res.ok) {
@@ -230,14 +408,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CustomMessage](../../models/components/custommessage.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.CustomMessageUpdateRequest](../../models/components/custommessageupdaterequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.CustomMessage](../../models/components/custommessage.md)\>**
+**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
 
 ### Errors
 
@@ -248,7 +426,7 @@ run();
 
 ## getById
 
-Get the greeting by its ID
+Get the custom message by its ID
 
 ### Example Usage
 
@@ -314,7 +492,7 @@ run();
 
 ### Response
 
-**Promise\<[components.CustomMessage](../../models/components/custommessage.md)\>**
+**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
 
 ### Errors
 
@@ -325,7 +503,7 @@ run();
 
 ## delete
 
-Delete greeting by ID
+Delete custom message by ID
 
 ### Example Usage