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

package/src/models/components/latencyentry.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 {
+  LatencyCategory,
+  LatencyCategory$inboundSchema,
+  LatencyCategory$outboundSchema,
+} from "./latencycategory.js";
+import {
+  LatencyUnitType,
+  LatencyUnitType$inboundSchema,
+  LatencyUnitType$outboundSchema,
+} from "./latencyunittype.js";
+
+/**
+ * Data model for latency entries.
+ */
+export type LatencyEntry = {
+  timestamp: Date;
+  measurementStart: Date;
+  category: LatencyCategory;
+  label: string;
+  metadata?: Array<string> | null | undefined;
+  unitType: LatencyUnitType;
+  value: number;
+  valueStr: string;
+  timeDelta: string;
+};
+
+/** @internal */
+export const LatencyEntry$inboundSchema: z.ZodType<
+  LatencyEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  measurement_start: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  category: LatencyCategory$inboundSchema,
+  label: z.string(),
+  metadata: z.nullable(z.array(z.string())).optional(),
+  unit_type: LatencyUnitType$inboundSchema,
+  value: z.number(),
+  value_str: z.string(),
+  time_delta: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "measurement_start": "measurementStart",
+    "unit_type": "unitType",
+    "value_str": "valueStr",
+    "time_delta": "timeDelta",
+  });
+});
+
+/** @internal */
+export type LatencyEntry$Outbound = {
+  timestamp: string;
+  measurement_start: string;
+  category: string;
+  label: string;
+  metadata?: Array<string> | null | undefined;
+  unit_type: string;
+  value: number;
+  value_str: string;
+  time_delta: string;
+};
+
+/** @internal */
+export const LatencyEntry$outboundSchema: z.ZodType<
+  LatencyEntry$Outbound,
+  z.ZodTypeDef,
+  LatencyEntry
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+  measurementStart: z.date().transform(v => v.toISOString()),
+  category: LatencyCategory$outboundSchema,
+  label: z.string(),
+  metadata: z.nullable(z.array(z.string())).optional(),
+  unitType: LatencyUnitType$outboundSchema,
+  value: z.number(),
+  valueStr: z.string(),
+  timeDelta: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    measurementStart: "measurement_start",
+    unitType: "unit_type",
+    valueStr: "value_str",
+    timeDelta: "time_delta",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LatencyEntry$ {
+  /** @deprecated use `LatencyEntry$inboundSchema` instead. */
+  export const inboundSchema = LatencyEntry$inboundSchema;
+  /** @deprecated use `LatencyEntry$outboundSchema` instead. */
+  export const outboundSchema = LatencyEntry$outboundSchema;
+  /** @deprecated use `LatencyEntry$Outbound` instead. */
+  export type Outbound = LatencyEntry$Outbound;
+}
+
+export function latencyEntryToJSON(latencyEntry: LatencyEntry): string {
+  return JSON.stringify(LatencyEntry$outboundSchema.parse(latencyEntry));
+}
+
+export function latencyEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<LatencyEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LatencyEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LatencyEntry' from JSON`,
+  );
+}

package/src/models/components/latencyunittype.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const LatencyUnitType = {
+  Minutes: "minutes",
+  Seconds: "seconds",
+  Milliseconds: "milliseconds",
+  Microseconds: "microseconds",
+  Nanoseconds: "nanoseconds",
+} as const;
+export type LatencyUnitType = ClosedEnum<typeof LatencyUnitType>;
+
+/** @internal */
+export const LatencyUnitType$inboundSchema: z.ZodNativeEnum<
+  typeof LatencyUnitType
+> = z.nativeEnum(LatencyUnitType);
+
+/** @internal */
+export const LatencyUnitType$outboundSchema: z.ZodNativeEnum<
+  typeof LatencyUnitType
+> = LatencyUnitType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LatencyUnitType$ {
+  /** @deprecated use `LatencyUnitType$inboundSchema` instead. */
+  export const inboundSchema = LatencyUnitType$inboundSchema;
+  /** @deprecated use `LatencyUnitType$outboundSchema` instead. */
+  export const outboundSchema = LatencyUnitType$outboundSchema;
+}

package/src/models/components/listresponsecommunicationbatch.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 {
+  CommunicationBatch,
+  CommunicationBatch$inboundSchema,
+  CommunicationBatch$Outbound,
+  CommunicationBatch$outboundSchema,
+} from "./communicationbatch.js";
+
+export type ListResponseCommunicationBatch = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<CommunicationBatch>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseCommunicationBatch$inboundSchema: z.ZodType<
+  ListResponseCommunicationBatch,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(CommunicationBatch$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseCommunicationBatch$Outbound = {
+  items: Array<CommunicationBatch$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseCommunicationBatch$outboundSchema: z.ZodType<
+  ListResponseCommunicationBatch$Outbound,
+  z.ZodTypeDef,
+  ListResponseCommunicationBatch
+> = z.object({
+  items: z.array(CommunicationBatch$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseCommunicationBatch$ {
+  /** @deprecated use `ListResponseCommunicationBatch$inboundSchema` instead. */
+  export const inboundSchema = ListResponseCommunicationBatch$inboundSchema;
+  /** @deprecated use `ListResponseCommunicationBatch$outboundSchema` instead. */
+  export const outboundSchema = ListResponseCommunicationBatch$outboundSchema;
+  /** @deprecated use `ListResponseCommunicationBatch$Outbound` instead. */
+  export type Outbound = ListResponseCommunicationBatch$Outbound;
+}
+
+export function listResponseCommunicationBatchToJSON(
+  listResponseCommunicationBatch: ListResponseCommunicationBatch,
+): string {
+  return JSON.stringify(
+    ListResponseCommunicationBatch$outboundSchema.parse(
+      listResponseCommunicationBatch,
+    ),
+  );
+}
+
+export function listResponseCommunicationBatchFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseCommunicationBatch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseCommunicationBatch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseCommunicationBatch' from JSON`,
+  );
+}

package/src/models/components/listresponseincidentresponse.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 {
+  IncidentResponse,
+  IncidentResponse$inboundSchema,
+  IncidentResponse$Outbound,
+  IncidentResponse$outboundSchema,
+} from "./incidentresponse.js";
+
+export type ListResponseIncidentResponse = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<IncidentResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseIncidentResponse$inboundSchema: z.ZodType<
+  ListResponseIncidentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(IncidentResponse$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseIncidentResponse$Outbound = {
+  items: Array<IncidentResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseIncidentResponse$outboundSchema: z.ZodType<
+  ListResponseIncidentResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseIncidentResponse
+> = z.object({
+  items: z.array(IncidentResponse$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseIncidentResponse$ {
+  /** @deprecated use `ListResponseIncidentResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseIncidentResponse$inboundSchema;
+  /** @deprecated use `ListResponseIncidentResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponseIncidentResponse$outboundSchema;
+  /** @deprecated use `ListResponseIncidentResponse$Outbound` instead. */
+  export type Outbound = ListResponseIncidentResponse$Outbound;
+}
+
+export function listResponseIncidentResponseToJSON(
+  listResponseIncidentResponse: ListResponseIncidentResponse,
+): string {
+  return JSON.stringify(
+    ListResponseIncidentResponse$outboundSchema.parse(
+      listResponseIncidentResponse,
+    ),
+  );
+}
+
+export function listResponseIncidentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseIncidentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseIncidentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseIncidentResponse' from JSON`,
+  );
+}

package/src/models/components/listresponseoutboundcampaign.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 {
+  OutboundCampaign,
+  OutboundCampaign$inboundSchema,
+  OutboundCampaign$Outbound,
+  OutboundCampaign$outboundSchema,
+} from "./outboundcampaign.js";
+
+export type ListResponseOutboundCampaign = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<OutboundCampaign>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseOutboundCampaign$inboundSchema: z.ZodType<
+  ListResponseOutboundCampaign,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(OutboundCampaign$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseOutboundCampaign$Outbound = {
+  items: Array<OutboundCampaign$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseOutboundCampaign$outboundSchema: z.ZodType<
+  ListResponseOutboundCampaign$Outbound,
+  z.ZodTypeDef,
+  ListResponseOutboundCampaign
+> = z.object({
+  items: z.array(OutboundCampaign$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseOutboundCampaign$ {
+  /** @deprecated use `ListResponseOutboundCampaign$inboundSchema` instead. */
+  export const inboundSchema = ListResponseOutboundCampaign$inboundSchema;
+  /** @deprecated use `ListResponseOutboundCampaign$outboundSchema` instead. */
+  export const outboundSchema = ListResponseOutboundCampaign$outboundSchema;
+  /** @deprecated use `ListResponseOutboundCampaign$Outbound` instead. */
+  export type Outbound = ListResponseOutboundCampaign$Outbound;
+}
+
+export function listResponseOutboundCampaignToJSON(
+  listResponseOutboundCampaign: ListResponseOutboundCampaign,
+): string {
+  return JSON.stringify(
+    ListResponseOutboundCampaign$outboundSchema.parse(
+      listResponseOutboundCampaign,
+    ),
+  );
+}
+
+export function listResponseOutboundCampaignFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseOutboundCampaign, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseOutboundCampaign$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseOutboundCampaign' from JSON`,
+  );
+}

package/src/models/components/outboundcampaign.ts

@@ -7,6 +7,11 @@ 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 {
+  DaysOfWeek,
+  DaysOfWeek$inboundSchema,
+  DaysOfWeek$outboundSchema,
+} from "./daysofweek.js";
 
 /**
  * Variables for campaign
@@ -18,6 +23,14 @@ export type OutboundCampaign = {
    * Human readable name of campaign
    */
   campaignName: string;
+  /**
+   * Description of campaign
+   */
+  description?: string | null | undefined;
+  /**
+   * Label for campaign
+   */
+  label?: string | null | undefined;
   /**
    * Variables for campaign
    */
@@ -43,9 +56,9 @@ export type OutboundCampaign = {
    */
   callerId: string | null;
   /**
-   * Target number of outreach calls per minute
+   * Target number of outreach calls per hour
    */
-  rate?: number | undefined;
+  hourlyRate?: number | undefined;
   /**
    * Number of retries per target
    */
@@ -55,9 +68,9 @@ export type OutboundCampaign = {
    */
   retryInterval?: string | null | undefined;
   /**
-   * How many seconds to pause between queueing calls. Useful when rate should be less than 1 per minute
+   * Days of the week when campaign is active
    */
-  pauseSeconds?: number | null | undefined;
+  activeDays: Array<DaysOfWeek>;
   /**
    * Unique ID for campaign
    */
@@ -131,16 +144,18 @@ export const OutboundCampaign$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   campaign_name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
   campaign_variables: z.lazy(() => CampaignVariables$inboundSchema),
   daily_start_time: z.string(),
   daily_end_time: z.string(),
   timezone: z.string(),
   source: z.nullable(z.string()).optional(),
   caller_id: z.nullable(z.string()),
-  rate: z.number().int().default(1),
+  hourly_rate: z.number().int().default(1),
   retry_count: z.number().int().default(0),
   retry_interval: z.nullable(z.string()).optional(),
-  pause_seconds: z.nullable(z.number().int()).optional(),
+  active_days: z.array(DaysOfWeek$inboundSchema),
   id: z.number().int(),
   created_at: z.string().optional(),
   updated_at: z.string().optional(),
@@ -152,9 +167,10 @@ export const OutboundCampaign$inboundSchema: z.ZodType<
     "daily_start_time": "dailyStartTime",
     "daily_end_time": "dailyEndTime",
     "caller_id": "callerId",
+    "hourly_rate": "hourlyRate",
     "retry_count": "retryCount",
     "retry_interval": "retryInterval",
-    "pause_seconds": "pauseSeconds",
+    "active_days": "activeDays",
     "created_at": "createdAt",
     "updated_at": "updatedAt",
     "last_updated_by": "lastUpdatedBy",
@@ -164,16 +180,18 @@ export const OutboundCampaign$inboundSchema: z.ZodType<
 /** @internal */
 export type OutboundCampaign$Outbound = {
   campaign_name: string;
+  description?: string | null | undefined;
+  label?: string | null | undefined;
   campaign_variables: CampaignVariables$Outbound;
   daily_start_time: string;
   daily_end_time: string;
   timezone: string;
   source?: string | null | undefined;
   caller_id: string | null;
-  rate: number;
+  hourly_rate: number;
   retry_count: number;
   retry_interval?: string | null | undefined;
-  pause_seconds?: number | null | undefined;
+  active_days: Array<string>;
   id: number;
   created_at?: string | undefined;
   updated_at?: string | undefined;
@@ -187,16 +205,18 @@ export const OutboundCampaign$outboundSchema: z.ZodType<
   OutboundCampaign
 > = z.object({
   campaignName: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
   campaignVariables: z.lazy(() => CampaignVariables$outboundSchema),
   dailyStartTime: z.string(),
   dailyEndTime: z.string(),
   timezone: z.string(),
   source: z.nullable(z.string()).optional(),
   callerId: z.nullable(z.string()),
-  rate: z.number().int().default(1),
+  hourlyRate: z.number().int().default(1),
   retryCount: z.number().int().default(0),
   retryInterval: z.nullable(z.string()).optional(),
-  pauseSeconds: z.nullable(z.number().int()).optional(),
+  activeDays: z.array(DaysOfWeek$outboundSchema),
   id: z.number().int(),
   createdAt: z.string().optional(),
   updatedAt: z.string().optional(),
@@ -208,9 +228,10 @@ export const OutboundCampaign$outboundSchema: z.ZodType<
     dailyStartTime: "daily_start_time",
     dailyEndTime: "daily_end_time",
     callerId: "caller_id",
+    hourlyRate: "hourly_rate",
     retryCount: "retry_count",
     retryInterval: "retry_interval",
-    pauseSeconds: "pause_seconds",
+    activeDays: "active_days",
     createdAt: "created_at",
     updatedAt: "updated_at",
     lastUpdatedBy: "last_updated_by",