syllable-sdk 0.1.0-alpha.7 → 0.1.0-alpha.70

package/src/models/components/custommessagecreaterequest.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomMessageRule,
+  CustomMessageRule$inboundSchema,
+  CustomMessageRule$Outbound,
+  CustomMessageRule$outboundSchema,
+} from "./custommessagerule.js";
+
+/**
+ * Request model to create a custom message.
+ */
+export type CustomMessageCreateRequest = {
+  /**
+   * The name of the custom message
+   */
+  name: string;
+  /**
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
+   */
+  text: string;
+  /**
+   * The label of the custom message
+   */
+  label?: string | null | undefined;
+  /**
+   * Rules for time-specific message variants
+   */
+  rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
+  type?: string | undefined;
+};
+
+/** @internal */
+export const CustomMessageCreateRequest$inboundSchema: z.ZodType<
+  CustomMessageCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  type: z.string().default("greeting"),
+});
+
+/** @internal */
+export type CustomMessageCreateRequest$Outbound = {
+  name: string;
+  text: string;
+  label?: string | null | undefined;
+  rules?: Array<CustomMessageRule$Outbound> | undefined;
+  type: string;
+};
+
+/** @internal */
+export const CustomMessageCreateRequest$outboundSchema: z.ZodType<
+  CustomMessageCreateRequest$Outbound,
+  z.ZodTypeDef,
+  CustomMessageCreateRequest
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  type: z.string().default("greeting"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageCreateRequest$ {
+  /** @deprecated use `CustomMessageCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageCreateRequest$inboundSchema;
+  /** @deprecated use `CustomMessageCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageCreateRequest$outboundSchema;
+  /** @deprecated use `CustomMessageCreateRequest$Outbound` instead. */
+  export type Outbound = CustomMessageCreateRequest$Outbound;
+}
+
+export function customMessageCreateRequestToJSON(
+  customMessageCreateRequest: CustomMessageCreateRequest,
+): string {
+  return JSON.stringify(
+    CustomMessageCreateRequest$outboundSchema.parse(customMessageCreateRequest),
+  );
+}
+
+export function customMessageCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageCreateRequest' from JSON`,
+  );
+}

package/src/models/components/custommessageproperties.ts

@@ -9,6 +9,8 @@ export const CustomMessageProperties = {
   Id: "id",
   Name: "name",
   Text: "text",
+  Label: "label",
+  UpdatedAt: "updated_at",
 } as const;
 export type CustomMessageProperties = ClosedEnum<
   typeof CustomMessageProperties

package/src/models/components/custommessageresponse.ts

@@ -0,0 +1,154 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  CustomMessageRule,
+  CustomMessageRule$inboundSchema,
+  CustomMessageRule$Outbound,
+  CustomMessageRule$outboundSchema,
+} from "./custommessagerule.js";
+
+/**
+ * Response model for custom message operations.
+ *
+ * @remarks
+ * 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).
+ */
+export type CustomMessageResponse = {
+  /**
+   * The name of the custom message
+   */
+  name: string;
+  /**
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
+   */
+  text: string;
+  /**
+   * The label of the custom message
+   */
+  label?: string | null | undefined;
+  /**
+   * Rules for time-specific message variants
+   */
+  rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * The ID of the custom message
+   */
+  id: number;
+  /**
+   * Timestamp of the most recent update to the custom message
+   */
+  updatedAt: Date;
+  /**
+   * The number of agents using the custom message
+   */
+  agentCount?: number | null | undefined;
+  /**
+   * The email address of the user who most recently updated the custom message
+   */
+  lastUpdatedBy: string;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
+  type?: string | undefined;
+};
+
+/** @internal */
+export const CustomMessageResponse$inboundSchema: z.ZodType<
+  CustomMessageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$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(),
+  last_updated_by: z.string(),
+  type: z.string().default("greeting"),
+}).transform((v) => {
+  return remap$(v, {
+    "updated_at": "updatedAt",
+    "agent_count": "agentCount",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type CustomMessageResponse$Outbound = {
+  name: string;
+  text: string;
+  label?: string | null | undefined;
+  rules?: Array<CustomMessageRule$Outbound> | undefined;
+  id: number;
+  updated_at: string;
+  agent_count?: number | null | undefined;
+  last_updated_by: string;
+  type: string;
+};
+
+/** @internal */
+export const CustomMessageResponse$outboundSchema: z.ZodType<
+  CustomMessageResponse$Outbound,
+  z.ZodTypeDef,
+  CustomMessageResponse
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  id: z.number().int(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+  agentCount: z.nullable(z.number().int()).optional(),
+  lastUpdatedBy: z.string(),
+  type: z.string().default("greeting"),
+}).transform((v) => {
+  return remap$(v, {
+    updatedAt: "updated_at",
+    agentCount: "agent_count",
+    lastUpdatedBy: "last_updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageResponse$ {
+  /** @deprecated use `CustomMessageResponse$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageResponse$inboundSchema;
+  /** @deprecated use `CustomMessageResponse$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageResponse$outboundSchema;
+  /** @deprecated use `CustomMessageResponse$Outbound` instead. */
+  export type Outbound = CustomMessageResponse$Outbound;
+}
+
+export function customMessageResponseToJSON(
+  customMessageResponse: CustomMessageResponse,
+): string {
+  return JSON.stringify(
+    CustomMessageResponse$outboundSchema.parse(customMessageResponse),
+  );
+}
+
+export function customMessageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageResponse' from JSON`,
+  );
+}

package/src/models/components/custommessagerule.ts

@@ -0,0 +1,135 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DayOfWeek,
+  DayOfWeek$inboundSchema,
+  DayOfWeek$outboundSchema,
+} from "./dayofweek.js";
+
+/**
+ * A rule used to determine whether a custom message should present a variant message based on
+ *
+ * @remarks
+ * the current timestamp.
+ */
+export type CustomMessageRule = {
+  /**
+   * The description of the rule
+   */
+  description: string;
+  /**
+   * The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
+   */
+  timeRangeStart?: string | null | undefined;
+  /**
+   * The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
+   */
+  timeRangeEnd?: string | null | undefined;
+  /**
+   * The date for the rule in YYYY-MM-DD format
+   */
+  date?: string | null | undefined;
+  /**
+   * The days of the week for the rule
+   */
+  daysOfWeek?: Array<DayOfWeek> | null | undefined;
+  /**
+   * Whether the rule logic should be inverted (i.e. "not")
+   */
+  invert: boolean;
+  /**
+   * Message text associated with the rule
+   */
+  text: string;
+};
+
+/** @internal */
+export const CustomMessageRule$inboundSchema: z.ZodType<
+  CustomMessageRule,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string(),
+  time_range_start: z.nullable(z.string()).optional(),
+  time_range_end: z.nullable(z.string()).optional(),
+  date: z.nullable(z.string()).optional(),
+  days_of_week: z.nullable(z.array(DayOfWeek$inboundSchema)).optional(),
+  invert: z.boolean(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "time_range_start": "timeRangeStart",
+    "time_range_end": "timeRangeEnd",
+    "days_of_week": "daysOfWeek",
+  });
+});
+
+/** @internal */
+export type CustomMessageRule$Outbound = {
+  description: string;
+  time_range_start?: string | null | undefined;
+  time_range_end?: string | null | undefined;
+  date?: string | null | undefined;
+  days_of_week?: Array<string> | null | undefined;
+  invert: boolean;
+  text: string;
+};
+
+/** @internal */
+export const CustomMessageRule$outboundSchema: z.ZodType<
+  CustomMessageRule$Outbound,
+  z.ZodTypeDef,
+  CustomMessageRule
+> = z.object({
+  description: z.string(),
+  timeRangeStart: z.nullable(z.string()).optional(),
+  timeRangeEnd: z.nullable(z.string()).optional(),
+  date: z.nullable(z.string()).optional(),
+  daysOfWeek: z.nullable(z.array(DayOfWeek$outboundSchema)).optional(),
+  invert: z.boolean(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    timeRangeStart: "time_range_start",
+    timeRangeEnd: "time_range_end",
+    daysOfWeek: "days_of_week",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageRule$ {
+  /** @deprecated use `CustomMessageRule$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageRule$inboundSchema;
+  /** @deprecated use `CustomMessageRule$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageRule$outboundSchema;
+  /** @deprecated use `CustomMessageRule$Outbound` instead. */
+  export type Outbound = CustomMessageRule$Outbound;
+}
+
+export function customMessageRuleToJSON(
+  customMessageRule: CustomMessageRule,
+): string {
+  return JSON.stringify(
+    CustomMessageRule$outboundSchema.parse(customMessageRule),
+  );
+}
+
+export function customMessageRuleFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageRule, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageRule$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageRule' from JSON`,
+  );
+}

package/src/models/components/custommessageupdaterequest.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomMessageRule,
+  CustomMessageRule$inboundSchema,
+  CustomMessageRule$Outbound,
+  CustomMessageRule$outboundSchema,
+} from "./custommessagerule.js";
+
+/**
+ * Request model to update an existing custom message.
+ */
+export type CustomMessageUpdateRequest = {
+  /**
+   * The name of the custom message
+   */
+  name: string;
+  /**
+   * The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
+   */
+  text: string;
+  /**
+   * The label of the custom message
+   */
+  label?: string | null | undefined;
+  /**
+   * Rules for time-specific message variants
+   */
+  rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * The ID of the custom message
+   */
+  id: number;
+  /**
+   * Type of the custom message (must be "greeting" for now)
+   */
+  type?: string | undefined;
+};
+
+/** @internal */
+export const CustomMessageUpdateRequest$inboundSchema: z.ZodType<
+  CustomMessageUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  id: z.number().int(),
+  type: z.string().default("greeting"),
+});
+
+/** @internal */
+export type CustomMessageUpdateRequest$Outbound = {
+  name: string;
+  text: string;
+  label?: string | null | undefined;
+  rules?: Array<CustomMessageRule$Outbound> | undefined;
+  id: number;
+  type: string;
+};
+
+/** @internal */
+export const CustomMessageUpdateRequest$outboundSchema: z.ZodType<
+  CustomMessageUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  CustomMessageUpdateRequest
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  id: z.number().int(),
+  type: z.string().default("greeting"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageUpdateRequest$ {
+  /** @deprecated use `CustomMessageUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageUpdateRequest$inboundSchema;
+  /** @deprecated use `CustomMessageUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageUpdateRequest$outboundSchema;
+  /** @deprecated use `CustomMessageUpdateRequest$Outbound` instead. */
+  export type Outbound = CustomMessageUpdateRequest$Outbound;
+}
+
+export function customMessageUpdateRequestToJSON(
+  customMessageUpdateRequest: CustomMessageUpdateRequest,
+): string {
+  return JSON.stringify(
+    CustomMessageUpdateRequest$outboundSchema.parse(customMessageUpdateRequest),
+  );
+}
+
+export function customMessageUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/dashboard.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * Deprecated.  Please update to use DashboardTokenResponse.
+ *
+ * @remarks
+ * Basic information about a dashboard.
+ */
+export type Dashboard = {
+  /**
+   * Superset embedded ID of the dashboard
+   */
+  embeddedId: string;
+  /**
+   * Superset guest token of the dashboard
+   */
+  guestToken: string;
+  /**
+   * Name of the dashboard
+   */
+  name: string;
+  /**
+   * Superset URL of the dashboard
+   */
+  supersetUrl: string;
+};
+
+/** @internal */
+export const Dashboard$inboundSchema: z.ZodType<
+  Dashboard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  embedded_id: z.string(),
+  guest_token: z.string(),
+  name: z.string(),
+  superset_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "embedded_id": "embeddedId",
+    "guest_token": "guestToken",
+    "superset_url": "supersetUrl",
+  });
+});
+
+/** @internal */
+export type Dashboard$Outbound = {
+  embedded_id: string;
+  guest_token: string;
+  name: string;
+  superset_url: string;
+};
+
+/** @internal */
+export const Dashboard$outboundSchema: z.ZodType<
+  Dashboard$Outbound,
+  z.ZodTypeDef,
+  Dashboard
+> = z.object({
+  embeddedId: z.string(),
+  guestToken: z.string(),
+  name: z.string(),
+  supersetUrl: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddedId: "embedded_id",
+    guestToken: "guest_token",
+    supersetUrl: "superset_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Dashboard$ {
+  /** @deprecated use `Dashboard$inboundSchema` instead. */
+  export const inboundSchema = Dashboard$inboundSchema;
+  /** @deprecated use `Dashboard$outboundSchema` instead. */
+  export const outboundSchema = Dashboard$outboundSchema;
+  /** @deprecated use `Dashboard$Outbound` instead. */
+  export type Outbound = Dashboard$Outbound;
+}
+
+export function dashboardToJSON(dashboard: Dashboard): string {
+  return JSON.stringify(Dashboard$outboundSchema.parse(dashboard));
+}
+
+export function dashboardFromJSON(
+  jsonString: string,
+): SafeParseResult<Dashboard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Dashboard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Dashboard' from JSON`,
+  );
+}

package/src/models/components/dashboardproperties.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Names of dashboard fields supported for filtering/sorting on list endpoint.
+ */
+export const DashboardProperties = {
+  Id: "id",
+  Name: "name",
+  DisplayName: "display_name",
+  Rank: "rank",
+  Label: "label",
+} as const;
+/**
+ * Names of dashboard fields supported for filtering/sorting on list endpoint.
+ */
+export type DashboardProperties = ClosedEnum<typeof DashboardProperties>;
+
+/** @internal */
+export const DashboardProperties$inboundSchema: z.ZodNativeEnum<
+  typeof DashboardProperties
+> = z.nativeEnum(DashboardProperties);
+
+/** @internal */
+export const DashboardProperties$outboundSchema: z.ZodNativeEnum<
+  typeof DashboardProperties
+> = DashboardProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DashboardProperties$ {
+  /** @deprecated use `DashboardProperties$inboundSchema` instead. */
+  export const inboundSchema = DashboardProperties$inboundSchema;
+  /** @deprecated use `DashboardProperties$outboundSchema` instead. */
+  export const outboundSchema = DashboardProperties$outboundSchema;
+}