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

package/src/funcs/outboundCampaignsList.ts

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
 import { SyllableSDKCore } from "../core.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
@@ -34,7 +33,7 @@ export async function outboundCampaignsList(
   options?: RequestOptions,
 ): Promise<
   Result<
-    Array<components.OutboundCampaign>,
+    components.ListResponseOutboundCampaign,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -124,7 +123,7 @@ export async function outboundCampaignsList(
   };
 
   const [result] = await M.match<
-    Array<components.OutboundCampaign>,
+    components.ListResponseOutboundCampaign,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -134,7 +133,7 @@ export async function outboundCampaignsList(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, z.array(components.OutboundCampaign$inboundSchema)),
+    M.json(200, components.ListResponseOutboundCampaign$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/sessionsLatencyGetById.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Inspect Latency For Session
+ */
+export async function sessionsLatencyGetById(
+  client: SyllableSDKCore,
+  request: operations.SessionLatencyGetByIdRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.InspectLatencyResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SessionLatencyGetByIdRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    session_id: encodeSimple("session_id", payload.session_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v1/sessions/latency/{session_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? "",
+    operationID: "session_latency_get_by_id",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.InspectLatencyResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.InspectLatencyResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/{takeoutsCreateTakeoutApiV1TakeoutsCreatePost.ts → takeoutsCreate.ts}

@@ -23,7 +23,7 @@ import { Result } from "../types/fp.js";
 /**
  * Create Takeout
  */
-export async function takeoutsCreateTakeoutApiV1TakeoutsCreatePost(
+export async function takeoutsCreate(
   client: SyllableSDKCore,
   options?: RequestOptions,
 ): Promise<
@@ -50,7 +50,7 @@ export async function takeoutsCreateTakeoutApiV1TakeoutsCreatePost(
 
   const context = {
     baseURL: options?.serverURL ?? "",
-    operationID: "create_takeout_api_v1_takeouts_create_post",
+    operationID: "takeouts_create",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/funcs/{takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.ts → takeoutsTakeoutsGetByJobId.ts}

@@ -27,9 +27,9 @@ import { Result } from "../types/fp.js";
 /**
  * Get Takeout
  */
-export async function takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet(
+export async function takeoutsTakeoutsGetByJobId(
   client: SyllableSDKCore,
-  request: operations.GetTakeoutApiV1TakeoutsGetJobIdGetRequest,
+  request: operations.TakeoutsGetByJobIdRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
@@ -46,10 +46,7 @@ export async function takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.GetTakeoutApiV1TakeoutsGetJobIdGetRequest$outboundSchema.parse(
-        value,
-      ),
+    (value) => operations.TakeoutsGetByJobIdRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -77,7 +74,7 @@ export async function takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet(
 
   const context = {
     baseURL: options?.serverURL ?? "",
-    operationID: "get_takeout_api_v1_takeouts_get__job_id__get",
+    operationID: "takeouts_get_by_job_id",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.2",
-  sdkVersion: "0.1.0-alpha.73",
+  sdkVersion: "0.1.0-alpha.75",
   genVersion: "2.512.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.73 2.512.4 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.75 2.512.4 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/batchdetails.ts

@@ -33,9 +33,9 @@ export type BatchDetails = {
    */
   status?: BatchStatus | undefined;
   /**
-   * Number of requests in batch
+   * Name of file used to create batch
    */
-  count?: number | null | undefined;
+  uploadFilename?: string | null | undefined;
   /**
    * Timestamp of batch creation
    */
@@ -56,6 +56,10 @@ export type BatchDetails = {
    * Email of user who last updated campaign
    */
   lastUpdatedBy: string;
+  /**
+   * Error message if batch upload failed
+   */
+  errorMessage?: string | null | undefined;
   /**
    * Counts of requests by status
    */
@@ -116,12 +120,13 @@ export const BatchDetails$inboundSchema: z.ZodType<
   campaign_id: z.number().int(),
   expires_on: z.nullable(z.string()).optional(),
   status: BatchStatus$inboundSchema.optional(),
-  count: z.nullable(z.number().int()).optional(),
+  upload_filename: z.nullable(z.string()).optional(),
   created_at: z.string().optional(),
   deleted_at: z.nullable(z.string()).optional(),
   deleted_reason: z.nullable(z.string()).optional(),
   last_worked_on: z.nullable(z.string()).optional(),
   last_updated_by: z.string(),
+  error_message: z.nullable(z.string()).optional(),
   status_counts: z.nullable(z.lazy(() => StatusCounts$inboundSchema))
     .optional(),
 }).transform((v) => {
@@ -129,11 +134,13 @@ export const BatchDetails$inboundSchema: z.ZodType<
     "batch_id": "batchId",
     "campaign_id": "campaignId",
     "expires_on": "expiresOn",
+    "upload_filename": "uploadFilename",
     "created_at": "createdAt",
     "deleted_at": "deletedAt",
     "deleted_reason": "deletedReason",
     "last_worked_on": "lastWorkedOn",
     "last_updated_by": "lastUpdatedBy",
+    "error_message": "errorMessage",
     "status_counts": "statusCounts",
   });
 });
@@ -144,12 +151,13 @@ export type BatchDetails$Outbound = {
   campaign_id: number;
   expires_on?: string | null | undefined;
   status?: string | undefined;
-  count?: number | null | undefined;
+  upload_filename?: string | null | undefined;
   created_at?: string | undefined;
   deleted_at?: string | null | undefined;
   deleted_reason?: string | null | undefined;
   last_worked_on?: string | null | undefined;
   last_updated_by: string;
+  error_message?: string | null | undefined;
   status_counts?: StatusCounts$Outbound | null | undefined;
 };
 
@@ -163,12 +171,13 @@ export const BatchDetails$outboundSchema: z.ZodType<
   campaignId: z.number().int(),
   expiresOn: z.nullable(z.string()).optional(),
   status: BatchStatus$outboundSchema.optional(),
-  count: z.nullable(z.number().int()).optional(),
+  uploadFilename: z.nullable(z.string()).optional(),
   createdAt: z.string().optional(),
   deletedAt: z.nullable(z.string()).optional(),
   deletedReason: z.nullable(z.string()).optional(),
   lastWorkedOn: z.nullable(z.string()).optional(),
   lastUpdatedBy: z.string(),
+  errorMessage: z.nullable(z.string()).optional(),
   statusCounts: z.nullable(z.lazy(() => StatusCounts$outboundSchema))
     .optional(),
 }).transform((v) => {
@@ -176,11 +185,13 @@ export const BatchDetails$outboundSchema: z.ZodType<
     batchId: "batch_id",
     campaignId: "campaign_id",
     expiresOn: "expires_on",
+    uploadFilename: "upload_filename",
     createdAt: "created_at",
     deletedAt: "deleted_at",
     deletedReason: "deleted_reason",
     lastWorkedOn: "last_worked_on",
     lastUpdatedBy: "last_updated_by",
+    errorMessage: "error_message",
     statusCounts: "status_counts",
   });
 });

package/src/models/components/batchstatus.ts

@@ -12,7 +12,7 @@ export const BatchStatus = {
   Pending: "PENDING",
   Active: "ACTIVE",
   Paused: "PAUSED",
-  Idle: "IDLE",
+  Failed: "FAILED",
   Canceled: "CANCELED",
   Expired: "EXPIRED",
 } as const;

package/src/models/components/bodyoutboundbatchdelete.ts

@@ -3,6 +3,7 @@
  */
 
 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";
@@ -17,12 +18,16 @@ export const BodyOutboundBatchDelete$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  deleteReason: z.string(),
+  delete_reason: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "delete_reason": "deleteReason",
+  });
 });
 
 /** @internal */
 export type BodyOutboundBatchDelete$Outbound = {
-  deleteReason: string;
+  delete_reason: string;
 };
 
 /** @internal */
@@ -32,6 +37,10 @@ export const BodyOutboundBatchDelete$outboundSchema: z.ZodType<
   BodyOutboundBatchDelete
 > = z.object({
   deleteReason: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    deleteReason: "delete_reason",
+  });
 });
 
 /**

package/src/models/components/bodyoutboundbatchupload.ts

@@ -14,7 +14,7 @@ export type FileT = {
 };
 
 export type BodyOutboundBatchUpload = {
-  file: FileT | Blob;
+  file?: FileT | Blob | undefined;
 };
 
 /** @internal */
@@ -83,12 +83,12 @@ export const BodyOutboundBatchUpload$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  file: z.lazy(() => FileT$inboundSchema),
+  file: z.lazy(() => FileT$inboundSchema).optional(),
 });
 
 /** @internal */
 export type BodyOutboundBatchUpload$Outbound = {
-  file: FileT$Outbound | Blob;
+  file?: FileT$Outbound | Blob | undefined;
 };
 
 /** @internal */
@@ -97,7 +97,7 @@ export const BodyOutboundBatchUpload$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BodyOutboundBatchUpload
 > = z.object({
-  file: z.lazy(() => FileT$outboundSchema).or(blobLikeSchema),
+  file: z.lazy(() => FileT$outboundSchema).or(blobLikeSchema).optional(),
 });
 
 /**

package/src/models/components/communicationbatch.ts

@@ -31,9 +31,9 @@ export type CommunicationBatch = {
    */
   status?: BatchStatus | undefined;
   /**
-   * Number of requests in batch
+   * Name of file used to create batch
    */
-  count?: number | null | undefined;
+  uploadFilename?: string | null | undefined;
   /**
    * Timestamp of batch creation
    */
@@ -54,6 +54,10 @@ export type CommunicationBatch = {
    * Email of user who last updated campaign
    */
   lastUpdatedBy: string;
+  /**
+   * Error message if batch upload failed
+   */
+  errorMessage?: string | null | undefined;
 };
 
 /** @internal */
@@ -66,22 +70,25 @@ export const CommunicationBatch$inboundSchema: z.ZodType<
   campaign_id: z.number().int(),
   expires_on: z.nullable(z.string()).optional(),
   status: BatchStatus$inboundSchema.optional(),
-  count: z.nullable(z.number().int()).optional(),
+  upload_filename: z.nullable(z.string()).optional(),
   created_at: z.string().optional(),
   deleted_at: z.nullable(z.string()).optional(),
   deleted_reason: z.nullable(z.string()).optional(),
   last_worked_on: z.nullable(z.string()).optional(),
   last_updated_by: z.string(),
+  error_message: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "batch_id": "batchId",
     "campaign_id": "campaignId",
     "expires_on": "expiresOn",
+    "upload_filename": "uploadFilename",
     "created_at": "createdAt",
     "deleted_at": "deletedAt",
     "deleted_reason": "deletedReason",
     "last_worked_on": "lastWorkedOn",
     "last_updated_by": "lastUpdatedBy",
+    "error_message": "errorMessage",
   });
 });
 
@@ -91,12 +98,13 @@ export type CommunicationBatch$Outbound = {
   campaign_id: number;
   expires_on?: string | null | undefined;
   status?: string | undefined;
-  count?: number | null | undefined;
+  upload_filename?: string | null | undefined;
   created_at?: string | undefined;
   deleted_at?: string | null | undefined;
   deleted_reason?: string | null | undefined;
   last_worked_on?: string | null | undefined;
   last_updated_by: string;
+  error_message?: string | null | undefined;
 };
 
 /** @internal */
@@ -109,22 +117,25 @@ export const CommunicationBatch$outboundSchema: z.ZodType<
   campaignId: z.number().int(),
   expiresOn: z.nullable(z.string()).optional(),
   status: BatchStatus$outboundSchema.optional(),
-  count: z.nullable(z.number().int()).optional(),
+  uploadFilename: z.nullable(z.string()).optional(),
   createdAt: z.string().optional(),
   deletedAt: z.nullable(z.string()).optional(),
   deletedReason: z.nullable(z.string()).optional(),
   lastWorkedOn: z.nullable(z.string()).optional(),
   lastUpdatedBy: z.string(),
+  errorMessage: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     batchId: "batch_id",
     campaignId: "campaign_id",
     expiresOn: "expires_on",
+    uploadFilename: "upload_filename",
     createdAt: "created_at",
     deletedAt: "deleted_at",
     deletedReason: "deleted_reason",
     lastWorkedOn: "last_worked_on",
     lastUpdatedBy: "last_updated_by",
+    errorMessage: "error_message",
   });
 });
 

package/src/models/components/communicationbatchupdate.ts

@@ -0,0 +1,85 @@
+/*
+ * 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";
+
+export type CommunicationBatchUpdate = {
+  /**
+   * Whether the batch is on HOLD. When on HOLD, no outreach will be made.
+   */
+  paused?: boolean | null | undefined;
+  /**
+   * Timestamp of batch expiration
+   */
+  expiresOn?: string | null | undefined;
+};
+
+/** @internal */
+export const CommunicationBatchUpdate$inboundSchema: z.ZodType<
+  CommunicationBatchUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paused: z.nullable(z.boolean()).optional(),
+  expires_on: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "expires_on": "expiresOn",
+  });
+});
+
+/** @internal */
+export type CommunicationBatchUpdate$Outbound = {
+  paused?: boolean | null | undefined;
+  expires_on?: string | null | undefined;
+};
+
+/** @internal */
+export const CommunicationBatchUpdate$outboundSchema: z.ZodType<
+  CommunicationBatchUpdate$Outbound,
+  z.ZodTypeDef,
+  CommunicationBatchUpdate
+> = z.object({
+  paused: z.nullable(z.boolean()).optional(),
+  expiresOn: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    expiresOn: "expires_on",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommunicationBatchUpdate$ {
+  /** @deprecated use `CommunicationBatchUpdate$inboundSchema` instead. */
+  export const inboundSchema = CommunicationBatchUpdate$inboundSchema;
+  /** @deprecated use `CommunicationBatchUpdate$outboundSchema` instead. */
+  export const outboundSchema = CommunicationBatchUpdate$outboundSchema;
+  /** @deprecated use `CommunicationBatchUpdate$Outbound` instead. */
+  export type Outbound = CommunicationBatchUpdate$Outbound;
+}
+
+export function communicationBatchUpdateToJSON(
+  communicationBatchUpdate: CommunicationBatchUpdate,
+): string {
+  return JSON.stringify(
+    CommunicationBatchUpdate$outboundSchema.parse(communicationBatchUpdate),
+  );
+}
+
+export function communicationBatchUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<CommunicationBatchUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommunicationBatchUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommunicationBatchUpdate' from JSON`,
+  );
+}

package/src/models/components/communicationrequest.ts

@@ -7,11 +7,6 @@ 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 {
-  RequestStatus,
-  RequestStatus$inboundSchema,
-  RequestStatus$outboundSchema,
-} from "./requeststatus.js";
 
 /**
  * Variables for request
@@ -19,10 +14,6 @@ import {
 export type CommunicationRequestRequestVariables = {};
 
 export type CommunicationRequest = {
-  /**
-   * Unique ID for conversation batch
-   */
-  batchId: string;
   /**
    * ID for target outreach (unique within batch)
    */
@@ -31,10 +22,6 @@ export type CommunicationRequest = {
    * Target phone number or email address
    */
   target: string;
-  /**
-   * Status of a communication request.
-   */
-  requestStatus?: RequestStatus | undefined;
   /**
    * Variables for request
    */
@@ -100,28 +87,22 @@ export const CommunicationRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  batch_id: z.string(),
   reference_id: z.string(),
   target: z.string(),
-  request_status: RequestStatus$inboundSchema.optional(),
   request_variables: z.lazy(() =>
     CommunicationRequestRequestVariables$inboundSchema
   ),
 }).transform((v) => {
   return remap$(v, {
-    "batch_id": "batchId",
     "reference_id": "referenceId",
-    "request_status": "requestStatus",
     "request_variables": "requestVariables",
   });
 });
 
 /** @internal */
 export type CommunicationRequest$Outbound = {
-  batch_id: string;
   reference_id: string;
   target: string;
-  request_status?: string | undefined;
   request_variables: CommunicationRequestRequestVariables$Outbound;
 };
 
@@ -131,18 +112,14 @@ export const CommunicationRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CommunicationRequest
 > = z.object({
-  batchId: z.string(),
   referenceId: z.string(),
   target: z.string(),
-  requestStatus: RequestStatus$outboundSchema.optional(),
   requestVariables: z.lazy(() =>
     CommunicationRequestRequestVariables$outboundSchema
   ),
 }).transform((v) => {
   return remap$(v, {
-    batchId: "batch_id",
     referenceId: "reference_id",
-    requestStatus: "request_status",
     requestVariables: "request_variables",
   });
 });