@augstash/sdk 0.2.0

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

@@ -0,0 +1,372 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateWaIvrMenuRequest, IvrAgentLegResponse, JoinIvrCallRequest, PageWaIvrCallbackResponse, ResolveIvrCallbackRequest, UpdateWaIvrMenuRequest, WaIvrCallbackResponse, WaIvrMenuResponse, WaIvrSessionResponse } from '../models/index';
+export interface ActivateWhatsappRequest {
+    menuId: string;
+    xIdempotencyKey?: string;
+}
+export interface AgentLegRequest {
+    sessionId: string;
+    joinIvrCallRequest: JoinIvrCallRequest;
+    xIdempotencyKey?: string;
+}
+export interface CallbacksRequest {
+    pendingOnly?: boolean;
+    page?: number;
+    size?: number;
+}
+export interface CreateWhatsappIvrRequest {
+    createWaIvrMenuRequest: CreateWaIvrMenuRequest;
+    xIdempotencyKey?: string;
+}
+export interface DeactivateWhatsappRequest {
+    menuId: string;
+    xIdempotencyKey?: string;
+}
+export interface DeleteWhatsappIvrRequest {
+    menuId: string;
+    xIdempotencyKey?: string;
+}
+export interface GetWhatsappIvrRequest {
+    menuId: string;
+}
+export interface RenderRequest {
+    menuId: string;
+    xIdempotencyKey?: string;
+}
+export interface ResolveCallbackRequest {
+    callbackId: string;
+    resolveIvrCallbackRequest: ResolveIvrCallbackRequest;
+    xIdempotencyKey?: string;
+}
+export interface SessionRequest {
+    sessionId: string;
+}
+export interface UpdateWhatsappIvrRequest {
+    menuId: string;
+    updateWaIvrMenuRequest: UpdateWaIvrMenuRequest;
+    xIdempotencyKey?: string;
+}
+/**
+ * WhatsAppIvrApi - interface
+ *
+ * @export
+ * @interface WhatsAppIvrApiInterface
+ */
+export interface WhatsAppIvrApiInterface {
+    /**
+     * Renders any stale prompts to audio and flips the menu ACTIVE, in one action — a tenant should not have to know that prompts are synthesised. Refused when another menu already answers that number: deactivate it first. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Make this menu answer its number
+     * @param {string} menuId
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    activateWhatsappRaw(requestParameters: ActivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Renders any stale prompts to audio and flips the menu ACTIVE, in one action — a tenant should not have to know that prompts are synthesised. Refused when another menu already answers that number: deactivate it first. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Make this menu answer its number
+     */
+    activateWhatsapp(requestParameters: ActivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * The agent\'s half of a menu call. **Post an OFFER here, not an answer** — the opposite of `POST /calls/{id}/accept`, and the difference is that a menu call was already answered by the media server, so Meta\'s offer is spent and the far end is now our own media server rather than Meta. Build a peer connection with a microphone track, create an offer, **wait for ICE gathering to complete** (there is no channel to trickle a late candidate on), and post it; feed the `sdpAnswer` that comes back to setRemoteDescription and the agent is on the call.  Sent when a `CALL_IVR_ROUTED` frame arrives. A frame naming this agent is theirs to take; one naming nobody is going spare and the first to post wins. Writes < 800ms — it crosses to the media server and back while a customer waits. Requires API-key scope: wacalling:write.
+     * @summary Take a call the menu answered
+     * @param {string} sessionId
+     * @param {JoinIvrCallRequest} joinIvrCallRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    agentLegRaw(requestParameters: AgentLegRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IvrAgentLegResponse>>;
+    /**
+     * The agent\'s half of a menu call. **Post an OFFER here, not an answer** — the opposite of `POST /calls/{id}/accept`, and the difference is that a menu call was already answered by the media server, so Meta\'s offer is spent and the far end is now our own media server rather than Meta. Build a peer connection with a microphone track, create an offer, **wait for ICE gathering to complete** (there is no channel to trickle a late candidate on), and post it; feed the `sdpAnswer` that comes back to setRemoteDescription and the agent is on the call.  Sent when a `CALL_IVR_ROUTED` frame arrives. A frame naming this agent is theirs to take; one naming nobody is going spare and the first to post wins. Writes < 800ms — it crosses to the media server and back while a customer waits. Requires API-key scope: wacalling:write.
+     * Take a call the menu answered
+     */
+    agentLeg(requestParameters: AgentLegRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IvrAgentLegResponse>;
+    /**
+     * Callers who gave up waiting for an agent and asked to be called back instead. Default is the working queue: PENDING only, **oldest first**, because a callback is a queue and the person who has been waiting longest should be rung first. Pass `pendingOnly=false` to look back over what was already handled, newest first.  `contactWaId` is the number to ring — the queue would be unworkable without it, so it is decrypted for this response. `matchedLabel` says what they were asking for before they gave up, and being null is itself worth knowing: the menu never understood them. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * @summary People the menu promised to ring back
+     * @param {boolean} [pendingOnly]
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    callbacksRaw(requestParameters: CallbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageWaIvrCallbackResponse>>;
+    /**
+     * Callers who gave up waiting for an agent and asked to be called back instead. Default is the working queue: PENDING only, **oldest first**, because a callback is a queue and the person who has been waiting longest should be rung first. Pass `pendingOnly=false` to look back over what was already handled, newest first.  `contactWaId` is the number to ring — the queue would be unworkable without it, so it is decrypted for this response. `matchedLabel` says what they were asking for before they gave up, and being null is itself worth knowing: the menu never understood them. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * People the menu promised to ring back
+     */
+    callbacks(requestParameters: CallbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageWaIvrCallbackResponse>;
+    /**
+     * Created DRAFT — it does not answer anything until it is activated. Leave `phoneNumberId` null to answer every connected number. Options are validated against each other: two that share a key, or a spoken phrase, are refused here rather than left for a caller to hit. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Create a call menu
+     * @param {CreateWaIvrMenuRequest} createWaIvrMenuRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    createWhatsappIvrRaw(requestParameters: CreateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Created DRAFT — it does not answer anything until it is activated. Leave `phoneNumberId` null to answer every connected number. Options are validated against each other: two that share a key, or a spoken phrase, are refused here rather than left for a caller to hit. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Create a call menu
+     */
+    createWhatsappIvr(requestParameters: CreateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Calls to the number go back to ringing every connected agent, which is what happened before menus existed. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Stop answering calls with this menu
+     * @param {string} menuId
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    deactivateWhatsappRaw(requestParameters: DeactivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Calls to the number go back to ringing every connected agent, which is what happened before menus existed. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Stop answering calls with this menu
+     */
+    deactivateWhatsapp(requestParameters: DeactivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Delete a call menu
+     * @param {string} menuId
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    deleteWhatsappIvrRaw(requestParameters: DeleteWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Delete a call menu
+     */
+    deleteWhatsappIvr(requestParameters: DeleteWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Requires API-key scope: wacalling:read.
+     * @summary Read one call menu
+     * @param {string} menuId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    getWhatsappIvrRaw(requestParameters: GetWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Reads < 300ms. Requires API-key scope: wacalling:read.
+     * Read one call menu
+     */
+    getWhatsappIvr(requestParameters: GetWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Every menu, DRAFT and ACTIVE alike, with its options. Not paginated: a workspace has one menu per connected number and a handful of drafts, so a page boundary here would be ceremony. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * @summary List this workspace\'s call menus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    listWhatsappIvrRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WaIvrMenuResponse>>>;
+    /**
+     * Every menu, DRAFT and ACTIVE alike, with its options. Not paginated: a workspace has one menu per connected number and a handful of drafts, so a page boundary here would be ceremony. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * List this workspace\'s call menus
+     */
+    listWhatsappIvr(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WaIvrMenuResponse>>;
+    /**
+     * Synthesises the current wording without changing the menu\'s status — the \'I edited the greeting and want to hear it\' path. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Re-render this menu\'s prompts to audio
+     * @param {string} menuId
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    renderRaw(requestParameters: RenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Synthesises the current wording without changing the menu\'s status — the \'I edited the greeting and want to hear it\' path. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Re-render this menu\'s prompts to audio
+     */
+    render(requestParameters: RenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * COMPLETED when the customer was rung, CANCELLED when the promise was withdrawn. There is no route back to PENDING: an agent who rang the wrong person has made a call that happened, and the fix is a new promise rather than un-resolving this one.  Refused if somebody else already closed it, rather than overwriting — two agents working one queue is normal, and the second must not replace the first one\'s record of who actually rang the customer. Writes < 300ms. Requires API-key scope: wacalling:write.
+     * @summary Close a callback out
+     * @param {string} callbackId
+     * @param {ResolveIvrCallbackRequest} resolveIvrCallbackRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    resolveCallbackRaw(requestParameters: ResolveCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrCallbackResponse>>;
+    /**
+     * COMPLETED when the customer was rung, CANCELLED when the promise was withdrawn. There is no route back to PENDING: an agent who rang the wrong person has made a call that happened, and the fix is a new promise rather than un-resolving this one.  Refused if somebody else already closed it, rather than overwriting — two agents working one queue is normal, and the second must not replace the first one\'s record of who actually rang the customer. Writes < 300ms. Requires API-key scope: wacalling:write.
+     * Close a callback out
+     */
+    resolveCallback(requestParameters: ResolveCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrCallbackResponse>;
+    /**
+     * The outcome the call log cannot tell you: whether this caller reached an agent, gave up during the greeting, or was never understood. The transcript is not returned — it is speech content, encrypted at rest. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * @summary What happened to one caller in the menu
+     * @param {string} sessionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    sessionRaw(requestParameters: SessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrSessionResponse>>;
+    /**
+     * The outcome the call log cannot tell you: whether this caller reached an agent, gave up during the greeting, or was never understood. The transcript is not returned — it is speech content, encrypted at rest. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * What happened to one caller in the menu
+     */
+    session(requestParameters: SessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrSessionResponse>;
+    /**
+     * A full replacement, not a patch: options are ordered and positional, so merging a partial list would make \'delete the second option\' ambiguous. Clears the rendered-audio marker — the menu keeps playing its old prompts until re-rendered. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * @summary Replace a call menu\'s definition
+     * @param {string} menuId
+     * @param {UpdateWaIvrMenuRequest} updateWaIvrMenuRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppIvrApiInterface
+     */
+    updateWhatsappIvrRaw(requestParameters: UpdateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * A full replacement, not a patch: options are ordered and positional, so merging a partial list would make \'delete the second option\' ambiguous. Clears the rendered-audio marker — the menu keeps playing its old prompts until re-rendered. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Replace a call menu\'s definition
+     */
+    updateWhatsappIvr(requestParameters: UpdateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+}
+/**
+ *
+ */
+export declare class WhatsAppIvrApi extends runtime.BaseAPI implements WhatsAppIvrApiInterface {
+    /**
+     * Renders any stale prompts to audio and flips the menu ACTIVE, in one action — a tenant should not have to know that prompts are synthesised. Refused when another menu already answers that number: deactivate it first. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Make this menu answer its number
+     */
+    activateWhatsappRaw(requestParameters: ActivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Renders any stale prompts to audio and flips the menu ACTIVE, in one action — a tenant should not have to know that prompts are synthesised. Refused when another menu already answers that number: deactivate it first. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Make this menu answer its number
+     */
+    activateWhatsapp(requestParameters: ActivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * The agent\'s half of a menu call. **Post an OFFER here, not an answer** — the opposite of `POST /calls/{id}/accept`, and the difference is that a menu call was already answered by the media server, so Meta\'s offer is spent and the far end is now our own media server rather than Meta. Build a peer connection with a microphone track, create an offer, **wait for ICE gathering to complete** (there is no channel to trickle a late candidate on), and post it; feed the `sdpAnswer` that comes back to setRemoteDescription and the agent is on the call.  Sent when a `CALL_IVR_ROUTED` frame arrives. A frame naming this agent is theirs to take; one naming nobody is going spare and the first to post wins. Writes < 800ms — it crosses to the media server and back while a customer waits. Requires API-key scope: wacalling:write.
+     * Take a call the menu answered
+     */
+    agentLegRaw(requestParameters: AgentLegRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IvrAgentLegResponse>>;
+    /**
+     * The agent\'s half of a menu call. **Post an OFFER here, not an answer** — the opposite of `POST /calls/{id}/accept`, and the difference is that a menu call was already answered by the media server, so Meta\'s offer is spent and the far end is now our own media server rather than Meta. Build a peer connection with a microphone track, create an offer, **wait for ICE gathering to complete** (there is no channel to trickle a late candidate on), and post it; feed the `sdpAnswer` that comes back to setRemoteDescription and the agent is on the call.  Sent when a `CALL_IVR_ROUTED` frame arrives. A frame naming this agent is theirs to take; one naming nobody is going spare and the first to post wins. Writes < 800ms — it crosses to the media server and back while a customer waits. Requires API-key scope: wacalling:write.
+     * Take a call the menu answered
+     */
+    agentLeg(requestParameters: AgentLegRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IvrAgentLegResponse>;
+    /**
+     * Callers who gave up waiting for an agent and asked to be called back instead. Default is the working queue: PENDING only, **oldest first**, because a callback is a queue and the person who has been waiting longest should be rung first. Pass `pendingOnly=false` to look back over what was already handled, newest first.  `contactWaId` is the number to ring — the queue would be unworkable without it, so it is decrypted for this response. `matchedLabel` says what they were asking for before they gave up, and being null is itself worth knowing: the menu never understood them. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * People the menu promised to ring back
+     */
+    callbacksRaw(requestParameters: CallbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageWaIvrCallbackResponse>>;
+    /**
+     * Callers who gave up waiting for an agent and asked to be called back instead. Default is the working queue: PENDING only, **oldest first**, because a callback is a queue and the person who has been waiting longest should be rung first. Pass `pendingOnly=false` to look back over what was already handled, newest first.  `contactWaId` is the number to ring — the queue would be unworkable without it, so it is decrypted for this response. `matchedLabel` says what they were asking for before they gave up, and being null is itself worth knowing: the menu never understood them. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * People the menu promised to ring back
+     */
+    callbacks(requestParameters?: CallbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageWaIvrCallbackResponse>;
+    /**
+     * Created DRAFT — it does not answer anything until it is activated. Leave `phoneNumberId` null to answer every connected number. Options are validated against each other: two that share a key, or a spoken phrase, are refused here rather than left for a caller to hit. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Create a call menu
+     */
+    createWhatsappIvrRaw(requestParameters: CreateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Created DRAFT — it does not answer anything until it is activated. Leave `phoneNumberId` null to answer every connected number. Options are validated against each other: two that share a key, or a spoken phrase, are refused here rather than left for a caller to hit. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Create a call menu
+     */
+    createWhatsappIvr(requestParameters: CreateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Calls to the number go back to ringing every connected agent, which is what happened before menus existed. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Stop answering calls with this menu
+     */
+    deactivateWhatsappRaw(requestParameters: DeactivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Calls to the number go back to ringing every connected agent, which is what happened before menus existed. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Stop answering calls with this menu
+     */
+    deactivateWhatsapp(requestParameters: DeactivateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Delete a call menu
+     */
+    deleteWhatsappIvrRaw(requestParameters: DeleteWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Delete a call menu
+     */
+    deleteWhatsappIvr(requestParameters: DeleteWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Requires API-key scope: wacalling:read.
+     * Read one call menu
+     */
+    getWhatsappIvrRaw(requestParameters: GetWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Reads < 300ms. Requires API-key scope: wacalling:read.
+     * Read one call menu
+     */
+    getWhatsappIvr(requestParameters: GetWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * Every menu, DRAFT and ACTIVE alike, with its options. Not paginated: a workspace has one menu per connected number and a handful of drafts, so a page boundary here would be ceremony. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * List this workspace\'s call menus
+     */
+    listWhatsappIvrRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WaIvrMenuResponse>>>;
+    /**
+     * Every menu, DRAFT and ACTIVE alike, with its options. Not paginated: a workspace has one menu per connected number and a handful of drafts, so a page boundary here would be ceremony. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * List this workspace\'s call menus
+     */
+    listWhatsappIvr(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WaIvrMenuResponse>>;
+    /**
+     * Synthesises the current wording without changing the menu\'s status — the \'I edited the greeting and want to hear it\' path. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Re-render this menu\'s prompts to audio
+     */
+    renderRaw(requestParameters: RenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * Synthesises the current wording without changing the menu\'s status — the \'I edited the greeting and want to hear it\' path. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Re-render this menu\'s prompts to audio
+     */
+    render(requestParameters: RenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+    /**
+     * COMPLETED when the customer was rung, CANCELLED when the promise was withdrawn. There is no route back to PENDING: an agent who rang the wrong person has made a call that happened, and the fix is a new promise rather than un-resolving this one.  Refused if somebody else already closed it, rather than overwriting — two agents working one queue is normal, and the second must not replace the first one\'s record of who actually rang the customer. Writes < 300ms. Requires API-key scope: wacalling:write.
+     * Close a callback out
+     */
+    resolveCallbackRaw(requestParameters: ResolveCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrCallbackResponse>>;
+    /**
+     * COMPLETED when the customer was rung, CANCELLED when the promise was withdrawn. There is no route back to PENDING: an agent who rang the wrong person has made a call that happened, and the fix is a new promise rather than un-resolving this one.  Refused if somebody else already closed it, rather than overwriting — two agents working one queue is normal, and the second must not replace the first one\'s record of who actually rang the customer. Writes < 300ms. Requires API-key scope: wacalling:write.
+     * Close a callback out
+     */
+    resolveCallback(requestParameters: ResolveCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrCallbackResponse>;
+    /**
+     * The outcome the call log cannot tell you: whether this caller reached an agent, gave up during the greeting, or was never understood. The transcript is not returned — it is speech content, encrypted at rest. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * What happened to one caller in the menu
+     */
+    sessionRaw(requestParameters: SessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrSessionResponse>>;
+    /**
+     * The outcome the call log cannot tell you: whether this caller reached an agent, gave up during the greeting, or was never understood. The transcript is not returned — it is speech content, encrypted at rest. Reads < 300ms. Requires API-key scope: wacalling:read.
+     * What happened to one caller in the menu
+     */
+    session(requestParameters: SessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrSessionResponse>;
+    /**
+     * A full replacement, not a patch: options are ordered and positional, so merging a partial list would make \'delete the second option\' ambiguous. Clears the rendered-audio marker — the menu keeps playing its old prompts until re-rendered. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Replace a call menu\'s definition
+     */
+    updateWhatsappIvrRaw(requestParameters: UpdateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WaIvrMenuResponse>>;
+    /**
+     * A full replacement, not a patch: options are ordered and positional, so merging a partial list would make \'delete the second option\' ambiguous. Clears the rendered-audio marker — the menu keeps playing its old prompts until re-rendered. Writes < 800ms. Requires API-key scope: wacalling:write.
+     * Replace a call menu\'s definition
+     */
+    updateWhatsappIvr(requestParameters: UpdateWhatsappIvrRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WaIvrMenuResponse>;
+}