syllable-sdk 1.0.12-rc.3 → 1.0.12-rc.4

package/src/models/components/custommessageconfig.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Additional configuration options for the message.
+ */
+export type CustomMessageConfig = {
+  /**
+   * The behavior of an agent assigned this message at the beginning of a user-initiated non-voice session (e.g., SMS, email, etc.). 'respond_only' will skip the message and respond to the user's message. 'greet_and_respond' will deliver the message and respond to the user's message. 'greet_only' will deliver the message and not respond to the user's message. Defaults to 'greet_only'.
+   */
+  userInitiatedNonVoiceSessionBehavior?: string | undefined;
+};
+
+/** @internal */
+export const CustomMessageConfig$inboundSchema: z.ZodType<
+  CustomMessageConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user_initiated_non_voice_session_behavior: z.string().default("greet_only"),
+}).transform((v) => {
+  return remap$(v, {
+    "user_initiated_non_voice_session_behavior":
+      "userInitiatedNonVoiceSessionBehavior",
+  });
+});
+/** @internal */
+export type CustomMessageConfig$Outbound = {
+  user_initiated_non_voice_session_behavior: string;
+};
+
+/** @internal */
+export const CustomMessageConfig$outboundSchema: z.ZodType<
+  CustomMessageConfig$Outbound,
+  z.ZodTypeDef,
+  CustomMessageConfig
+> = z.object({
+  userInitiatedNonVoiceSessionBehavior: z.string().default("greet_only"),
+}).transform((v) => {
+  return remap$(v, {
+    userInitiatedNonVoiceSessionBehavior:
+      "user_initiated_non_voice_session_behavior",
+  });
+});
+
+export function customMessageConfigToJSON(
+  customMessageConfig: CustomMessageConfig,
+): string {
+  return JSON.stringify(
+    CustomMessageConfig$outboundSchema.parse(customMessageConfig),
+  );
+}
+export function customMessageConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageConfig' from JSON`,
+  );
+}

package/src/models/components/custommessagecreaterequest.ts

@@ -6,6 +6,12 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomMessageConfig,
+  CustomMessageConfig$inboundSchema,
+  CustomMessageConfig$Outbound,
+  CustomMessageConfig$outboundSchema,
+} from "./custommessageconfig.js";
 import {
   CustomMessageRule,
   CustomMessageRule$inboundSchema,
@@ -33,6 +39,10 @@ export type CustomMessageCreateRequest = {
    * Rules for time-specific message variants
    */
   rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * Additional configuration options for the message.
+   */
+  config?: CustomMessageConfig | undefined;
   /**
    * Type of the custom message (must be "greeting" for now)
    */
@@ -49,6 +59,7 @@ export const CustomMessageCreateRequest$inboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  config: CustomMessageConfig$inboundSchema.optional(),
   type: z.string().default("greeting"),
 });
 /** @internal */
@@ -57,6 +68,7 @@ export type CustomMessageCreateRequest$Outbound = {
   text: string;
   label?: string | null | undefined;
   rules?: Array<CustomMessageRule$Outbound> | undefined;
+  config?: CustomMessageConfig$Outbound | undefined;
   type: string;
 };
 
@@ -70,6 +82,7 @@ export const CustomMessageCreateRequest$outboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  config: CustomMessageConfig$outboundSchema.optional(),
   type: z.string().default("greeting"),
 });
 

package/src/models/components/custommessageresponse.ts

@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomMessageConfig,
+  CustomMessageConfig$inboundSchema,
+  CustomMessageConfig$Outbound,
+  CustomMessageConfig$outboundSchema,
+} from "./custommessageconfig.js";
 import {
   CustomMessageRule,
   CustomMessageRule$inboundSchema,
@@ -41,6 +47,10 @@ export type CustomMessageResponse = {
    * Rules for time-specific message variants
    */
   rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * Additional configuration options for the message.
+   */
+  config?: CustomMessageConfig | undefined;
   /**
    * The ID of the custom message
    */
@@ -73,6 +83,7 @@ export const CustomMessageResponse$inboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  config: CustomMessageConfig$inboundSchema.optional(),
   id: z.number().int(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   agent_count: z.nullable(z.number().int()).optional(),
@@ -91,6 +102,7 @@ export type CustomMessageResponse$Outbound = {
   text: string;
   label?: string | null | undefined;
   rules?: Array<CustomMessageRule$Outbound> | undefined;
+  config?: CustomMessageConfig$Outbound | undefined;
   id: number;
   updated_at: string;
   agent_count?: number | null | undefined;
@@ -108,6 +120,7 @@ export const CustomMessageResponse$outboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  config: CustomMessageConfig$outboundSchema.optional(),
   id: z.number().int(),
   updatedAt: z.date().transform(v => v.toISOString()),
   agentCount: z.nullable(z.number().int()).optional(),

package/src/models/components/custommessageupdaterequest.ts

@@ -6,6 +6,12 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomMessageConfig,
+  CustomMessageConfig$inboundSchema,
+  CustomMessageConfig$Outbound,
+  CustomMessageConfig$outboundSchema,
+} from "./custommessageconfig.js";
 import {
   CustomMessageRule,
   CustomMessageRule$inboundSchema,
@@ -33,6 +39,10 @@ export type CustomMessageUpdateRequest = {
    * Rules for time-specific message variants
    */
   rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * Additional configuration options for the message.
+   */
+  config?: CustomMessageConfig | undefined;
   /**
    * The ID of the custom message
    */
@@ -53,6 +63,7 @@ export const CustomMessageUpdateRequest$inboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  config: CustomMessageConfig$inboundSchema.optional(),
   id: z.number().int(),
   type: z.string().default("greeting"),
 });
@@ -62,6 +73,7 @@ export type CustomMessageUpdateRequest$Outbound = {
   text: string;
   label?: string | null | undefined;
   rules?: Array<CustomMessageRule$Outbound> | undefined;
+  config?: CustomMessageConfig$Outbound | undefined;
   id: number;
   type: string;
 };
@@ -76,6 +88,7 @@ export const CustomMessageUpdateRequest$outboundSchema: z.ZodType<
   text: z.string(),
   label: z.nullable(z.string()).optional(),
   rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  config: CustomMessageConfig$outboundSchema.optional(),
   id: z.number().int(),
   type: z.string().default("greeting"),
 });

package/src/models/components/index.ts

@@ -46,6 +46,7 @@ export * from "./communicationrequestresult.js";
 export * from "./conversation.js";
 export * from "./conversationproperties.js";
 export * from "./createtakeoutresponse.js";
+export * from "./custommessageconfig.js";
 export * from "./custommessagecreaterequest.js";
 export * from "./custommessageproperties.js";
 export * from "./custommessageresponse.js";