@augstash/sdk 0.2.0

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

@@ -0,0 +1,416 @@
+/**
+ * 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 { CreateWhatsAppFlowRequest, CursorPageFlowSubmissionResponse, FlowEncryptionStatusResponse, FlowPreviewResponse, FlowSendResponse, PageResponseWhatsAppFlowResponse, Pageable, RegisterFlowEncryptionKeyRequest, SendWhatsAppFlowRequest, UpdateWhatsAppFlowRequest, WhatsAppFlowResponse } from '../models/index';
+export interface CreateWhatsappRequest {
+    createWhatsAppFlowRequest: CreateWhatsAppFlowRequest;
+    xIdempotencyKey?: string;
+}
+export interface DeleteWhatsappRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface DeprecateRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface EncryptionKeyStatusRequest {
+    phoneNumberId: string;
+}
+export interface GetWhatsappRequest {
+    id: string;
+}
+export interface ListAllSubmissionsRequest {
+    flowId?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface ListSubmissionsRequest {
+    id: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface ListWhatsappFlowsRequest {
+    pageable: Pageable;
+    wabaAccountId?: string;
+    status?: ListWhatsappFlowsStatusEnum;
+}
+export interface PreviewWhatsappRequest {
+    id: string;
+}
+export interface PublishWhatsappRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface RegisterEncryptionKeyRequest {
+    registerFlowEncryptionKeyRequest: RegisterFlowEncryptionKeyRequest;
+    xIdempotencyKey?: string;
+}
+export interface SendWhatsappRequest {
+    id: string;
+    sendWhatsAppFlowRequest: SendWhatsAppFlowRequest;
+    xIdempotencyKey?: string;
+}
+export interface UpdateWhatsappRequest {
+    id: string;
+    updateWhatsAppFlowRequest: UpdateWhatsAppFlowRequest;
+    xIdempotencyKey?: string;
+}
+/**
+ * WhatsAppFlowApi - interface
+ *
+ * @export
+ * @interface WhatsAppFlowApiInterface
+ */
+export interface WhatsAppFlowApiInterface {
+    /**
+     * Creates the flow on Meta as a DRAFT and stores it locally. flowJson is optional — an empty draft is legal and is what the designer creates first. An invalid definition does NOT fail here: Meta returns validationErrors on a 200 and the flow simply cannot be published until they are cleared. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Create a WhatsApp Flow
+     * @param {CreateWhatsAppFlowRequest} createWhatsAppFlowRequest
+     * @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 WhatsAppFlowApiInterface
+     */
+    createWhatsappRaw(requestParameters: CreateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Creates the flow on Meta as a DRAFT and stores it locally. flowJson is optional — an empty draft is legal and is what the designer creates first. An invalid definition does NOT fail here: Meta returns validationErrors on a 200 and the flow simply cannot be published until they are cleared. Writes < 800ms. Requires API-key scope: flows:write.
+     * Create a WhatsApp Flow
+     */
+    createWhatsapp(requestParameters: CreateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Hard-deletes a DRAFT on Meta and locally. Meta permits this only before a flow has been published; a live flow must be deprecated instead, so this refuses rather than silently deprecating. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Delete a draft WhatsApp Flow
+     * @param {string} id
+     * @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 WhatsAppFlowApiInterface
+     */
+    deleteWhatsappRaw(requestParameters: DeleteWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Hard-deletes a DRAFT on Meta and locally. Meta permits this only before a flow has been published; a live flow must be deprecated instead, so this refuses rather than silently deprecating. Writes < 800ms. Requires API-key scope: flows:write.
+     * Delete a draft WhatsApp Flow
+     */
+    deleteWhatsapp(requestParameters: DeleteWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retires a PUBLISHED flow. Terminal on Meta\'s side — there is no un-deprecate, and the flow can no longer be sent. Past submissions are kept. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Deprecate a WhatsApp Flow
+     * @param {string} id
+     * @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 WhatsAppFlowApiInterface
+     */
+    deprecateRaw(requestParameters: DeprecateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Retires a PUBLISHED flow. Terminal on Meta\'s side — there is no un-deprecate, and the flow can no longer be sent. Past submissions are kept. Writes < 800ms. Requires API-key scope: flows:write.
+     * Deprecate a WhatsApp Flow
+     */
+    deprecate(requestParameters: DeprecateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Whether a sender number is ready to run endpoint-backed (dynamic) flows. Three states the FE must tell apart: keyConfigured=false (this environment holds no key — normal locally, a deployment matter otherwise), registered=false (a key exists here but Meta has never been told), and signatureStatus=MISMATCH (Meta holds a key it cannot verify — re-register). matchesLocalKey additionally catches a rotation this service has not registered yet. Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary Read the data-exchange key registration
+     * @param {string} phoneNumberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    encryptionKeyStatusRaw(requestParameters: EncryptionKeyStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowEncryptionStatusResponse>>;
+    /**
+     * Whether a sender number is ready to run endpoint-backed (dynamic) flows. Three states the FE must tell apart: keyConfigured=false (this environment holds no key — normal locally, a deployment matter otherwise), registered=false (a key exists here but Meta has never been told), and signatureStatus=MISMATCH (Meta holds a key it cannot verify — re-register). matchesLocalKey additionally catches a rotation this service has not registered yet. Reads < 300ms. Requires API-key scope: flows:read.
+     * Read the data-exchange key registration
+     */
+    encryptionKeyStatus(requestParameters: EncryptionKeyStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowEncryptionStatusResponse>;
+    /**
+     * The full stored definition, its Meta id, its publish state and any outstanding validation errors. Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary Get one WhatsApp Flow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    getWhatsappRaw(requestParameters: GetWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * The full stored definition, its Meta id, its publish state and any outstanding validation errors. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get one WhatsApp Flow
+     */
+    getWhatsapp(requestParameters: GetWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Completed flows across every form, newest first, cursor-paginated. Pass flowId to filter; omit it to include submissions whose flow_token carried no known prefix, which have no parent flow and appear nowhere else. Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary List flow submissions
+     * @param {string} [flowId]
+     * @param {string} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    listAllSubmissionsRaw(requestParameters: ListAllSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageFlowSubmissionResponse>>;
+    /**
+     * Completed flows across every form, newest first, cursor-paginated. Pass flowId to filter; omit it to include submissions whose flow_token carried no known prefix, which have no parent flow and appear nowhere else. Reads < 300ms. Requires API-key scope: flows:read.
+     * List flow submissions
+     */
+    listAllSubmissions(requestParameters: ListAllSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageFlowSubmissionResponse>;
+    /**
+     * Everything customers have submitted through this flow, newest first, cursor-paginated (default 20, max 100). Pass the previous page\'s nextCursor as ?cursor=. Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary List one flow\'s submissions
+     * @param {string} id
+     * @param {string} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    listSubmissionsRaw(requestParameters: ListSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageFlowSubmissionResponse>>;
+    /**
+     * Everything customers have submitted through this flow, newest first, cursor-paginated (default 20, max 100). Pass the previous page\'s nextCursor as ?cursor=. Reads < 300ms. Requires API-key scope: flows:read.
+     * List one flow\'s submissions
+     */
+    listSubmissions(requestParameters: ListSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageFlowSubmissionResponse>;
+    /**
+     * Every flow this tenant owns, optionally filtered by WABA and status. Offset-paginated (default 20, max 100). Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary List WhatsApp Flows
+     * @param {Pageable} pageable
+     * @param {string} [wabaAccountId]
+     * @param {'DRAFT' | 'PUBLISHED' | 'DEPRECATED'} [status]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    listWhatsappFlowsRaw(requestParameters: ListWhatsappFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseWhatsAppFlowResponse>>;
+    /**
+     * Every flow this tenant owns, optionally filtered by WABA and status. Offset-paginated (default 20, max 100). Reads < 300ms. Requires API-key scope: flows:read.
+     * List WhatsApp Flows
+     */
+    listWhatsappFlows(requestParameters: ListWhatsappFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseWhatsAppFlowResponse>;
+    /**
+     * A short-lived Meta-hosted URL that renders the flow in a browser — what the designer\'s \'preview in WhatsApp\' button opens. Fetched from Meta on every call and never cached, because the URL is revocable and a stored one would quietly stop working. Opening it twice does not revoke the first link. Reads < 300ms. Requires API-key scope: flows:read.
+     * @summary Get a flow\'s preview URL
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WhatsAppFlowApiInterface
+     */
+    previewWhatsappRaw(requestParameters: PreviewWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowPreviewResponse>>;
+    /**
+     * A short-lived Meta-hosted URL that renders the flow in a browser — what the designer\'s \'preview in WhatsApp\' button opens. Fetched from Meta on every call and never cached, because the URL is revocable and a stored one would quietly stop working. Opening it twice does not revoke the first link. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get a flow\'s preview URL
+     */
+    previewWhatsapp(requestParameters: PreviewWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowPreviewResponse>;
+    /**
+     * Takes a DRAFT live. This is where an invalid definition finally fails: Meta refuses to publish a flow carrying validation errors, and the errors are persisted onto the flow so the designer can act on them. One-way — a published flow cannot return to draft. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Publish a WhatsApp Flow
+     * @param {string} id
+     * @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 WhatsAppFlowApiInterface
+     */
+    publishWhatsappRaw(requestParameters: PublishWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Takes a DRAFT live. This is where an invalid definition finally fails: Meta refuses to publish a flow carrying validation errors, and the errors are persisted onto the flow so the designer can act on them. One-way — a published flow cannot return to draft. Writes < 800ms. Requires API-key scope: flows:write.
+     * Publish a WhatsApp Flow
+     */
+    publishWhatsapp(requestParameters: PublishWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Registers THIS environment\'s WhatsApp Flows public key against one of the tenant\'s connected sender numbers (POST /{phone_number_id}/whatsapp_business_encryption). The key is derived from the private key configured here — it is never supplied by the caller, because a key whose private half we do not hold would make every data-exchange request undecryptable and kill dynamic flows silently on the handset. Until this is done once per sending number, an endpoint-backed flow does not work and reports no error anywhere. Returns the state Meta holds afterwards, read back rather than assumed. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Register the data-exchange public key with Meta
+     * @param {RegisterFlowEncryptionKeyRequest} registerFlowEncryptionKeyRequest
+     * @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 WhatsAppFlowApiInterface
+     */
+    registerEncryptionKeyRaw(requestParameters: RegisterEncryptionKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowEncryptionStatusResponse>>;
+    /**
+     * Registers THIS environment\'s WhatsApp Flows public key against one of the tenant\'s connected sender numbers (POST /{phone_number_id}/whatsapp_business_encryption). The key is derived from the private key configured here — it is never supplied by the caller, because a key whose private half we do not hold would make every data-exchange request undecryptable and kill dynamic flows silently on the handset. Until this is done once per sending number, an endpoint-backed flow does not work and reports no error anywhere. Returns the state Meta holds afterwards, read back rather than assumed. Writes < 800ms. Requires API-key scope: flows:write.
+     * Register the data-exchange public key with Meta
+     */
+    registerEncryptionKey(requestParameters: RegisterEncryptionKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowEncryptionStatusResponse>;
+    /**
+     * Sends a PUBLISHED flow to one customer and returns the flow_token Augstash minted for it — that token is what attributes the submission that comes back, so the caller should keep it. Inside the customer\'s 24-hour service window the flow goes as a free-form interactive message (flowCta + bodyText required; screen required when flowAction=NAVIGATE). Once that window has closed Meta permits no free-form message at all, so templateName + languageCode are used instead and the template must already be approved WITH a FLOW button — supplying neither is WHATSAPP_FLOW_WINDOW_CLOSED, not a silent failure. sentVia in the response says which of the two happened. Billed like any WhatsApp send: reserved before the Meta call, confirmed on acceptance, rolled back on failure. Sends < 800ms. Requires API-key scope: flows:write.
+     * @summary Send a WhatsApp Flow to a customer
+     * @param {string} id
+     * @param {SendWhatsAppFlowRequest} sendWhatsAppFlowRequest
+     * @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 WhatsAppFlowApiInterface
+     */
+    sendWhatsappRaw(requestParameters: SendWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowSendResponse>>;
+    /**
+     * Sends a PUBLISHED flow to one customer and returns the flow_token Augstash minted for it — that token is what attributes the submission that comes back, so the caller should keep it. Inside the customer\'s 24-hour service window the flow goes as a free-form interactive message (flowCta + bodyText required; screen required when flowAction=NAVIGATE). Once that window has closed Meta permits no free-form message at all, so templateName + languageCode are used instead and the template must already be approved WITH a FLOW button — supplying neither is WHATSAPP_FLOW_WINDOW_CLOSED, not a silent failure. sentVia in the response says which of the two happened. Billed like any WhatsApp send: reserved before the Meta call, confirmed on acceptance, rolled back on failure. Sends < 800ms. Requires API-key scope: flows:write.
+     * Send a WhatsApp Flow to a customer
+     */
+    sendWhatsapp(requestParameters: SendWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowSendResponse>;
+    /**
+     * Full replace of name and categories; flowJson is optional and null leaves the uploaded definition alone, which is what a rename needs. Allowed on a PUBLISHED flow (Meta permits editing a live definition) but not on a DEPRECATED one. Writes < 800ms. Requires API-key scope: flows:write.
+     * @summary Replace a WhatsApp Flow\'s definition
+     * @param {string} id
+     * @param {UpdateWhatsAppFlowRequest} updateWhatsAppFlowRequest
+     * @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 WhatsAppFlowApiInterface
+     */
+    updateWhatsappRaw(requestParameters: UpdateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Full replace of name and categories; flowJson is optional and null leaves the uploaded definition alone, which is what a rename needs. Allowed on a PUBLISHED flow (Meta permits editing a live definition) but not on a DEPRECATED one. Writes < 800ms. Requires API-key scope: flows:write.
+     * Replace a WhatsApp Flow\'s definition
+     */
+    updateWhatsapp(requestParameters: UpdateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+}
+/**
+ *
+ */
+export declare class WhatsAppFlowApi extends runtime.BaseAPI implements WhatsAppFlowApiInterface {
+    /**
+     * Creates the flow on Meta as a DRAFT and stores it locally. flowJson is optional — an empty draft is legal and is what the designer creates first. An invalid definition does NOT fail here: Meta returns validationErrors on a 200 and the flow simply cannot be published until they are cleared. Writes < 800ms. Requires API-key scope: flows:write.
+     * Create a WhatsApp Flow
+     */
+    createWhatsappRaw(requestParameters: CreateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Creates the flow on Meta as a DRAFT and stores it locally. flowJson is optional — an empty draft is legal and is what the designer creates first. An invalid definition does NOT fail here: Meta returns validationErrors on a 200 and the flow simply cannot be published until they are cleared. Writes < 800ms. Requires API-key scope: flows:write.
+     * Create a WhatsApp Flow
+     */
+    createWhatsapp(requestParameters: CreateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Hard-deletes a DRAFT on Meta and locally. Meta permits this only before a flow has been published; a live flow must be deprecated instead, so this refuses rather than silently deprecating. Writes < 800ms. Requires API-key scope: flows:write.
+     * Delete a draft WhatsApp Flow
+     */
+    deleteWhatsappRaw(requestParameters: DeleteWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Hard-deletes a DRAFT on Meta and locally. Meta permits this only before a flow has been published; a live flow must be deprecated instead, so this refuses rather than silently deprecating. Writes < 800ms. Requires API-key scope: flows:write.
+     * Delete a draft WhatsApp Flow
+     */
+    deleteWhatsapp(requestParameters: DeleteWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retires a PUBLISHED flow. Terminal on Meta\'s side — there is no un-deprecate, and the flow can no longer be sent. Past submissions are kept. Writes < 800ms. Requires API-key scope: flows:write.
+     * Deprecate a WhatsApp Flow
+     */
+    deprecateRaw(requestParameters: DeprecateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Retires a PUBLISHED flow. Terminal on Meta\'s side — there is no un-deprecate, and the flow can no longer be sent. Past submissions are kept. Writes < 800ms. Requires API-key scope: flows:write.
+     * Deprecate a WhatsApp Flow
+     */
+    deprecate(requestParameters: DeprecateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Whether a sender number is ready to run endpoint-backed (dynamic) flows. Three states the FE must tell apart: keyConfigured=false (this environment holds no key — normal locally, a deployment matter otherwise), registered=false (a key exists here but Meta has never been told), and signatureStatus=MISMATCH (Meta holds a key it cannot verify — re-register). matchesLocalKey additionally catches a rotation this service has not registered yet. Reads < 300ms. Requires API-key scope: flows:read.
+     * Read the data-exchange key registration
+     */
+    encryptionKeyStatusRaw(requestParameters: EncryptionKeyStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowEncryptionStatusResponse>>;
+    /**
+     * Whether a sender number is ready to run endpoint-backed (dynamic) flows. Three states the FE must tell apart: keyConfigured=false (this environment holds no key — normal locally, a deployment matter otherwise), registered=false (a key exists here but Meta has never been told), and signatureStatus=MISMATCH (Meta holds a key it cannot verify — re-register). matchesLocalKey additionally catches a rotation this service has not registered yet. Reads < 300ms. Requires API-key scope: flows:read.
+     * Read the data-exchange key registration
+     */
+    encryptionKeyStatus(requestParameters: EncryptionKeyStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowEncryptionStatusResponse>;
+    /**
+     * The full stored definition, its Meta id, its publish state and any outstanding validation errors. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get one WhatsApp Flow
+     */
+    getWhatsappRaw(requestParameters: GetWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * The full stored definition, its Meta id, its publish state and any outstanding validation errors. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get one WhatsApp Flow
+     */
+    getWhatsapp(requestParameters: GetWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Completed flows across every form, newest first, cursor-paginated. Pass flowId to filter; omit it to include submissions whose flow_token carried no known prefix, which have no parent flow and appear nowhere else. Reads < 300ms. Requires API-key scope: flows:read.
+     * List flow submissions
+     */
+    listAllSubmissionsRaw(requestParameters: ListAllSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageFlowSubmissionResponse>>;
+    /**
+     * Completed flows across every form, newest first, cursor-paginated. Pass flowId to filter; omit it to include submissions whose flow_token carried no known prefix, which have no parent flow and appear nowhere else. Reads < 300ms. Requires API-key scope: flows:read.
+     * List flow submissions
+     */
+    listAllSubmissions(requestParameters?: ListAllSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageFlowSubmissionResponse>;
+    /**
+     * Everything customers have submitted through this flow, newest first, cursor-paginated (default 20, max 100). Pass the previous page\'s nextCursor as ?cursor=. Reads < 300ms. Requires API-key scope: flows:read.
+     * List one flow\'s submissions
+     */
+    listSubmissionsRaw(requestParameters: ListSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageFlowSubmissionResponse>>;
+    /**
+     * Everything customers have submitted through this flow, newest first, cursor-paginated (default 20, max 100). Pass the previous page\'s nextCursor as ?cursor=. Reads < 300ms. Requires API-key scope: flows:read.
+     * List one flow\'s submissions
+     */
+    listSubmissions(requestParameters: ListSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageFlowSubmissionResponse>;
+    /**
+     * Every flow this tenant owns, optionally filtered by WABA and status. Offset-paginated (default 20, max 100). Reads < 300ms. Requires API-key scope: flows:read.
+     * List WhatsApp Flows
+     */
+    listWhatsappFlowsRaw(requestParameters: ListWhatsappFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseWhatsAppFlowResponse>>;
+    /**
+     * Every flow this tenant owns, optionally filtered by WABA and status. Offset-paginated (default 20, max 100). Reads < 300ms. Requires API-key scope: flows:read.
+     * List WhatsApp Flows
+     */
+    listWhatsappFlows(requestParameters: ListWhatsappFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseWhatsAppFlowResponse>;
+    /**
+     * A short-lived Meta-hosted URL that renders the flow in a browser — what the designer\'s \'preview in WhatsApp\' button opens. Fetched from Meta on every call and never cached, because the URL is revocable and a stored one would quietly stop working. Opening it twice does not revoke the first link. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get a flow\'s preview URL
+     */
+    previewWhatsappRaw(requestParameters: PreviewWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowPreviewResponse>>;
+    /**
+     * A short-lived Meta-hosted URL that renders the flow in a browser — what the designer\'s \'preview in WhatsApp\' button opens. Fetched from Meta on every call and never cached, because the URL is revocable and a stored one would quietly stop working. Opening it twice does not revoke the first link. Reads < 300ms. Requires API-key scope: flows:read.
+     * Get a flow\'s preview URL
+     */
+    previewWhatsapp(requestParameters: PreviewWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowPreviewResponse>;
+    /**
+     * Takes a DRAFT live. This is where an invalid definition finally fails: Meta refuses to publish a flow carrying validation errors, and the errors are persisted onto the flow so the designer can act on them. One-way — a published flow cannot return to draft. Writes < 800ms. Requires API-key scope: flows:write.
+     * Publish a WhatsApp Flow
+     */
+    publishWhatsappRaw(requestParameters: PublishWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Takes a DRAFT live. This is where an invalid definition finally fails: Meta refuses to publish a flow carrying validation errors, and the errors are persisted onto the flow so the designer can act on them. One-way — a published flow cannot return to draft. Writes < 800ms. Requires API-key scope: flows:write.
+     * Publish a WhatsApp Flow
+     */
+    publishWhatsapp(requestParameters: PublishWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+    /**
+     * Registers THIS environment\'s WhatsApp Flows public key against one of the tenant\'s connected sender numbers (POST /{phone_number_id}/whatsapp_business_encryption). The key is derived from the private key configured here — it is never supplied by the caller, because a key whose private half we do not hold would make every data-exchange request undecryptable and kill dynamic flows silently on the handset. Until this is done once per sending number, an endpoint-backed flow does not work and reports no error anywhere. Returns the state Meta holds afterwards, read back rather than assumed. Writes < 800ms. Requires API-key scope: flows:write.
+     * Register the data-exchange public key with Meta
+     */
+    registerEncryptionKeyRaw(requestParameters: RegisterEncryptionKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowEncryptionStatusResponse>>;
+    /**
+     * Registers THIS environment\'s WhatsApp Flows public key against one of the tenant\'s connected sender numbers (POST /{phone_number_id}/whatsapp_business_encryption). The key is derived from the private key configured here — it is never supplied by the caller, because a key whose private half we do not hold would make every data-exchange request undecryptable and kill dynamic flows silently on the handset. Until this is done once per sending number, an endpoint-backed flow does not work and reports no error anywhere. Returns the state Meta holds afterwards, read back rather than assumed. Writes < 800ms. Requires API-key scope: flows:write.
+     * Register the data-exchange public key with Meta
+     */
+    registerEncryptionKey(requestParameters: RegisterEncryptionKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowEncryptionStatusResponse>;
+    /**
+     * Sends a PUBLISHED flow to one customer and returns the flow_token Augstash minted for it — that token is what attributes the submission that comes back, so the caller should keep it. Inside the customer\'s 24-hour service window the flow goes as a free-form interactive message (flowCta + bodyText required; screen required when flowAction=NAVIGATE). Once that window has closed Meta permits no free-form message at all, so templateName + languageCode are used instead and the template must already be approved WITH a FLOW button — supplying neither is WHATSAPP_FLOW_WINDOW_CLOSED, not a silent failure. sentVia in the response says which of the two happened. Billed like any WhatsApp send: reserved before the Meta call, confirmed on acceptance, rolled back on failure. Sends < 800ms. Requires API-key scope: flows:write.
+     * Send a WhatsApp Flow to a customer
+     */
+    sendWhatsappRaw(requestParameters: SendWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowSendResponse>>;
+    /**
+     * Sends a PUBLISHED flow to one customer and returns the flow_token Augstash minted for it — that token is what attributes the submission that comes back, so the caller should keep it. Inside the customer\'s 24-hour service window the flow goes as a free-form interactive message (flowCta + bodyText required; screen required when flowAction=NAVIGATE). Once that window has closed Meta permits no free-form message at all, so templateName + languageCode are used instead and the template must already be approved WITH a FLOW button — supplying neither is WHATSAPP_FLOW_WINDOW_CLOSED, not a silent failure. sentVia in the response says which of the two happened. Billed like any WhatsApp send: reserved before the Meta call, confirmed on acceptance, rolled back on failure. Sends < 800ms. Requires API-key scope: flows:write.
+     * Send a WhatsApp Flow to a customer
+     */
+    sendWhatsapp(requestParameters: SendWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowSendResponse>;
+    /**
+     * Full replace of name and categories; flowJson is optional and null leaves the uploaded definition alone, which is what a rename needs. Allowed on a PUBLISHED flow (Meta permits editing a live definition) but not on a DEPRECATED one. Writes < 800ms. Requires API-key scope: flows:write.
+     * Replace a WhatsApp Flow\'s definition
+     */
+    updateWhatsappRaw(requestParameters: UpdateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WhatsAppFlowResponse>>;
+    /**
+     * Full replace of name and categories; flowJson is optional and null leaves the uploaded definition alone, which is what a rename needs. Allowed on a PUBLISHED flow (Meta permits editing a live definition) but not on a DEPRECATED one. Writes < 800ms. Requires API-key scope: flows:write.
+     * Replace a WhatsApp Flow\'s definition
+     */
+    updateWhatsapp(requestParameters: UpdateWhatsappRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WhatsAppFlowResponse>;
+}
+/**
+ * @export
+ */
+export declare const ListWhatsappFlowsStatusEnum: {
+    readonly Draft: "DRAFT";
+    readonly Published: "PUBLISHED";
+    readonly Deprecated: "DEPRECATED";
+};
+export type ListWhatsappFlowsStatusEnum = typeof ListWhatsappFlowsStatusEnum[keyof typeof ListWhatsappFlowsStatusEnum];