pingram 1.0.39-alpha.1679 → 1.0.39-alpha.1681

package/dist/generated/src/apis/VoiceApi.d.ts

@@ -10,41 +10,29 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BindNumberRequest, BindNumberResponse, CreateVoiceAgentRequest, CreateVoiceAgentResponse, DeleteVoiceAgentResponse, GetVoiceAgentResponse, GetVoiceCallResponse, ListVoiceAgentsResponse, ListVoiceCallsResponse, UnbindNumberResponse, UpdateVoiceAgentRequest, UpdateVoiceAgentResponse, VoiceBrowserCallRequest, VoiceBrowserCallResponse, VoiceCallRequest, VoiceCallResponse } from '../models/index';
-export interface BindNumberOperationRequest {
-    agentId: string;
-    bindNumberRequest: BindNumberRequest;
+import type { ArmVoiceInboundClaimRequest, ArmVoiceInboundClaimResponse, GetVoiceCallResponse, InboundConfig, ListVoiceCallsResponse, MessageResponse, VoiceBrowserCallRequest, VoiceBrowserCallResponse, VoiceCallRequest, VoiceCallResponse } from '../models/index';
+export interface ArmInboundClaimRequest {
+    armVoiceInboundClaimRequest: ArmVoiceInboundClaimRequest;
 }
 export interface CallRequest {
     voiceCallRequest: VoiceCallRequest;
 }
-export interface CreateAgentRequest {
-    createVoiceAgentRequest: CreateVoiceAgentRequest;
+export interface ClearNumberInboundRequest {
+    phoneNumber: string;
 }
 export interface CreateBrowserCallRequest {
     voiceBrowserCallRequest: VoiceBrowserCallRequest;
 }
-export interface DeleteAgentRequest {
-    agentId: string;
-}
-export interface GetAgentRequest {
-    agentId: string;
-}
 export interface GetCallRequest {
     trackingId: string;
 }
 export interface ListCallsRequest {
-    agentId?: string;
     limit?: number;
     cursor?: string;
 }
-export interface UnbindNumberRequest {
-    agentId: string;
+export interface PutNumberInboundRequest {
     phoneNumber: string;
-}
-export interface UpdateAgentRequest {
-    agentId: string;
-    updateVoiceAgentRequest: UpdateVoiceAgentRequest;
+    inboundConfig: InboundConfig;
 }
 /**
  * VoiceApi - interface
@@ -55,21 +43,20 @@ export interface UpdateAgentRequest {
 export interface VoiceApiInterface {
     /**
      *
-     * @summary Bind a phone number to a deployed agent for inbound routing
-     * @param {string} agentId Agent id
-     * @param {BindNumberRequest} bindNumberRequest
+     * @summary Arm the shared test number so the next call from this user\'s phone uses this inbound behavior
+     * @param {ArmVoiceInboundClaimRequest} armVoiceInboundClaimRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VoiceApiInterface
      */
-    bindNumberRaw(requestParameters: BindNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BindNumberResponse>>;
+    armInboundClaimRaw(requestParameters: ArmInboundClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ArmVoiceInboundClaimResponse>>;
     /**
-     * Bind a phone number to a deployed agent for inbound routing
+     * Arm the shared test number so the next call from this user\'s phone uses this inbound behavior
      */
-    bindNumber(agentId: string, bindNumberRequest: BindNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BindNumberResponse>;
+    armInboundClaim(armVoiceInboundClaimRequest: ArmVoiceInboundClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ArmVoiceInboundClaimResponse>;
     /**
      *
-     * @summary Place an outbound call with an inline agent spec (ephemeral)
+     * @summary Place an outbound call. The config is not saved.
      * @param {VoiceCallRequest} voiceCallRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -77,25 +64,25 @@ export interface VoiceApiInterface {
      */
     callRaw(requestParameters: CallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VoiceCallResponse>>;
     /**
-     * Place an outbound call with an inline agent spec (ephemeral)
+     * Place an outbound call. The config is not saved.
      */
     call(voiceCallRequest: VoiceCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VoiceCallResponse>;
     /**
      *
-     * @summary Deploy a voice agent (persist spec for production routing)
-     * @param {CreateVoiceAgentRequest} createVoiceAgentRequest
+     * @summary Remove inbound call behavior from a number this account owns
+     * @param {string} phoneNumber E.164 phone number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VoiceApiInterface
      */
-    createAgentRaw(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateVoiceAgentResponse>>;
+    clearNumberInboundRaw(requestParameters: ClearNumberInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
-     * Deploy a voice agent (persist spec for production routing)
+     * Remove inbound call behavior from a number this account owns
      */
-    createAgent(createVoiceAgentRequest: CreateVoiceAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVoiceAgentResponse>;
+    clearNumberInbound(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
      *
-     * @summary Place an ephemeral browser playground call with an inline agent spec
+     * @summary Place a browser playground call. Script calls use POST /voice/call.
      * @param {VoiceBrowserCallRequest} voiceBrowserCallRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -103,35 +90,9 @@ export interface VoiceApiInterface {
      */
     createBrowserCallRaw(requestParameters: CreateBrowserCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VoiceBrowserCallResponse>>;
     /**
-     * Place an ephemeral browser playground call with an inline agent spec
+     * Place a browser playground call. Script calls use POST /voice/call.
      */
     createBrowserCall(voiceBrowserCallRequest: VoiceBrowserCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VoiceBrowserCallResponse>;
-    /**
-     *
-     * @summary Remove a deployed voice agent and unbind its numbers
-     * @param {string} agentId Agent id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof VoiceApiInterface
-     */
-    deleteAgentRaw(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteVoiceAgentResponse>>;
-    /**
-     * Remove a deployed voice agent and unbind its numbers
-     */
-    deleteAgent(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteVoiceAgentResponse>;
-    /**
-     *
-     * @summary Get a deployed voice agent
-     * @param {string} agentId Agent id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof VoiceApiInterface
-     */
-    getAgentRaw(requestParameters: GetAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetVoiceAgentResponse>>;
-    /**
-     * Get a deployed voice agent
-     */
-    getAgent(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVoiceAgentResponse>;
     /**
      *
      * @summary Get a call with transcript timeline and recording playback URL
@@ -145,22 +106,9 @@ export interface VoiceApiInterface {
      * Get a call with transcript timeline and recording playback URL
      */
     getCall(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVoiceCallResponse>;
-    /**
-     *
-     * @summary List deployed voice agents for the account
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof VoiceApiInterface
-     */
-    listAgentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVoiceAgentsResponse>>;
-    /**
-     * List deployed voice agents for the account
-     */
-    listAgents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceAgentsResponse>;
     /**
      *
      * @summary List recent calls newest-first (30-day retention)
-     * @param {string} [agentId] Only calls handled by this agent
      * @param {number} [limit] Page size (default 25, max 100)
      * @param {string} [cursor] Pagination cursor from a previous response
      * @param {*} [options] Override http request option.
@@ -171,88 +119,58 @@ export interface VoiceApiInterface {
     /**
      * List recent calls newest-first (30-day retention)
      */
-    listCalls(agentId?: string, limit?: number, cursor?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceCallsResponse>;
+    listCalls(limit?: number, cursor?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceCallsResponse>;
     /**
      *
-     * @summary Unbind a phone number from a deployed agent
-     * @param {string} agentId Agent id
+     * @summary Store inbound call behavior on a number this account owns
      * @param {string} phoneNumber E.164 phone number
+     * @param {InboundConfig} inboundConfig
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VoiceApiInterface
      */
-    unbindNumberRaw(requestParameters: UnbindNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnbindNumberResponse>>;
+    putNumberInboundRaw(requestParameters: PutNumberInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
-     * Unbind a phone number from a deployed agent
+     * Store inbound call behavior on a number this account owns
      */
-    unbindNumber(agentId: string, phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnbindNumberResponse>;
-    /**
-     *
-     * @summary Publish changes to a deployed voice agent
-     * @param {string} agentId Agent id
-     * @param {UpdateVoiceAgentRequest} updateVoiceAgentRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof VoiceApiInterface
-     */
-    updateAgentRaw(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateVoiceAgentResponse>>;
-    /**
-     * Publish changes to a deployed voice agent
-     */
-    updateAgent(agentId: string, updateVoiceAgentRequest: UpdateVoiceAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateVoiceAgentResponse>;
+    putNumberInbound(phoneNumber: string, inboundConfig: InboundConfig, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
 }
 /**
  *
  */
 export declare class VoiceApi extends runtime.BaseAPI implements VoiceApiInterface {
     /**
-     * Bind a phone number to a deployed agent for inbound routing
+     * Arm the shared test number so the next call from this user\'s phone uses this inbound behavior
      */
-    bindNumberRaw(requestParameters: BindNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BindNumberResponse>>;
+    armInboundClaimRaw(requestParameters: ArmInboundClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ArmVoiceInboundClaimResponse>>;
     /**
-     * Bind a phone number to a deployed agent for inbound routing
+     * Arm the shared test number so the next call from this user\'s phone uses this inbound behavior
      */
-    bindNumber(agentId: string, bindNumberRequest: BindNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BindNumberResponse>;
+    armInboundClaim(armVoiceInboundClaimRequest: ArmVoiceInboundClaimRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ArmVoiceInboundClaimResponse>;
     /**
-     * Place an outbound call with an inline agent spec (ephemeral)
+     * Place an outbound call. The config is not saved.
      */
     callRaw(requestParameters: CallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VoiceCallResponse>>;
     /**
-     * Place an outbound call with an inline agent spec (ephemeral)
+     * Place an outbound call. The config is not saved.
      */
     call(voiceCallRequest: VoiceCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VoiceCallResponse>;
     /**
-     * Deploy a voice agent (persist spec for production routing)
+     * Remove inbound call behavior from a number this account owns
      */
-    createAgentRaw(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateVoiceAgentResponse>>;
+    clearNumberInboundRaw(requestParameters: ClearNumberInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
-     * Deploy a voice agent (persist spec for production routing)
+     * Remove inbound call behavior from a number this account owns
      */
-    createAgent(createVoiceAgentRequest: CreateVoiceAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVoiceAgentResponse>;
+    clearNumberInbound(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
-     * Place an ephemeral browser playground call with an inline agent spec
+     * Place a browser playground call. Script calls use POST /voice/call.
      */
     createBrowserCallRaw(requestParameters: CreateBrowserCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VoiceBrowserCallResponse>>;
     /**
-     * Place an ephemeral browser playground call with an inline agent spec
+     * Place a browser playground call. Script calls use POST /voice/call.
      */
     createBrowserCall(voiceBrowserCallRequest: VoiceBrowserCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VoiceBrowserCallResponse>;
-    /**
-     * Remove a deployed voice agent and unbind its numbers
-     */
-    deleteAgentRaw(requestParameters: DeleteAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteVoiceAgentResponse>>;
-    /**
-     * Remove a deployed voice agent and unbind its numbers
-     */
-    deleteAgent(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteVoiceAgentResponse>;
-    /**
-     * Get a deployed voice agent
-     */
-    getAgentRaw(requestParameters: GetAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetVoiceAgentResponse>>;
-    /**
-     * Get a deployed voice agent
-     */
-    getAgent(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVoiceAgentResponse>;
     /**
      * Get a call with transcript timeline and recording playback URL
      */
@@ -261,14 +179,6 @@ export declare class VoiceApi extends runtime.BaseAPI implements VoiceApiInterfa
      * Get a call with transcript timeline and recording playback URL
      */
     getCall(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVoiceCallResponse>;
-    /**
-     * List deployed voice agents for the account
-     */
-    listAgentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListVoiceAgentsResponse>>;
-    /**
-     * List deployed voice agents for the account
-     */
-    listAgents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceAgentsResponse>;
     /**
      * List recent calls newest-first (30-day retention)
      */
@@ -276,21 +186,13 @@ export declare class VoiceApi extends runtime.BaseAPI implements VoiceApiInterfa
     /**
      * List recent calls newest-first (30-day retention)
      */
-    listCalls(agentId?: string, limit?: number, cursor?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceCallsResponse>;
-    /**
-     * Unbind a phone number from a deployed agent
-     */
-    unbindNumberRaw(requestParameters: UnbindNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnbindNumberResponse>>;
-    /**
-     * Unbind a phone number from a deployed agent
-     */
-    unbindNumber(agentId: string, phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnbindNumberResponse>;
+    listCalls(limit?: number, cursor?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListVoiceCallsResponse>;
     /**
-     * Publish changes to a deployed voice agent
+     * Store inbound call behavior on a number this account owns
      */
-    updateAgentRaw(requestParameters: UpdateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateVoiceAgentResponse>>;
+    putNumberInboundRaw(requestParameters: PutNumberInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
-     * Publish changes to a deployed voice agent
+     * Store inbound call behavior on a number this account owns
      */
-    updateAgent(agentId: string, updateVoiceAgentRequest: UpdateVoiceAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateVoiceAgentResponse>;
+    putNumberInbound(phoneNumber: string, inboundConfig: InboundConfig, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
 }