@zavudev/sdk 0.56.0 → 0.58.0

package/resources/invitations/webhook.mjs

@@ -0,0 +1,57 @@
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+export class Webhook extends APIResource {
+    /**
+     * Get project webhook
+     *
+     * The project webhook for the project behind the API key. `webhook` is null when
+     * none is configured. The secret is never returned here.
+     *
+     * `GET /v1/invitations/webhook`
+     */
+    retrieve(options) {
+        return this._client.get('/v1/invitations/webhook', options);
+    }
+    /**
+     * Configure project webhook
+     *
+     * Create or replace the project webhook for the project behind the API key, and
+     * activate it. The response carries the signing `secret`; an existing secret is
+     * kept.
+     *
+     * This is where `invitation.status_changed` is delivered. Events are scoped to
+     * this project: when you onboard clients in sub-accounts, call this with each
+     * sub-account's API key.
+     *
+     * `POST /v1/invitations/webhook`
+     */
+    configure(body, options) {
+        return this._client.post('/v1/invitations/webhook', { body, ...options });
+    }
+    /**
+     * Update project webhook
+     *
+     * Change the URL, the events, or whether the webhook is active. The webhook must
+     * already exist.
+     *
+     * `PATCH /v1/invitations/webhook`
+     */
+    update(body = {}, options) {
+        return this._client.patch('/v1/invitations/webhook', { body, ...options });
+    }
+    /**
+     * Remove project webhook
+     *
+     * Remove the project webhook and its secret. Project events stop being delivered.
+     *
+     * `DELETE /v1/invitations/webhook`
+     */
+    delete(options) {
+        return this._client.delete('/v1/invitations/webhook', {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=webhook.mjs.map

package/resources/invitations/webhook.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.mjs","sourceRoot":"","sources":["../../src/resources/invitations/webhook.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAE7F,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAItD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAA4B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,yBAAyB,EAAE;YACpD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/invitations.d.mts

@@ -1,215 +1,68 @@
 import { APIResource } from "../core/resource.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
-import { Cursor, type CursorParams, PagePromise } from "../core/pagination.mjs";
+import { Cursor, PagePromise } from "../core/pagination.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
+import type * as T from "../types.mjs";
+import * as WebhookAPI from "./invitations/webhook.mjs";
+import { Webhook, type WebhookRetrieveResponse, type ProjectWebhook, type WebhookConfigureParams, type WebhookConfigureResponse, type ProjectWebhookEvent, type WebhookUpdateParams, type WebhookUpdateResponse } from "./invitations/webhook.mjs";
 export declare class Invitations extends APIResource {
+    webhook: WebhookAPI.Webhook;
     /**
+     * Create invitation
+     *
      * Create a partner invitation link for a client to connect a Meta channel. The
      * client opens the returned `url` and authorizes with Meta; the resulting sender
      * is created in your project when they finish, and the invitation transitions to
      * `completed`.
      *
      * `connectionType` picks the channel:
-     *
      * - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
      *   Business Account.
      * - `messenger`: the client picks a Facebook Page they administer; its Messenger
      *   inbox (including Marketplace chats) is routed to Zavu.
      *
-     * One invitation connects one channel — create one per channel to onboard a client
-     * on several. `phoneNumberId` and `allowedPhoneCountries` apply to `whatsapp_waba`
-     * only.
+     * One invitation connects one channel — create one per channel to onboard a
+     * client on several. `phoneNumberId` and `allowedPhoneCountries` apply to
+     * `whatsapp_waba` only.
      *
-     * @example
-     * ```ts
-     * const invitation = await client.invitations.create({
-     *   clientName: 'Acme Corp',
-     * });
-     * ```
+     * `POST /v1/invitations`
      */
     create(body?: InvitationCreateParams | null | undefined, options?: RequestOptions): APIPromise<InvitationCreateResponse>;
     /**
      * Get invitation
      *
-     * @example
-     * ```ts
-     * const invitation = await client.invitations.retrieve(
-     *   'invitationId',
-     * );
-     * ```
+     * `GET /v1/invitations/{invitationId}`
      */
     retrieve(invitationID: string, options?: RequestOptions): APIPromise<InvitationRetrieveResponse>;
     /**
+     * List invitations
+     *
      * List partner invitations for this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const invitation of client.invitations.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/invitations`
      */
     list(query?: InvitationListParams | null | undefined, options?: RequestOptions): PagePromise<InvitationsCursor, Invitation>;
     /**
+     * Cancel invitation
+     *
      * Cancel an active invitation. The client will no longer be able to use the
      * invitation link.
      *
-     * @example
-     * ```ts
-     * const response = await client.invitations.cancel(
-     *   'invitationId',
-     * );
-     * ```
+     * `POST /v1/invitations/{invitationId}/cancel`
      */
     cancel(invitationID: string, options?: RequestOptions): APIPromise<InvitationCancelResponse>;
 }
-export type InvitationsCursor = Cursor<Invitation>;
-export interface Invitation {
-    id: string;
-    /**
-     * Unique invitation token.
-     */
-    token: string;
-    createdAt: string;
-    expiresAt: string;
-    /**
-     * Current status of the partner invitation.
-     *
-     * `failed` means the client started the connection and it did not finish (they
-     * cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
-     * invitation is still usable: the same link can be retried, and it moves back to
-     * `in_progress` when the client tries again.
-     */
-    status: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
-    updatedAt: string;
-    /**
-     * Full URL to share with the client.
-     */
-    url: string;
-    clientEmail?: string | null;
-    clientName?: string | null;
-    clientPhone?: string | null;
-    completedAt?: string | null;
-    /**
-     * The account the client linked, populated once the invitation is `completed`.
-     * Null before that. Use it to show the partner what was connected without fetching
-     * the sender.
-     */
-    connectedAccount?: Invitation.ConnectedAccount | null;
-    /**
-     * Which Meta channel the client connects: `whatsapp_waba` (official WhatsApp Cloud
-     * API via embedded signup) or `messenger` (a Facebook Page's Messenger inbox,
-     * including Marketplace chats).
-     */
-    connectionType?: 'whatsapp_waba' | 'messenger';
-    failedAt?: string | null;
-    /**
-     * Stable code for why the last attempt failed, present when `status` is `failed`.
-     * Values include `fb_cancelled` (client closed Meta's dialog), `fb_not_authorized`
-     * (permission denied), `signup_abandoned` (started but never finished),
-     * `meta_no_pages` (the client administers no Facebook Page), and `internal_error`.
-     * Treat unknown codes as a generic failure.
-     */
-    failureReason?: string | null;
-    /**
-     * ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null
-     * for `messenger` invitations.
-     */
-    phoneNumberId?: string | null;
-    /**
-     * ID of the sender created when invitation is completed.
-     */
-    senderId?: string | null;
-    startedAt?: string | null;
-    viewedAt?: string | null;
-}
+export type InvitationsCursor = Cursor<T.Invitation>;
+export type Invitation = T.Invitation;
 export declare namespace Invitation {
-    /**
-     * The account the client linked, populated once the invitation is `completed`.
-     * Null before that. Use it to show the partner what was connected without fetching
-     * the sender.
-     */
-    interface ConnectedAccount {
-        /**
-         * Provider-side identifier: the WhatsApp phone number ID, or the Facebook Page ID.
-         */
-        id: string;
-        channel: 'whatsapp' | 'messenger';
-        /**
-         * Display name of the connected account: the WhatsApp verified name, or the
-         * Facebook Page name.
-         */
-        name?: string | null;
-    }
-}
-export interface InvitationCreateResponse {
-    invitation: Invitation;
-}
-export interface InvitationRetrieveResponse {
-    invitation: Invitation;
-}
-export interface InvitationCancelResponse {
-    invitation: Invitation;
-}
-export interface InvitationCreateParams {
-    /**
-     * ISO country codes for allowed phone numbers. Only valid when `connectionType` is
-     * `whatsapp_waba` — sending it with `messenger` returns 400.
-     */
-    allowedPhoneCountries?: Array<string>;
-    /**
-     * Email of the client being invited.
-     */
-    clientEmail?: string;
-    /**
-     * Name of the client being invited.
-     */
-    clientName?: string;
-    /**
-     * Phone number of the client in E.164 format.
-     */
-    clientPhone?: string;
-    /**
-     * Which Meta channel the client connects, and how.
-     *
-     * - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
-     *   Business Account. Accepts `phoneNumberId` and `allowedPhoneCountries`.
-     * - `messenger`: the client authorizes with Facebook and picks a Facebook Page
-     *   they administer. The Page's Messenger inbox — including Marketplace chats — is
-     *   routed to Zavu. They must be an admin of at least one Page. A Page can only be
-     *   connected to one Zavu project at a time: if the client picks a Page that
-     *   another project already connected, the newer connection wins and the older one
-     *   is disconnected.
-     *
-     * One invitation connects one channel. To onboard a client on several channels,
-     * create one invitation per channel; each completes into its own sender.
-     */
-    connectionType?: 'whatsapp_waba' | 'messenger';
-    /**
-     * Number of days until the invitation expires.
-     */
-    expiresInDays?: number;
-    /**
-     * ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
-     * the client will use this number instead of their own. Only valid when
-     * `connectionType` is `whatsapp_waba` — sending it with `messenger` returns 400,
-     * since a Facebook Page has no phone number.
-     */
-    phoneNumberId?: string;
-}
-export interface InvitationListParams extends CursorParams {
-    /**
-     * Current status of the partner invitation.
-     *
-     * `failed` means the client started the connection and it did not finish (they
-     * cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
-     * invitation is still usable: the same link can be retried, and it moves back to
-     * `in_progress` when the client tries again.
-     */
-    status?: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
+    type ConnectedAccount = T.InvitationConnectedAccount;
 }
+export type InvitationCreateResponse = T.InvitationResponse;
+export type InvitationRetrieveResponse = T.InvitationResponse;
+export type InvitationCancelResponse = T.InvitationResponse;
+export type InvitationCreateParams = T.InvitationsCreateParams;
+export type InvitationListParams = T.InvitationsListParams;
 export declare namespace Invitations {
-    export { type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, };
+    export { type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, Webhook as Webhook, type WebhookRetrieveResponse as WebhookRetrieveResponse, type ProjectWebhook as ProjectWebhook, type WebhookConfigureParams as WebhookConfigureParams, type WebhookConfigureResponse as WebhookConfigureResponse, type ProjectWebhookEvent as ProjectWebhookEvent, type WebhookUpdateParams as WebhookUpdateParams, type WebhookUpdateResponse as WebhookUpdateResponse, };
 }
 //# sourceMappingURL=invitations.d.mts.map

package/resources/invitations.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"invitations.d.mts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,+BAA2B;AAC5E,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC;IAI7C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAEnD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAErF,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;QAElC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;CACvF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"invitations.d.mts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,+BAA2B;AACzD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,OAAO,KAAK,KAAK,CAAC,qBAAiB;AACnC,OAAO,KAAK,UAAU,kCAA8B;AACpD,OAAO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC3B,kCAA8B;AAE/B,qBAAa,WAAY,SAAQ,WAAW;IAC1C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC;IAI7C;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;AACtC,yBAAiB,UAAU,CAAC;IAC1B,KAAY,gBAAgB,GAAG,CAAC,CAAC,0BAA0B,CAAC;CAC7D;AAED,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE5D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE9D,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE5D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,uBAAuB,CAAC;AAE/D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,qBAAqB,CAAC;AAE3D,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,OAAO,IAAI,OAAO,EAClB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/invitations.d.ts

@@ -1,215 +1,68 @@
 import { APIResource } from "../core/resource.js";
 import { APIPromise } from "../core/api-promise.js";
-import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
+import { Cursor, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
+import type * as T from "../types.js";
+import * as WebhookAPI from "./invitations/webhook.js";
+import { Webhook, type WebhookRetrieveResponse, type ProjectWebhook, type WebhookConfigureParams, type WebhookConfigureResponse, type ProjectWebhookEvent, type WebhookUpdateParams, type WebhookUpdateResponse } from "./invitations/webhook.js";
 export declare class Invitations extends APIResource {
+    webhook: WebhookAPI.Webhook;
     /**
+     * Create invitation
+     *
      * Create a partner invitation link for a client to connect a Meta channel. The
      * client opens the returned `url` and authorizes with Meta; the resulting sender
      * is created in your project when they finish, and the invitation transitions to
      * `completed`.
      *
      * `connectionType` picks the channel:
-     *
      * - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
      *   Business Account.
      * - `messenger`: the client picks a Facebook Page they administer; its Messenger
      *   inbox (including Marketplace chats) is routed to Zavu.
      *
-     * One invitation connects one channel — create one per channel to onboard a client
-     * on several. `phoneNumberId` and `allowedPhoneCountries` apply to `whatsapp_waba`
-     * only.
+     * One invitation connects one channel — create one per channel to onboard a
+     * client on several. `phoneNumberId` and `allowedPhoneCountries` apply to
+     * `whatsapp_waba` only.
      *
-     * @example
-     * ```ts
-     * const invitation = await client.invitations.create({
-     *   clientName: 'Acme Corp',
-     * });
-     * ```
+     * `POST /v1/invitations`
      */
     create(body?: InvitationCreateParams | null | undefined, options?: RequestOptions): APIPromise<InvitationCreateResponse>;
     /**
      * Get invitation
      *
-     * @example
-     * ```ts
-     * const invitation = await client.invitations.retrieve(
-     *   'invitationId',
-     * );
-     * ```
+     * `GET /v1/invitations/{invitationId}`
      */
     retrieve(invitationID: string, options?: RequestOptions): APIPromise<InvitationRetrieveResponse>;
     /**
+     * List invitations
+     *
      * List partner invitations for this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const invitation of client.invitations.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/invitations`
      */
     list(query?: InvitationListParams | null | undefined, options?: RequestOptions): PagePromise<InvitationsCursor, Invitation>;
     /**
+     * Cancel invitation
+     *
      * Cancel an active invitation. The client will no longer be able to use the
      * invitation link.
      *
-     * @example
-     * ```ts
-     * const response = await client.invitations.cancel(
-     *   'invitationId',
-     * );
-     * ```
+     * `POST /v1/invitations/{invitationId}/cancel`
      */
     cancel(invitationID: string, options?: RequestOptions): APIPromise<InvitationCancelResponse>;
 }
-export type InvitationsCursor = Cursor<Invitation>;
-export interface Invitation {
-    id: string;
-    /**
-     * Unique invitation token.
-     */
-    token: string;
-    createdAt: string;
-    expiresAt: string;
-    /**
-     * Current status of the partner invitation.
-     *
-     * `failed` means the client started the connection and it did not finish (they
-     * cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
-     * invitation is still usable: the same link can be retried, and it moves back to
-     * `in_progress` when the client tries again.
-     */
-    status: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
-    updatedAt: string;
-    /**
-     * Full URL to share with the client.
-     */
-    url: string;
-    clientEmail?: string | null;
-    clientName?: string | null;
-    clientPhone?: string | null;
-    completedAt?: string | null;
-    /**
-     * The account the client linked, populated once the invitation is `completed`.
-     * Null before that. Use it to show the partner what was connected without fetching
-     * the sender.
-     */
-    connectedAccount?: Invitation.ConnectedAccount | null;
-    /**
-     * Which Meta channel the client connects: `whatsapp_waba` (official WhatsApp Cloud
-     * API via embedded signup) or `messenger` (a Facebook Page's Messenger inbox,
-     * including Marketplace chats).
-     */
-    connectionType?: 'whatsapp_waba' | 'messenger';
-    failedAt?: string | null;
-    /**
-     * Stable code for why the last attempt failed, present when `status` is `failed`.
-     * Values include `fb_cancelled` (client closed Meta's dialog), `fb_not_authorized`
-     * (permission denied), `signup_abandoned` (started but never finished),
-     * `meta_no_pages` (the client administers no Facebook Page), and `internal_error`.
-     * Treat unknown codes as a generic failure.
-     */
-    failureReason?: string | null;
-    /**
-     * ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null
-     * for `messenger` invitations.
-     */
-    phoneNumberId?: string | null;
-    /**
-     * ID of the sender created when invitation is completed.
-     */
-    senderId?: string | null;
-    startedAt?: string | null;
-    viewedAt?: string | null;
-}
+export type InvitationsCursor = Cursor<T.Invitation>;
+export type Invitation = T.Invitation;
 export declare namespace Invitation {
-    /**
-     * The account the client linked, populated once the invitation is `completed`.
-     * Null before that. Use it to show the partner what was connected without fetching
-     * the sender.
-     */
-    interface ConnectedAccount {
-        /**
-         * Provider-side identifier: the WhatsApp phone number ID, or the Facebook Page ID.
-         */
-        id: string;
-        channel: 'whatsapp' | 'messenger';
-        /**
-         * Display name of the connected account: the WhatsApp verified name, or the
-         * Facebook Page name.
-         */
-        name?: string | null;
-    }
-}
-export interface InvitationCreateResponse {
-    invitation: Invitation;
-}
-export interface InvitationRetrieveResponse {
-    invitation: Invitation;
-}
-export interface InvitationCancelResponse {
-    invitation: Invitation;
-}
-export interface InvitationCreateParams {
-    /**
-     * ISO country codes for allowed phone numbers. Only valid when `connectionType` is
-     * `whatsapp_waba` — sending it with `messenger` returns 400.
-     */
-    allowedPhoneCountries?: Array<string>;
-    /**
-     * Email of the client being invited.
-     */
-    clientEmail?: string;
-    /**
-     * Name of the client being invited.
-     */
-    clientName?: string;
-    /**
-     * Phone number of the client in E.164 format.
-     */
-    clientPhone?: string;
-    /**
-     * Which Meta channel the client connects, and how.
-     *
-     * - `whatsapp_waba` (default): Meta's embedded signup links an official WhatsApp
-     *   Business Account. Accepts `phoneNumberId` and `allowedPhoneCountries`.
-     * - `messenger`: the client authorizes with Facebook and picks a Facebook Page
-     *   they administer. The Page's Messenger inbox — including Marketplace chats — is
-     *   routed to Zavu. They must be an admin of at least one Page. A Page can only be
-     *   connected to one Zavu project at a time: if the client picks a Page that
-     *   another project already connected, the newer connection wins and the older one
-     *   is disconnected.
-     *
-     * One invitation connects one channel. To onboard a client on several channels,
-     * create one invitation per channel; each completes into its own sender.
-     */
-    connectionType?: 'whatsapp_waba' | 'messenger';
-    /**
-     * Number of days until the invitation expires.
-     */
-    expiresInDays?: number;
-    /**
-     * ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
-     * the client will use this number instead of their own. Only valid when
-     * `connectionType` is `whatsapp_waba` — sending it with `messenger` returns 400,
-     * since a Facebook Page has no phone number.
-     */
-    phoneNumberId?: string;
-}
-export interface InvitationListParams extends CursorParams {
-    /**
-     * Current status of the partner invitation.
-     *
-     * `failed` means the client started the connection and it did not finish (they
-     * cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed
-     * invitation is still usable: the same link can be retried, and it moves back to
-     * `in_progress` when the client tries again.
-     */
-    status?: 'pending' | 'in_progress' | 'completed' | 'expired' | 'cancelled' | 'failed';
+    type ConnectedAccount = T.InvitationConnectedAccount;
 }
+export type InvitationCreateResponse = T.InvitationResponse;
+export type InvitationRetrieveResponse = T.InvitationResponse;
+export type InvitationCancelResponse = T.InvitationResponse;
+export type InvitationCreateParams = T.InvitationsCreateParams;
+export type InvitationListParams = T.InvitationsListParams;
 export declare namespace Invitations {
-    export { type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, };
+    export { type Invitation as Invitation, type InvitationCreateResponse as InvitationCreateResponse, type InvitationRetrieveResponse as InvitationRetrieveResponse, type InvitationCancelResponse as InvitationCancelResponse, type InvitationsCursor as InvitationsCursor, type InvitationCreateParams as InvitationCreateParams, type InvitationListParams as InvitationListParams, Webhook as Webhook, type WebhookRetrieveResponse as WebhookRetrieveResponse, type ProjectWebhook as ProjectWebhook, type WebhookConfigureParams as WebhookConfigureParams, type WebhookConfigureResponse as WebhookConfigureResponse, type ProjectWebhookEvent as ProjectWebhookEvent, type WebhookUpdateParams as WebhookUpdateParams, type WebhookUpdateResponse as WebhookUpdateResponse, };
 }
 //# sourceMappingURL=invitations.d.ts.map

package/resources/invitations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invitations.d.ts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAC5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC;IAI7C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAEnD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAErF,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;QAElC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAE/C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;CACvF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"invitations.d.ts","sourceRoot":"","sources":["../src/resources/invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA2B;AACzD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,OAAO,KAAK,KAAK,CAAC,oBAAiB;AACnC,OAAO,KAAK,UAAU,iCAA8B;AACpD,OAAO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC3B,iCAA8B;AAE/B,qBAAa,WAAY,SAAQ,WAAW;IAC1C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC;IAI7C;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;AACtC,yBAAiB,UAAU,CAAC;IAC1B,KAAY,gBAAgB,GAAG,CAAC,CAAC,0BAA0B,CAAC;CAC7D;AAED,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE5D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE9D,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAE5D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,uBAAuB,CAAC;AAE/D,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,qBAAqB,CAAC;AAE3D,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,OAAO,IAAI,OAAO,EAClB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}