@unified-api/typescript-sdk 2.86.0 → 2.86.2

package/src/sdk/models/shared/uccallinstruction.ts

@@ -0,0 +1,152 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertyUcCallInstructionTelephone,
+  PropertyUcCallInstructionTelephone$inboundSchema,
+  PropertyUcCallInstructionTelephone$Outbound,
+  PropertyUcCallInstructionTelephone$outboundSchema,
+} from "./propertyuccallinstructiontelephone.js";
+
+export const UcCallInstructionType = {
+  Say: "SAY",
+  Play: "PLAY",
+  Pause: "PAUSE",
+  Dial: "DIAL",
+  Hangup: "HANGUP",
+} as const;
+export type UcCallInstructionType = OpenEnum<typeof UcCallInstructionType>;
+
+export type UcCallInstruction = {
+  /**
+   * PLAY: public MP3 or WAV URL
+   */
+  audioUrl?: string | undefined;
+  /**
+   * SAY: BCP 47 language code (e.g. en-US), passed to the integration as-is
+   */
+  language?: string | undefined;
+  /**
+   * PAUSE: length of silence
+   */
+  seconds?: number | undefined;
+  /**
+   * DIAL: SIP address to dial instead of telephone
+   */
+  sipUri?: string | undefined;
+  /**
+   * DIAL: number to dial and bridge
+   */
+  telephone?: PropertyUcCallInstructionTelephone | undefined;
+  /**
+   * SAY: text to speak
+   */
+  text?: string | undefined;
+  /**
+   * DIAL: how long to ring before giving up
+   */
+  timeoutSeconds?: number | undefined;
+  type: UcCallInstructionType;
+  /**
+   * DIAL: caller ID on the dialed leg (defaults to the call's user_phone)
+   */
+  userPhone?: string | undefined;
+};
+
+/** @internal */
+export const UcCallInstructionType$inboundSchema: z.ZodType<
+  UcCallInstructionType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(UcCallInstructionType);
+/** @internal */
+export const UcCallInstructionType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  UcCallInstructionType
+> = openEnums.outboundSchema(UcCallInstructionType);
+
+/** @internal */
+export const UcCallInstruction$inboundSchema: z.ZodType<
+  UcCallInstruction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  audio_url: z.string().optional(),
+  language: z.string().optional(),
+  seconds: z.number().optional(),
+  sip_uri: z.string().optional(),
+  telephone: PropertyUcCallInstructionTelephone$inboundSchema.optional(),
+  text: z.string().optional(),
+  timeout_seconds: z.number().optional(),
+  type: UcCallInstructionType$inboundSchema,
+  user_phone: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "audio_url": "audioUrl",
+    "sip_uri": "sipUri",
+    "timeout_seconds": "timeoutSeconds",
+    "user_phone": "userPhone",
+  });
+});
+/** @internal */
+export type UcCallInstruction$Outbound = {
+  audio_url?: string | undefined;
+  language?: string | undefined;
+  seconds?: number | undefined;
+  sip_uri?: string | undefined;
+  telephone?: PropertyUcCallInstructionTelephone$Outbound | undefined;
+  text?: string | undefined;
+  timeout_seconds?: number | undefined;
+  type: string;
+  user_phone?: string | undefined;
+};
+
+/** @internal */
+export const UcCallInstruction$outboundSchema: z.ZodType<
+  UcCallInstruction$Outbound,
+  z.ZodTypeDef,
+  UcCallInstruction
+> = z.object({
+  audioUrl: z.string().optional(),
+  language: z.string().optional(),
+  seconds: z.number().optional(),
+  sipUri: z.string().optional(),
+  telephone: PropertyUcCallInstructionTelephone$outboundSchema.optional(),
+  text: z.string().optional(),
+  timeoutSeconds: z.number().optional(),
+  type: UcCallInstructionType$outboundSchema,
+  userPhone: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    audioUrl: "audio_url",
+    sipUri: "sip_uri",
+    timeoutSeconds: "timeout_seconds",
+    userPhone: "user_phone",
+  });
+});
+
+export function ucCallInstructionToJSON(
+  ucCallInstruction: UcCallInstruction,
+): string {
+  return JSON.stringify(
+    UcCallInstruction$outboundSchema.parse(ucCallInstruction),
+  );
+}
+export function ucCallInstructionFromJSON(
+  jsonString: string,
+): SafeParseResult<UcCallInstruction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UcCallInstruction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UcCallInstruction' from JSON`,
+  );
+}

package/src/sdk/uc.ts

@@ -22,16 +22,36 @@ import { recordingRemoveUcRecording } from "../funcs/recordingRemoveUcRecording.
 import { recordingUpdateUcRecording } from "../funcs/recordingUpdateUcRecording.js";
 import { scorecardGetUcScorecard } from "../funcs/scorecardGetUcScorecard.js";
 import { scorecardListUcScorecards } from "../funcs/scorecardListUcScorecards.js";
+import { ucCreateUcCall } from "../funcs/ucCreateUcCall.js";
 import { ucGetUcCall } from "../funcs/ucGetUcCall.js";
 import { ucGetUcScorecardtemplate } from "../funcs/ucGetUcScorecardtemplate.js";
 import { ucListUcCalls } from "../funcs/ucListUcCalls.js";
 import { ucListUcScorecardtemplates } from "../funcs/ucListUcScorecardtemplates.js";
+import { ucPatchUcCall } from "../funcs/ucPatchUcCall.js";
+import { ucUpdateUcCall } from "../funcs/ucUpdateUcCall.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Uc extends ClientSDK {
+  /**
+   * Create a call
+   *
+   * @remarks
+   * Creates a UcCall. Provide the unified UcCall fields in the request body; they are mapped to the provider's API. Returns the created UcCall.
+   */
+  async createUcCall(
+    request: operations.CreateUcCallRequest,
+    options?: RequestOptions,
+  ): Promise<shared.UcCall> {
+    return unwrapAsync(ucCreateUcCall(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create a comment
    *
@@ -287,6 +307,23 @@ export class Uc extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a call
+   *
+   * @remarks
+   * Updates the UcCall identified by `id`. Provide the unified UcCall fields to change in the request body.
+   */
+  async patchUcCall(
+    request: operations.PatchUcCallRequest,
+    options?: RequestOptions,
+  ): Promise<shared.UcCall> {
+    return unwrapAsync(ucPatchUcCall(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a comment
    *
@@ -389,6 +426,23 @@ export class Uc extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a call
+   *
+   * @remarks
+   * Updates the UcCall identified by `id`. Provide the unified UcCall fields to change in the request body.
+   */
+  async updateUcCall(
+    request: operations.UpdateUcCallRequest,
+    options?: RequestOptions,
+  ): Promise<shared.UcCall> {
+    return unwrapAsync(ucUpdateUcCall(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a comment
    *