@wokuapp/sdk 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,1616 @@
+/** Per-call overrides accepted by every resource method's last argument. */
+interface RequestOptions {
+    /** Abort the request after N ms (overrides the client default). */
+    timeout?: number;
+    /** Retry budget for this call (overrides the client default). */
+    maxRetries?: number;
+    /**
+     * Idempotency key for a POST. One is generated automatically for creates;
+     * pass your own to make a specific call safe to retry with the same result.
+     */
+    idempotencyKey?: string;
+    /** Caller-owned abort signal; aborting rejects with a connection error. */
+    signal?: AbortSignal;
+    /** Extra headers merged over the defaults (Authorization cannot be unset). */
+    headers?: Record<string, string>;
+    /** Extra query params merged over the method's own params. */
+    query?: Record<string, unknown>;
+}
+
+/** The paginated envelope every `/v1` list endpoint returns. */
+interface PageResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+}
+/**
+ * A single page of results plus the cursor to walk the rest. Iterate items
+ * across every page with `for await (const item of page)`, or walk page by
+ * page with `for await (const p of page.iterPages())`.
+ */
+declare class Page<T> implements AsyncIterable<T> {
+    private readonly fetchPage;
+    private readonly options?;
+    readonly data: T[];
+    readonly total: number;
+    readonly page: number;
+    readonly limit: number;
+    constructor(response: PageResponse<T>, fetchPage: (page: number, opts?: RequestOptions) => Promise<Page<T>>, options?: RequestOptions | undefined);
+    /** Whether another page exists after this one. */
+    hasNextPage(): boolean;
+    /** Fetch the next page (throws if there is none — guard with hasNextPage). */
+    getNextPage(): Promise<Page<T>>;
+    /** Yield every item across all pages, fetching lazily as needed. */
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    /** Yield each Page, fetching lazily as needed. */
+    iterPages(): AsyncGenerator<Page<T>>;
+}
+
+/** Minimal subset of the Fetch API the client depends on. */
+type FetchLike = (input: string, init: {
+    method: string;
+    headers: Record<string, string>;
+    body?: string;
+    signal?: AbortSignal;
+}) => Promise<{
+    status: number;
+    headers: {
+        get(name: string): string | null;
+    };
+    text(): Promise<string>;
+}>;
+interface WokuClientOptions {
+    /** Company secret key. Defaults to `process.env.WOKU_API_KEY`. */
+    apiKey?: string;
+    /** API base URL. Defaults to `https://clientapi.woku.app`. */
+    baseURL?: string;
+    /** Per-request timeout in ms. Default 60000. */
+    timeout?: number;
+    /** Automatic retries for transient failures. Default 2. */
+    maxRetries?: number;
+    /** Custom fetch implementation. Defaults to the global `fetch`. */
+    fetch?: FetchLike;
+    /** Headers merged into every request. */
+    defaultHeaders?: Record<string, string>;
+    /**
+     * Allow running in a browser. Off by default: the secret key grants full
+     * management access and must never ship to a browser bundle.
+     */
+    dangerouslyAllowBrowser?: boolean;
+}
+interface RequestArgs extends RequestOptions {
+    body?: unknown;
+    /**
+     * Mark a POST as an idempotent create: an idempotency key is auto-generated
+     * (unless the caller passed one) so a retry after a transient failure returns
+     * the original result instead of creating twice. Left off for action POSTs
+     * (send/approve/test) so they are never silently replayed.
+     */
+    idempotent?: boolean;
+}
+/**
+ * Transport core: turns a resource call into an authenticated HTTP request
+ * with timeout, typed error mapping and jittered retries. Resource namespaces
+ * call {@link request} and {@link getPage}; end users use the `Woku` facade.
+ */
+declare class WokuClient {
+    readonly baseURL: string;
+    readonly maxRetries: number;
+    readonly timeout: number;
+    private readonly apiKey;
+    private readonly fetch;
+    private readonly defaultHeaders;
+    constructor(options?: WokuClientOptions);
+    /** Issue one request and return the parsed JSON body typed as `T`. */
+    request<T>(method: string, path: string, args?: RequestArgs): Promise<T>;
+    /**
+     * Issue a GET that returns a paginated envelope and wrap it as a {@link Page}.
+     * `params` accepts any plain object (a resource's typed params interface).
+     */
+    getPage<T>(path: string, params?: object, opts?: RequestOptions): Promise<Page<T>>;
+    private buildUrl;
+    private buildHeaders;
+    private send;
+    private backoff;
+}
+
+interface components {
+    schemas: {
+        ValidationErrorResponseDto: {
+            /**
+             * @description HTTP status code
+             * @example 400
+             */
+            statusCode: number;
+            /**
+             * @description Array of validation error messages
+             * @example [
+             *       "email must be a valid email",
+             *       "password must be at least 8 characters"
+             *     ]
+             */
+            message: string[];
+            /**
+             * @description Error type
+             * @example Bad Request
+             */
+            error: string;
+        };
+        CreateWokuApiDto: Record<string, never>;
+        CreateWokuFormDataApiDto: Record<string, never>;
+        CreateExternalTrackerDefinitionDTO: {
+            /**
+             * @description Tracker name. Identifies the tracker within the company catalog. Unique per company.
+             * @example trr
+             */
+            name: string;
+            /**
+             * @description External system this tracker maps to.
+             * @example crm interno
+             */
+            system: string;
+            /**
+             * @description Human-readable description of the tracker.
+             * @example transaction id of a lease or sale
+             */
+            description?: string;
+        };
+        AssignWokuExternalTrackerByNameDTO: {
+            /**
+             * @description Name of the company-level external tracker definition this value belongs to.
+             * @example trr
+             */
+            name: string;
+            /**
+             * @description External identifier value (always stored as string).
+             * @example dasdj123kdak32
+             */
+            value: string;
+        };
+        ExternalTrackerFilterDTO: {
+            /**
+             * @description Tracker name (resolved to its definition server-side).
+             * @example trr
+             */
+            name: string;
+            /**
+             * @description Value to match (partial, case-insensitive).
+             * @example ABC
+             */
+            value: string;
+        };
+        SearchEntitiesByTrackersDTO: {
+            /**
+             * @description VoC entity type to search.
+             * @example nps
+             * @enum {string}
+             */
+            entityType: 'nps' | 'csat' | 'ces' | 'form' | 'flow';
+            /** @description Tracker filters combined with AND. Each entity must match every filter to be returned. */
+            filters: components['schemas']['ExternalTrackerFilterDTO'][];
+        };
+        UpdateExternalTrackerDefinitionDTO: {
+            /** @description New name (must remain unique within the company). */
+            name?: string;
+            /** @description New external system identifier. */
+            system?: string;
+            /** @description New description. */
+            description?: string;
+        };
+        AssignExternalTrackerByNameDTO: {
+            /**
+             * @description Name of the company-level external tracker definition this value belongs to.
+             * @example trr
+             */
+            name: string;
+            /**
+             * @description External identifier value (always stored as string).
+             * @example dasdj123kdak32
+             */
+            value: string;
+        };
+        TicketRoutingConditionDto: {
+            /** @enum {string} */
+            relationToPrevious?: 'AND' | 'OR';
+            /** @description CompanyExternalTracker id. */
+            trackerId: string;
+            /**
+             * @default equals
+             * @enum {string}
+             */
+            operator: 'equals' | 'any';
+            /** @description The value the tracker must equal. Required unless operator is "any". */
+            value?: string;
+        };
+        TicketDestinationTemplateDto: {
+            /** @example custom */
+            preset: string;
+            /** @description Custom JSON body with {{path}} placeholders. */
+            body?: string;
+        };
+        CreateTicketDestinationDto: {
+            /** @example Zendesk Soporte Chile */
+            name: string;
+            /** @enum {string} */
+            kind: 'zendesk' | 'salesforce' | 'slack' | 'custom' | 'email';
+            /** @description Non-secret provider config (validated per kind). */
+            config: Record<string, never>;
+            /** @description Provider credentials (write-only, encrypted). */
+            credentials: Record<string, never>;
+            /** @description Per-destination AI triage context. */
+            aiContext?: string;
+            routingConditions?: components['schemas']['TicketRoutingConditionDto'][];
+            template?: components['schemas']['TicketDestinationTemplateDto'];
+        };
+        UpdateTicketDestinationDto: {
+            name?: string;
+            /** @enum {string} */
+            kind?: 'zendesk' | 'salesforce' | 'slack' | 'custom' | 'email';
+            config?: Record<string, never>;
+            /** @description Present = credential rotation. */
+            credentials?: Record<string, never>;
+            /** @description Per-destination AI triage context. */
+            aiContext?: string;
+            routingConditions?: components['schemas']['TicketRoutingConditionDto'][];
+            template?: components['schemas']['TicketDestinationTemplateDto'];
+            enabled?: boolean;
+        };
+        TestTicketDestinationBodyDTO: {
+            /** @description Must be true. The test sends a real request to the destination (custom webhooks receive a test payload; other kinds run a read-only auth probe). */
+            confirm: boolean;
+        };
+        ActionPlanGroupConditionDto: {
+            /** @enum {string} */
+            relationToPrevious?: 'AND' | 'OR';
+            /** @description CompanyExternalTracker id. */
+            trackerId: string;
+            /**
+             * @default equals
+             * @enum {string}
+             */
+            operator: 'equals' | 'any';
+            /** @description The value the tracker must equal. Required unless operator is "any". */
+            value?: string;
+        };
+        ActionPlanGroupMemberDto: {
+            /** @description Company member user id. */
+            userId: string;
+            /** @enum {string} */
+            role: 'admin' | 'assignee';
+        };
+        CreateActionPlanGroupDto: {
+            /** @example Atención en tienda */
+            name: string;
+            description?: string;
+            /** @description Tracker conditions; at least one row is required. */
+            conditions: components['schemas']['ActionPlanGroupConditionDto'][];
+            /** @description Group team; at least one admin and one assignee. */
+            members: components['schemas']['ActionPlanGroupMemberDto'][];
+            /**
+             * @description New improvement comments that trigger a plan draft (default 300).
+             * @default 300
+             */
+            threshold: number;
+        };
+        UpdateActionPlanGroupDto: {
+            name?: string;
+            /** @description Empty string clears. */
+            description?: string;
+            conditions?: components['schemas']['ActionPlanGroupConditionDto'][];
+            members?: components['schemas']['ActionPlanGroupMemberDto'][];
+            threshold?: number;
+        };
+        SetActionPlanGroupEnabledDto: {
+            enabled: boolean;
+        };
+        PostPlanReplyBodyDTO: {
+            /** @description Message to send to the plan AI agent. */
+            text: string;
+            /** @description Must be true. Each reply triggers a paid AI turn; the reply is composed asynchronously and delivered over the plan channel. */
+            confirm: boolean;
+        };
+        SendActionPlanDto: {
+            /** @enum {string} */
+            provider: 'jira' | 'monday' | 'clickup' | 'notion' | 'internal';
+            /** @description Provider-specific resource ids (external providers): jira {siteId?, projectId, issueTypeId} · monday {boardId, groupId} · clickup {listId} · notion {databaseId}. Omitted for the managed provider. */
+            target?: Record<string, never>;
+            /** @description Human destination summary the drawer built ("Operaciones CX · Backlog"); persisted as delivery.resourceLabel. Omitted for the managed provider. */
+            resourceLabel?: string;
+        };
+        CreateActionPlanTaskDto: {
+            /** @description Task text. */
+            text: string;
+        };
+        ReorderActionPlanTasksDto: {
+            /** @description All task ids in the desired order. */
+            orderedTaskIds: string[];
+        };
+        UpdateActionPlanTaskDto: {
+            /** @description New task text. */
+            text?: string;
+            /** @enum {string} */
+            status?: 'todo' | 'in_progress' | 'done';
+            /** @description Group member responsible; null/"" clears the assignee. */
+            assigneeId?: string;
+        };
+        V1WokuLocalizedContentDTO: {
+            /**
+             * @example en
+             * @enum {string}
+             */
+            locale: 'es' | 'en';
+            description: string;
+        };
+        UpdateWokuBodyDTO: {
+            /** @description Woku description/title. */
+            description?: string;
+            /**
+             * @description Locales the survey is available in (subset of es/en).
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /** @enum {string} */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['V1WokuLocalizedContentDTO'][];
+        };
+        UpdateWokuSettingsBodyDTO: {
+            /** @description Whether the woku is closed to new reviews. */
+            closed?: boolean;
+            /** @description Whether new reviews are disabled. */
+            reviewsDisabled?: boolean;
+            /** @description Whether anonymous reviews are disabled. */
+            anonymousDisabled?: boolean;
+            /** @description Whether each client may leave only one review. */
+            onlyOneReviewPerClient?: boolean;
+        };
+        MoveWokuBodyDTO: {
+            /**
+             * Format: ObjectId
+             * @description Target folder id, or null to move the woku to the root.
+             */
+            folderId: string | null;
+        };
+        V1CreateTextnoteBodyDto: {
+            /**
+             * @description Star rating (1-5)
+             * @example 5
+             */
+            qualification: number;
+            /** @description Text content of the review (max 3000 chars) */
+            description: string;
+            /** @description Reviewer email */
+            clientEmail?: string;
+            /** @description Reviewer phone */
+            clientPhone?: string;
+            /** @description Whether the review is anonymous */
+            anonymous?: boolean;
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel).
+             * @example my-crm
+             */
+            responseChannel?: string;
+        };
+        V1CreateVoicemailBodyDto: {
+            /**
+             * Format: binary
+             * @description Audio file for the voicemail
+             */
+            file: string;
+            /**
+             * @description Star rating (1-5)
+             * @example 5
+             * @enum {string}
+             */
+            qualification: '1' | '2' | '3' | '4' | '5';
+            /**
+             * @description Spoken language used to improve audio transcription
+             * @example es
+             * @enum {string}
+             */
+            language: 'es' | 'en';
+            /** @description Reviewer email */
+            clientEmail?: string;
+            /** @description Reviewer phone */
+            clientPhone?: string;
+            /**
+             * @description Whether the review is anonymous
+             * @enum {string}
+             */
+            anonymous?: 'true' | 'false';
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel).
+             * @example my-crm
+             */
+            responseChannel?: string;
+        };
+        V1ShareWokuBodyDto: {
+            /** @description Single email address */
+            clientEmail?: string;
+            /** @description Array of email addresses */
+            clientEmails?: string[];
+        };
+        V1ApiKeyResultDto: {
+            /** @description The new company secret API key. The previous key is now invalid; store this value, it is not retrievable again. */
+            apiKey: string;
+        };
+        V1RevokeApiKeyResultDto: {
+            /**
+             * @description Always true once the key has been revoked.
+             * @example true
+             */
+            revoked: boolean;
+        };
+        V1CreateNpsBodyDto: {
+            /**
+             * @description NPS score 0-10 (0-6 detractor, 7-8 passive, 9-10 promoter)
+             * @example 9
+             */
+            score: number;
+            /**
+             * Format: ObjectId
+             * @description Optional NPS tool id. With it the capture is tool-specific; without it, company-level.
+             */
+            npsToolId?: string;
+            /**
+             * Format: email
+             * @description Respondent email. Omit for an anonymous capture.
+             */
+            clientEmail?: string;
+            /** @description Whether the submission is anonymous (no client email stored). */
+            anonymous?: boolean;
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the NPS.
+             * @example my-crm
+             */
+            responseChannel?: string;
+            /**
+             * @description Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.
+             * @example a1b2c3d4-...
+             */
+            dispatchToken?: string;
+        };
+        V1CreateNpsTextnoteBodyDto: {
+            /**
+             * @description Text feedback content
+             * @example El producto cumple mis expectativas.
+             */
+            description: string;
+        };
+        V1CreateCsatBodyDto: {
+            /**
+             * @description CSAT satisfaction score 1-5
+             * @example 4
+             */
+            score: number;
+            /**
+             * Format: ObjectId
+             * @description CSAT tool id (always required: CSAT tools are always custom)
+             */
+            csatToolId: string;
+            /**
+             * Format: email
+             * @description Respondent email. Omit for an anonymous capture.
+             */
+            clientEmail?: string;
+            /** @description Whether the submission is anonymous (no client email stored). */
+            anonymous?: boolean;
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the response.
+             * @example my-crm
+             */
+            responseChannel?: string;
+            /** @description Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted. */
+            dispatchToken?: string;
+        };
+        V1CreateCsatTextnoteBodyDto: {
+            /**
+             * @description Text feedback content
+             * @example El proceso fue muy facil.
+             */
+            description: string;
+        };
+        V1CreateCesBodyDto: {
+            /**
+             * @description CES effort score 1-5
+             * @example 4
+             */
+            score: number;
+            /**
+             * Format: ObjectId
+             * @description CES tool id (always required: CES tools are always custom)
+             */
+            cesToolId: string;
+            /**
+             * Format: email
+             * @description Respondent email. Omit for an anonymous capture.
+             */
+            clientEmail?: string;
+            /** @description Whether the submission is anonymous (no client email stored). */
+            anonymous?: boolean;
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the response.
+             * @example my-crm
+             */
+            responseChannel?: string;
+            /** @description Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted. */
+            dispatchToken?: string;
+        };
+        V1CreateCesTextnoteBodyDto: {
+            /**
+             * @description Text feedback content
+             * @example Resolver fue muy facil.
+             */
+            description: string;
+        };
+        V1CaptureAudioDto: {
+            /** @description Device-local URI of the recorded audio */
+            uri?: string;
+            /** @description Audio MIME type, e.g. audio/m4a */
+            mimeType?: string;
+            /** @description Duration in milliseconds */
+            durationMs?: number;
+        };
+        V1CaptureRespondentDto: {
+            /** @description Respondent email */
+            email?: string;
+            /** @description Respondent phone */
+            phone?: string;
+            /** @description Host-app external id (e.g. CRM id) */
+            externalId?: string;
+        };
+        V1CaptureBodyDto: {
+            /** @description Client-generated idempotency id */
+            id?: string;
+            /**
+             * @example woku
+             * @enum {string}
+             */
+            kind: 'woku' | 'nps' | 'csat' | 'ces';
+            /**
+             * @description Spoken language. Required when the capture includes an audio file.
+             * @enum {string}
+             */
+            language?: 'es' | 'en';
+            /** @description Target id: the wokuId for a woku capture, the (optional) npsToolId for an NPS capture, or the (required) csatToolId/cesToolId for a CSAT/CES capture (those tools are always custom). */
+            targetId?: string;
+            /**
+             * @description Woku star rating 1-5
+             * @example 5
+             */
+            rating?: number;
+            /**
+             * @description NPS score 0-10
+             * @example 9
+             */
+            score?: number;
+            /** @description Free-text comment */
+            comment?: string;
+            audio?: components['schemas']['V1CaptureAudioDto'];
+            respondent?: components['schemas']['V1CaptureRespondentDto'];
+        };
+        V1CreateNpsInvitationsBodyDto: {
+            /**
+             * @description Delivery channel for the invitations
+             * @example whatsapp
+             * @enum {string}
+             */
+            channel: 'email' | 'whatsapp';
+            /**
+             * @description Recipients: email addresses for the email channel, phone numbers (digits, country code included, e.g. 56912345678) for whatsapp
+             * @example [
+             *       "56912345678"
+             *     ]
+             */
+            recipients: string[];
+            /**
+             * @description Language of the invitation template
+             * @example es
+             * @enum {string}
+             */
+            language?: 'es' | 'en';
+            /**
+             * Format: ObjectId
+             * @description NPS tool to survey for. Omit to send the company-level NPS survey.
+             */
+            npsToolId?: string;
+        };
+        V1RejectedInvitationDto: {
+            /** @description Recipient as received in the request */
+            recipient: string;
+            /**
+             * @description Why the invitation was not dispatched
+             * @enum {string}
+             */
+            reason: 'invalid_recipient' | 'quarantined' | 'insufficient_credits_or_blocked' | 'send_failed';
+        };
+        V1InvitationsResultDto: {
+            /** @enum {string} */
+            channel: 'email' | 'whatsapp';
+            /** @description Recipients whose invitation was dispatched (or queued) */
+            accepted: string[];
+            /** @description Recipients whose invitation was not dispatched, with reason */
+            rejected: components['schemas']['V1RejectedInvitationDto'][];
+        };
+        V1CreateCsatInvitationsBodyDto: {
+            /**
+             * @description Delivery channel for the invitations
+             * @example whatsapp
+             * @enum {string}
+             */
+            channel: 'email' | 'whatsapp';
+            /**
+             * @description Recipients: email addresses for the email channel, phone numbers (digits, country code included, e.g. 56912345678) for whatsapp
+             * @example [
+             *       "56912345678"
+             *     ]
+             */
+            recipients: string[];
+            /**
+             * @description Language of the invitation template
+             * @example es
+             * @enum {string}
+             */
+            language?: 'es' | 'en';
+            /**
+             * Format: ObjectId
+             * @description CSAT tool to survey for (always required: always custom).
+             */
+            csatToolId: string;
+        };
+        V1CreateCesInvitationsBodyDto: {
+            /**
+             * @description Delivery channel for the invitations
+             * @example whatsapp
+             * @enum {string}
+             */
+            channel: 'email' | 'whatsapp';
+            /**
+             * @description Recipients: email addresses for the email channel, phone numbers (digits, country code included, e.g. 56912345678) for whatsapp
+             * @example [
+             *       "56912345678"
+             *     ]
+             */
+            recipients: string[];
+            /**
+             * @description Language of the invitation template
+             * @example es
+             * @enum {string}
+             */
+            language?: 'es' | 'en';
+            /**
+             * Format: ObjectId
+             * @description CES tool to survey for (always required: always custom).
+             */
+            cesToolId: string;
+        };
+        V1CreateInvitationsBodyDto: {
+            /**
+             * @description Delivery channel for the invitations
+             * @example whatsapp
+             * @enum {string}
+             */
+            channel: 'email' | 'whatsapp';
+            /**
+             * @description Recipients: email addresses for the email channel, phone numbers (digits, country code included, e.g. 56912345678) for whatsapp
+             * @example [
+             *       "56912345678"
+             *     ]
+             */
+            recipients: string[];
+            /**
+             * @description Language of the invitation template
+             * @example es
+             * @enum {string}
+             */
+            language?: 'es' | 'en';
+        };
+        V1CreateFormResponseBodyDto: {
+            /**
+             * @description Whether this response is anonymous
+             * @example false
+             */
+            anonymous: boolean;
+            /**
+             * @description Email of the respondent (required when the form identifies clients by email and the response is not anonymous)
+             * @example respondent@example.com
+             */
+            email?: string;
+            /**
+             * @description Phone of the respondent (required when the form identifies clients by phone and the response is not anonymous)
+             * @example +56912345678
+             */
+            phone?: string;
+            /**
+             * @description Answers keyed by field id
+             * @example {
+             *       "field-uuid-1": "John Doe",
+             *       "field-uuid-2": 5
+             *     }
+             */
+            answers: Record<string, never>;
+            /**
+             * @description Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the response.
+             * @example my-crm
+             */
+            responseChannel?: string;
+            /**
+             * @description Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.
+             * @example a1b2c3d4-...
+             */
+            dispatchToken?: string;
+        };
+        NpsToolLocalizedContentBodyDTO: {
+            /**
+             * @example en
+             * @enum {string}
+             */
+            locale: 'es' | 'en';
+            /**
+             * @description Translated NPS question for this locale.
+             * @example How likely are you to recommend us?
+             */
+            npsMessage: string;
+            /**
+             * @description Translated audience for this locale.
+             * @example customers
+             */
+            audienceType?: string;
+        };
+        CreateNpsToolBodyDTO: {
+            /**
+             * @description Tool name for identification.
+             * @example Post-Purchase Survey
+             */
+            name: string;
+            /**
+             * @description Public NPS question shown to respondents.
+             * @example How likely are you to recommend our service to a friend?
+             */
+            npsMessage: string;
+            /**
+             * @description Audience the survey targets.
+             * @example customers
+             */
+            audienceType?: string;
+            /**
+             * @description Locales the tool is available in (subset of es/en).
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /**
+             * @description Default locale used when none is requested.
+             * @example es
+             * @enum {string}
+             */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['NpsToolLocalizedContentBodyDTO'][];
+        };
+        UpdateNpsToolBodyDTO: {
+            name?: string;
+            npsMessage?: string;
+            audienceType?: string;
+            /**
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /** @enum {string} */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['NpsToolLocalizedContentBodyDTO'][];
+        };
+        CsatToolLocalizedContentBodyDTO: {
+            /**
+             * @example en
+             * @enum {string}
+             */
+            locale: 'es' | 'en';
+            /**
+             * @description Translated CSAT question for this locale.
+             * @example How satisfied are you with your purchase?
+             */
+            question: string;
+            /**
+             * @description Translated subject for this locale.
+             * @example your purchase
+             */
+            subject?: string;
+        };
+        CreateCsatToolBodyDTO: {
+            /**
+             * @description Tool name for identification.
+             * @example Post-Purchase CSAT
+             */
+            name: string;
+            /**
+             * @description Public CSAT question shown to respondents.
+             * @example How satisfied are you with your purchase?
+             */
+            question: string;
+            /**
+             * @description Static variable filling 'how satisfied are you with [subject]?'.
+             * @example your purchase
+             */
+            subject?: string;
+            /**
+             * @description Locales the tool is available in (subset of es/en).
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /**
+             * @description Default locale used when none is requested.
+             * @example es
+             * @enum {string}
+             */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['CsatToolLocalizedContentBodyDTO'][];
+        };
+        UpdateCsatToolBodyDTO: {
+            name?: string;
+            question?: string;
+            subject?: string;
+            /**
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /** @enum {string} */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['CsatToolLocalizedContentBodyDTO'][];
+        };
+        CesToolLocalizedContentBodyDTO: {
+            /**
+             * @example en
+             * @enum {string}
+             */
+            locale: 'es' | 'en';
+            /**
+             * @description Translated CES question for this locale.
+             * @example How easy was it to complete your purchase?
+             */
+            question: string;
+            /**
+             * @description Translated action for this locale.
+             * @example complete your purchase
+             */
+            action?: string;
+        };
+        CreateCesToolBodyDTO: {
+            /**
+             * @description Tool name for identification.
+             * @example Post-Purchase Effort
+             */
+            name: string;
+            /**
+             * @description Public effort question shown to respondents.
+             * @example How easy was it to complete your purchase?
+             */
+            question: string;
+            /**
+             * @description Static variable filling 'how easy was it to [action]?'.
+             * @example complete your purchase
+             */
+            action?: string;
+            /**
+             * @description Locales the tool is available in (subset of es/en).
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /**
+             * @description Default locale used when none is requested.
+             * @example es
+             * @enum {string}
+             */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['CesToolLocalizedContentBodyDTO'][];
+        };
+        UpdateCesToolBodyDTO: {
+            name?: string;
+            question?: string;
+            action?: string;
+            /**
+             * @example [
+             *       "es",
+             *       "en"
+             *     ]
+             */
+            availableLocales?: string[];
+            /** @enum {string} */
+            defaultLocale?: 'es' | 'en';
+            localizedContent?: components['schemas']['CesToolLocalizedContentBodyDTO'][];
+        };
+        UpdateTicketBodyDTO: {
+            title?: string;
+            /** @enum {string} */
+            severity?: 'high' | 'medium' | 'low';
+            aiSummary?: string;
+            aiCategory?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+/** The full generated schema map (advanced use / escape hatch). */
+type Schemas = components['schemas'];
+type CreateTrackerParams = Schemas['CreateExternalTrackerDefinitionDTO'];
+type UpdateTrackerParams = Schemas['UpdateExternalTrackerDefinitionDTO'];
+type SearchEntitiesByTrackersParams = Schemas['SearchEntitiesByTrackersDTO'];
+type AssignTrackerByNameParams = Schemas['AssignExternalTrackerByNameDTO'];
+type CreateNpsToolParams = Schemas['CreateNpsToolBodyDTO'];
+type UpdateNpsToolParams = Schemas['UpdateNpsToolBodyDTO'];
+type CreateCsatToolParams = Schemas['CreateCsatToolBodyDTO'];
+type UpdateCsatToolParams = Schemas['UpdateCsatToolBodyDTO'];
+type CreateCesToolParams = Schemas['CreateCesToolBodyDTO'];
+type UpdateCesToolParams = Schemas['UpdateCesToolBodyDTO'];
+type SendInvitationsParams = Schemas['V1CreateInvitationsBodyDto'];
+type SendNpsInvitationsParams = Schemas['V1CreateNpsInvitationsBodyDto'];
+type SendCsatInvitationsParams = Schemas['V1CreateCsatInvitationsBodyDto'];
+type SendCesInvitationsParams = Schemas['V1CreateCesInvitationsBodyDto'];
+type CreateWokuParams = Schemas['CreateWokuApiDto'];
+type UpdateWokuParams = Schemas['UpdateWokuBodyDTO'];
+type UpdateWokuSettingsParams = Schemas['UpdateWokuSettingsBodyDTO'];
+type MoveWokuParams = Schemas['MoveWokuBodyDTO'];
+type ShareWokuParams = Schemas['V1ShareWokuBodyDto'];
+type UpdateTicketParams = Schemas['UpdateTicketBodyDTO'];
+type CreateTicketDestinationParams = Schemas['CreateTicketDestinationDto'];
+type UpdateTicketDestinationParams = Schemas['UpdateTicketDestinationDto'];
+type CreateActionPlanGroupParams = Schemas['CreateActionPlanGroupDto'];
+type UpdateActionPlanGroupParams = Schemas['UpdateActionPlanGroupDto'];
+type SendActionPlanParams = Schemas['SendActionPlanDto'];
+type CreateActionPlanTaskParams = Schemas['CreateActionPlanTaskDto'];
+type UpdateActionPlanTaskParams = Schemas['UpdateActionPlanTaskDto'];
+type ReorderActionPlanTasksParams = Schemas['ReorderActionPlanTasksDto'];
+type PostPlanReplyParams = Schemas['PostPlanReplyBodyDTO'];
+
+/**
+ * Response models. The `/v1` controllers return curated, projected documents;
+ * these mirror those shapes. Where the server returns an opaque document the
+ * type is {@link WokuRecord} (a permissive object) rather than a false promise
+ * of exhaustive typing.
+ */
+/** A JSON object the SDK does not exhaustively type. */
+type WokuRecord = Record<string, unknown>;
+type FeedbackType = 'recognition' | 'improvement';
+type Severity = 'high' | 'medium' | 'low';
+type Locale = 'es' | 'en';
+type Channel = 'email' | 'whatsapp';
+/** External tracker definition (curated). */
+interface Tracker {
+    _id: string;
+    name: string;
+    system: string;
+    description?: string;
+    active?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/** Result of a VoC-entity search by tracker filters. */
+interface EntitiesByTrackers {
+    entityType: string;
+    total: number;
+    matches: WokuRecord[];
+}
+interface ToolLocalizedContent {
+    locale: string;
+    [key: string]: unknown;
+}
+/** NPS tool definition (curated, no internal fields). */
+interface NpsTool {
+    _id: string;
+    name: string;
+    npsMessage: string;
+    audienceType?: string;
+    availableLocales?: string[];
+    defaultLocale?: string;
+    localizedContent?: ToolLocalizedContent[];
+    createdAt?: string;
+}
+/** CSAT tool definition (curated). */
+interface CsatTool {
+    _id: string;
+    name: string;
+    question: string;
+    subject?: string;
+    availableLocales?: string[];
+    defaultLocale?: string;
+    localizedContent?: ToolLocalizedContent[];
+    createdAt?: string;
+}
+/** CES tool definition (curated). */
+interface CesTool {
+    _id: string;
+    name: string;
+    question: string;
+    action?: string;
+    availableLocales?: string[];
+    defaultLocale?: string;
+    localizedContent?: ToolLocalizedContent[];
+    createdAt?: string;
+}
+/** Acknowledgement returned by tool deletes. */
+interface DeletedResult {
+    deleted: true;
+    id: string;
+}
+/** Per-recipient outcome of a survey send. */
+interface InvitationsResult {
+    accepted: number;
+    rejected: number;
+    rejectedRecipients?: Array<{
+        recipient?: string;
+        reason?: string;
+    }>;
+    [key: string]: unknown;
+}
+/** Support ticket (curated allow-list). */
+interface Ticket {
+    _id: string;
+    code?: string;
+    title: string;
+    severity: Severity;
+    destinationId?: string;
+    origin?: WokuRecord;
+    score?: WokuRecord;
+    aiSummary?: string;
+    aiCategory?: string;
+    sentiment?: string;
+    client?: WokuRecord;
+    customerComment?: WokuRecord;
+    timeline?: WokuRecord[];
+    createdAt?: string;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+/** Ticket aggregate counts. */
+interface TicketStats {
+    byTool: Record<string, number>;
+    byDestination: Array<{
+        destinationId: string;
+        countInPeriod: number;
+        countTotal: number;
+        severity: {
+            high: number;
+            medium: number;
+            low: number;
+        };
+    }>;
+}
+/** One outbound invitation dispatch (delivery view, no recipient PII). */
+interface Dispatch {
+    _id: string;
+    channel: Channel;
+    source: string | null;
+    status: 'invited' | 'partially_responded' | 'responded' | 'failed';
+    targets: Array<{
+        responseType: string;
+        targetId: string;
+        respondedAt: string | null;
+    }>;
+    attempts: Array<{
+        channel: Channel;
+        attemptIndex: number;
+        sentAt: string;
+        status: 'sent' | 'delivered' | 'bounced' | 'failed';
+    }>;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response-rate metrics over the dispatches. */
+interface DispatchStats {
+    total: number;
+    delivered: number;
+    byStatus: {
+        invited: number;
+        partially_responded: number;
+        responded: number;
+        failed: number;
+    };
+    responseRate: number | null;
+}
+/**
+ * A woku (feedback collection tool), curated. Named `WokuResource` so it does
+ * not collide with the `Woku` client class at the package root.
+ */
+interface WokuResource {
+    _id: string;
+    description: string;
+    folderId?: string | null;
+    closed?: boolean;
+    reviewsDisabled?: boolean;
+    anonymousDisabled?: boolean;
+    onlyOneReviewPerClient?: boolean;
+    availableLocales?: string[];
+    defaultLocale?: string;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+/** Sanitized ticket-destination connectivity test result. */
+interface TestConnectionResult {
+    ok: boolean;
+    status?: number;
+    message: string;
+}
+/** Rotated secret key. */
+interface ApiKeyResult {
+    secretKey: string;
+    [key: string]: unknown;
+}
+
+/** A VoC entity type that can carry tracker values. */
+type TrackerEntityType = 'nps' | 'csat' | 'ces' | 'form' | 'flow';
+interface ListTrackersParams {
+    includeInactive?: boolean;
+    includeUsage?: boolean;
+    page?: number;
+    limit?: number;
+}
+interface SearchWokusByTrackerParams {
+    name: string;
+    value: string;
+    page?: number;
+    limit?: number;
+}
+/** Manage external tracker definitions (`/v1/external-trackers`). */
+declare class Trackers {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** List the company tracker definitions (paginated). */
+    list(params?: ListTrackersParams, opts?: RequestOptions): Promise<Page<Tracker>>;
+    /** Create a tracker definition (idempotent). */
+    create(body: CreateTrackerParams, opts?: RequestOptions): Promise<Tracker>;
+    /** Get one tracker definition. */
+    get(id: string, opts?: RequestOptions): Promise<Tracker>;
+    /** Update a tracker definition. */
+    update(id: string, body: UpdateTrackerParams, opts?: RequestOptions): Promise<Tracker>;
+    /** Activate a tracker definition. */
+    activate(id: string, opts?: RequestOptions): Promise<Tracker>;
+    /** Deactivate a tracker definition. */
+    deactivate(id: string, opts?: RequestOptions): Promise<Tracker>;
+    /** Search VoC entities whose trackers match every filter (AND). */
+    searchEntities(body: SearchEntitiesByTrackersParams, opts?: RequestOptions): Promise<EntitiesByTrackers>;
+    /** List the tracker values assigned to a woku. */
+    listWokuValues(wokuId: string, opts?: RequestOptions): Promise<WokuRecord[]>;
+    /** Assign (upsert) a tracker value to a woku by tracker name. */
+    assignToWoku(wokuId: string, body: AssignTrackerByNameParams, opts?: RequestOptions): Promise<WokuRecord>;
+    /** Remove a tracker value from a woku by tracker name. */
+    removeFromWoku(wokuId: string, trackerName: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /** Search wokus by an exact `(tracker name, value)` pair (paginated). */
+    searchWokus(params: SearchWokusByTrackerParams, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    /** List the tracker values assigned to a VoC entity (nps/csat/ces/form/flow). */
+    listEntityValues(entityType: TrackerEntityType, id: string, opts?: RequestOptions): Promise<WokuRecord[]>;
+    /** Assign (upsert) a tracker value to a VoC entity by tracker name. */
+    assignToEntity(entityType: TrackerEntityType, id: string, body: AssignTrackerByNameParams, opts?: RequestOptions): Promise<WokuRecord>;
+    /** Remove a tracker value from a VoC entity by tracker name. */
+    removeFromEntity(entityType: TrackerEntityType, id: string, trackerName: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/** Manage NPS tool definitions (`/v1/nps-tools`). */
+declare class NpsTools {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<NpsTool>>;
+    create(body: CreateNpsToolParams, opts?: RequestOptions): Promise<NpsTool>;
+    get(id: string, opts?: RequestOptions): Promise<NpsTool>;
+    update(id: string, body: UpdateNpsToolParams, opts?: RequestOptions): Promise<NpsTool>;
+    delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
+}
+/** Manage CSAT tool definitions (`/v1/csat-tools`). */
+declare class CsatTools {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<CsatTool>>;
+    create(body: CreateCsatToolParams, opts?: RequestOptions): Promise<CsatTool>;
+    get(id: string, opts?: RequestOptions): Promise<CsatTool>;
+    update(id: string, body: UpdateCsatToolParams, opts?: RequestOptions): Promise<CsatTool>;
+    delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
+}
+/** Manage CES tool definitions (`/v1/ces-tools`). */
+declare class CesTools {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<CesTool>>;
+    create(body: CreateCesToolParams, opts?: RequestOptions): Promise<CesTool>;
+    get(id: string, opts?: RequestOptions): Promise<CesTool>;
+    update(id: string, body: UpdateCesToolParams, opts?: RequestOptions): Promise<CesTool>;
+    delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
+}
+
+interface ListResponsesParams {
+    page?: number;
+    limit?: number;
+    [key: string]: unknown;
+}
+/** Send the NPS survey and read its responses (`/v1/nps`). */
+declare class Nps {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** Send the NPS survey by email or WhatsApp (idempotent). */
+    sendInvitations(body: SendNpsInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
+    /** List NPS responses (paginated). */
+    listResponses(params?: ListResponsesParams, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    /** Get one NPS response. */
+    getResponse(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+/** Send the CSAT survey and read its responses (`/v1/csat`). */
+declare class Csat {
+    private readonly client;
+    constructor(client: WokuClient);
+    sendInvitations(body: SendCsatInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
+    listResponses(params?: ListResponsesParams, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    getResponse(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+/** Send the CES survey and read its responses (`/v1/ces`). */
+declare class Ces {
+    private readonly client;
+    constructor(client: WokuClient);
+    sendInvitations(body: SendCesInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
+    listResponses(params?: ListResponsesParams, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    getResponse(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/** Manage wokus (feedback collection tools) — `/v1/wokus`. */
+declare class Wokus {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<WokuResource>>;
+    create(body: CreateWokuParams, opts?: RequestOptions): Promise<WokuResource>;
+    /** Get one woku with aggregated review stats. */
+    get(id: string, opts?: RequestOptions): Promise<WokuResource>;
+    update(id: string, body: UpdateWokuParams, opts?: RequestOptions): Promise<WokuResource>;
+    delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
+    /** Apply the boolean settings idempotently (closed/reviewsDisabled/...). */
+    updateSettings(id: string, body: UpdateWokuSettingsParams, opts?: RequestOptions): Promise<WokuResource>;
+    /** Move the woku into a folder, or to the root with `{ folderId: null }`. */
+    move(id: string, body: MoveWokuParams, opts?: RequestOptions): Promise<WokuResource>;
+    /** List the reviews of a woku (paginated). */
+    listReviews(id: string, params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    /** Send a woku review invitation by email or WhatsApp (idempotent). */
+    sendInvitations(id: string, body: SendInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
+    /** Share a woku review link by email. */
+    share(id: string, body: ShareWokuParams, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/** Read forms and send form invitations (`/v1/forms`). */
+declare class Forms {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /** List the responses of a form (paginated). */
+    listResponses(id: string, params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    /** Send a form by email or WhatsApp (idempotent). */
+    sendInvitations(id: string, body: SendInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
+}
+
+/** Read data flows (`/v1/flows`). */
+declare class Flows {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+interface ListActionPlansParams {
+    groupId?: string;
+    status?: string;
+    source?: string;
+    priority?: string;
+    search?: string;
+    from?: string;
+    to?: string;
+    page?: number;
+    limit?: number;
+}
+/** Read and drive action plans, incl. the managed kanban (`/v1/action-plans`). */
+declare class ActionPlans {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: ListActionPlansParams, opts?: RequestOptions): Promise<Page<WokuRecord>>;
+    get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /** The plan timeline (events, oldest first). */
+    events(id: string, opts?: RequestOptions): Promise<WokuRecord[]>;
+    /** The plan AI conversation (read-only). */
+    getConversation(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /**
+     * Reply to the plan AI agent. Each reply is a paid AI turn (`confirm:true` is
+     * sent automatically); the reply is composed asynchronously, so poll
+     * {@link getConversation} until `busy` is false.
+     */
+    reply(id: string, text: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /** Send an approved plan to a destination (jira/monday/clickup/notion/internal). */
+    send(id: string, body: SendActionPlanParams, opts?: RequestOptions): Promise<WokuRecord>;
+    createTask(id: string, body: CreateActionPlanTaskParams, opts?: RequestOptions): Promise<WokuRecord>;
+    updateTask(id: string, taskId: string, body: UpdateActionPlanTaskParams, opts?: RequestOptions): Promise<WokuRecord>;
+    reorderTasks(id: string, body: ReorderActionPlanTasksParams, opts?: RequestOptions): Promise<WokuRecord>;
+    deleteTask(id: string, taskId: string, opts?: RequestOptions): Promise<WokuRecord>;
+    approve(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    reopen(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    cancel(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    complete(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    resume(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    private status;
+}
+/** Manage action-plan groups (`/v1/action-plan-groups`). */
+declare class ActionPlanGroups {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: {
+        search?: string;
+    }, opts?: RequestOptions): Promise<WokuRecord[]>;
+    /** Get one group with its embedded stats. */
+    get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    create(body: CreateActionPlanGroupParams, opts?: RequestOptions): Promise<WokuRecord>;
+    update(id: string, body: UpdateActionPlanGroupParams, opts?: RequestOptions): Promise<WokuRecord>;
+    setEnabled(id: string, enabled: boolean, opts?: RequestOptions): Promise<WokuRecord>;
+    delete(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+interface ListTicketsParams {
+    tool?: 'woku' | 'nps' | 'form' | 'csat' | 'ces';
+    severity?: Severity;
+    search?: string;
+    destinationId?: string;
+    createdFrom?: string;
+    createdTo?: string;
+    page?: number;
+    limit?: number;
+}
+interface TicketStatsParams {
+    destinationId?: string;
+    createdFrom?: string;
+    createdTo?: string;
+}
+/** Read and curate support tickets (`/v1/tickets`). Tickets are AI-generated. */
+declare class Tickets {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(params?: ListTicketsParams, opts?: RequestOptions): Promise<Page<Ticket>>;
+    /** Aggregate counts by tool and by SAC destination. */
+    stats(params?: TicketStatsParams, opts?: RequestOptions): Promise<TicketStats>;
+    get(id: string, opts?: RequestOptions): Promise<Ticket>;
+    update(id: string, body: UpdateTicketParams, opts?: RequestOptions): Promise<Ticket>;
+}
+/** Manage SAC ticket destinations (`/v1/ticket-destinations`). */
+declare class TicketDestinations {
+    private readonly client;
+    constructor(client: WokuClient);
+    list(opts?: RequestOptions): Promise<WokuRecord[]>;
+    get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    create(body: CreateTicketDestinationParams, opts?: RequestOptions): Promise<WokuRecord>;
+    update(id: string, body: UpdateTicketDestinationParams, opts?: RequestOptions): Promise<WokuRecord>;
+    delete(id: string, opts?: RequestOptions): Promise<WokuRecord>;
+    /**
+     * Send a real connectivity test to a saved destination. Requires
+     * `confirm: true` (the test reaches the live destination).
+     */
+    test(id: string, opts?: RequestOptions): Promise<TestConnectionResult>;
+}
+
+interface ListDispatchesParams {
+    channel?: Channel;
+    responseType?: 'woku' | 'nps' | 'form' | 'client-form' | 'csat' | 'ces';
+    targetId?: string;
+    status?: 'invited' | 'partially_responded' | 'responded' | 'failed';
+    createdFrom?: string;
+    createdTo?: string;
+    page?: number;
+    limit?: number;
+}
+interface DispatchStatsParams {
+    channel?: Channel;
+    responseType?: string;
+    targetId?: string;
+    createdFrom?: string;
+    createdTo?: string;
+}
+/** Delivery tracking over invitation dispatches (`/v1/dispatches`). */
+declare class Dispatches {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** List the invitation dispatches (delivery status, no recipient PII). */
+    list(params?: ListDispatchesParams, opts?: RequestOptions): Promise<Page<Dispatch>>;
+    /** Response-rate metrics over the dispatches. */
+    stats(params?: DispatchStatsParams, opts?: RequestOptions): Promise<DispatchStats>;
+}
+
+/** Read NPS reports (`/v1/reports`). */
+declare class Reports {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** Company-level NPS report. */
+    companyNps(params?: Record<string, unknown>, opts?: RequestOptions): Promise<WokuRecord>;
+    /** NPS report for one tool. */
+    npsTool(npsToolId: string, params?: Record<string, unknown>, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/** The caller company and its API key (`/v1/companies/me`). */
+declare class Company {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** Get the caller company. */
+    me(opts?: RequestOptions): Promise<WokuRecord>;
+    /** Rotate the secret key. The returned key replaces the current one. */
+    rotateKey(opts?: RequestOptions): Promise<ApiKeyResult>;
+    /** Revoke the secret key (all subsequent requests will be unauthorized). */
+    revokeKey(opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/** Check respondent quarantine status (`/v1/quarantines`). */
+declare class Quarantines {
+    private readonly client;
+    constructor(client: WokuClient);
+    /** Check whether a contact is quarantined. */
+    check(params: {
+        email?: string;
+        phone?: string | number;
+    }, opts?: RequestOptions): Promise<WokuRecord>;
+}
+
+/**
+ * Entry point to the Woku management API.
+ *
+ * ```ts
+ * const woku = new Woku({ apiKey: process.env.WOKU_API_KEY });
+ * const tracker = await woku.trackers.create({ name: 'Store', system: 'retail' });
+ * for await (const ticket of await woku.tickets.list({ severity: 'high' })) {
+ *   console.log(ticket.title);
+ * }
+ * ```
+ */
+declare class Woku {
+    /** The underlying transport (advanced use). */
+    readonly client: WokuClient;
+    readonly trackers: Trackers;
+    readonly npsTools: NpsTools;
+    readonly csatTools: CsatTools;
+    readonly cesTools: CesTools;
+    readonly nps: Nps;
+    readonly csat: Csat;
+    readonly ces: Ces;
+    readonly wokus: Wokus;
+    readonly forms: Forms;
+    readonly flows: Flows;
+    readonly actionPlans: ActionPlans;
+    readonly actionPlanGroups: ActionPlanGroups;
+    readonly tickets: Tickets;
+    readonly ticketDestinations: TicketDestinations;
+    readonly dispatches: Dispatches;
+    readonly reports: Reports;
+    readonly company: Company;
+    readonly quarantines: Quarantines;
+    constructor(options?: WokuClientOptions | string);
+}
+
+/**
+ * Error hierarchy for the Woku SDK. Every failure is a {@link WokuError};
+ * transport failures are {@link WokuConnectionError} and HTTP error responses
+ * are {@link WokuAPIError} subclasses keyed by status. API errors carry the
+ * server `requestId` (echo it when reporting an issue) and the parsed body.
+ */
+/** Parsed error body shape the API returns (NestJS exception filter). */
+interface WokuErrorBody {
+    statusCode?: number;
+    message?: string | string[];
+    error?: string;
+    code?: string;
+    [key: string]: unknown;
+}
+/** Base class for every SDK error. */
+declare class WokuError extends Error {
+    /** Stable, machine-readable code (e.g. `not_found`, `rate_limited`). */
+    readonly code?: string;
+    constructor(message: string, options?: {
+        code?: string;
+        cause?: unknown;
+    });
+}
+/**
+ * The request never got a usable HTTP response: DNS/TCP failure, TLS error,
+ * timeout or an aborted signal. Safe to retry (the SDK already retries these
+ * up to `maxRetries`).
+ */
+declare class WokuConnectionError extends WokuError {
+    constructor(message: string, options?: {
+        cause?: unknown;
+        code?: string;
+    });
+}
+/** The request was aborted (per-call `signal` or the configured timeout). */
+declare class WokuTimeoutError extends WokuConnectionError {
+    constructor(message?: string);
+}
+/** The server returned a non-2xx HTTP status. */
+declare class WokuAPIError extends WokuError {
+    /** HTTP status code. */
+    readonly status: number;
+    /** Server correlation id, if the response carried one. */
+    readonly requestId?: string;
+    /** Parsed response body (or the raw text when it was not JSON). */
+    readonly body: WokuErrorBody | string | undefined;
+    /**
+     * Seconds to wait before retrying, from the `Retry-After` response header
+     * (or a `retryAfter` body field as a fallback), when the server sent one.
+     */
+    readonly retryAfterSeconds?: number;
+    constructor(status: number, body: WokuErrorBody | string | undefined, message: string, requestId?: string, code?: string, retryAfterSeconds?: number);
+    /** Build the most specific error subclass for a status + body. */
+    static from(status: number, body: WokuErrorBody | string | undefined, requestId?: string, retryAfterSeconds?: number): WokuAPIError;
+}
+/** 400 — malformed request or failed validation. */
+declare class BadRequestError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 401 — missing or invalid API key. */
+declare class AuthenticationError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 403 — the key is valid but not allowed to access the resource. */
+declare class PermissionDeniedError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 404 — the resource does not exist (or is not visible to this company). */
+declare class NotFoundError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 409 — the request conflicts with the resource state. */
+declare class ConflictError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 422 — semantically invalid request. */
+declare class UnprocessableEntityError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 429 — rate limited. `retryAfterSeconds` mirrors the `Retry-After` header. */
+declare class RateLimitError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+/** 5xx — the server failed to process the request. */
+declare class InternalServerError extends WokuAPIError {
+    constructor(...args: ConstructorParameters<typeof WokuAPIError>);
+}
+
+export { type ApiKeyResult, type AssignTrackerByNameParams, AuthenticationError, BadRequestError, type CesTool, type Channel, ConflictError, type CreateActionPlanGroupParams, type CreateActionPlanTaskParams, type CreateCesToolParams, type CreateCsatToolParams, type CreateNpsToolParams, type CreateTicketDestinationParams, type CreateTrackerParams, type CreateWokuParams, type CsatTool, type DeletedResult, type Dispatch, type DispatchStats, type EntitiesByTrackers, type FeedbackType, type FetchLike, InternalServerError, type InvitationsResult, type Locale, type MoveWokuParams, NotFoundError, type NpsTool, Page, type PageResponse, PermissionDeniedError, type PostPlanReplyParams, RateLimitError, type ReorderActionPlanTasksParams, type RequestOptions, type Schemas, type SearchEntitiesByTrackersParams, type SendActionPlanParams, type SendCesInvitationsParams, type SendCsatInvitationsParams, type SendInvitationsParams, type SendNpsInvitationsParams, type Severity, type ShareWokuParams, type TestConnectionResult, type Ticket, type TicketStats, type Tracker, UnprocessableEntityError, type UpdateActionPlanGroupParams, type UpdateActionPlanTaskParams, type UpdateCesToolParams, type UpdateCsatToolParams, type UpdateNpsToolParams, type UpdateTicketDestinationParams, type UpdateTicketParams, type UpdateTrackerParams, type UpdateWokuParams, type UpdateWokuSettingsParams, Woku, WokuAPIError, WokuClient, type WokuClientOptions, WokuConnectionError, WokuError, type WokuErrorBody, type WokuRecord, type WokuResource, WokuTimeoutError };