@funnelchat-hq/sdk 0.2.0 → 0.2.1

package/dist/index.d.cts

@@ -4900,7 +4900,7 @@ interface paths {
         };
         /**
          * The QR code to connect a number
-         * @description Creates the WhatsApp instance when needed. Only for QR numbers: an official one answers `422 provider_unsupported`. Scanning the QR gives control of a WhatsApp, so it needs `accounts:operate`. Every call brings the code of that moment: ask again every `expires_in` seconds (5 with a QR) and replace the image with the latest one; the answer carries `Cache-Control: no-store`.
+         * @description Creates the WhatsApp instance when needed. Only for QR numbers: an official one answers `422 provider_unsupported`. Scanning the QR gives control of a WhatsApp, so it needs **WhatsApp numbers → Create, connect and delete** (`accounts:operate`). Every call brings the code of that moment: ask again every `expires_in` seconds (5 with a QR) and replace the image with the latest one; the answer carries `Cache-Control: no-store`.
          */
         get: operations["pendingDevice.qr"];
         put?: never;
@@ -9594,7 +9594,7 @@ interface components {
             /** @description `https`, public and without user or password. */
             url: string;
             description?: string | null;
-            /** @description Types of the catalog (`GET /api/v1/webhooks/events`). The key needs the `{area}:read` permission of the area of each type. */
+            /** @description Types of the catalog (`GET /api/v1/webhooks/events`). The key needs the **View** permission of the area of each type in the panel (`{area}:read`), such as **WhatsApp numbers → View** (`accounts:read`). */
             events: string[];
             filters?: components["schemas"]["PendingWebhookSubscriptionFilters"] | null;
         };
@@ -21057,8 +21057,9 @@ interface RequestOptions {
     /** Overrides the client's `maxRetries` for this request. */
     maxRetries?: number;
     /**
-     * Allows automatic retries of a non-idempotent send (`POST` with `conversations:send`) for this
-     * request. Off by default: a retried send can deliver the same message twice.
+     * Allows automatic retries of a non-idempotent send for this request: a `POST` that needs
+     * **Contacts and conversations → Send** (`conversations:send`). Off by default: a retried send
+     * can deliver the same message twice.
      */
     retrySend?: boolean;
     /** Cancels the request. */
@@ -21133,7 +21134,8 @@ type LinkId = PathParams<'/api/v1/connect-links/{link}', 'GET'>['link'];
  * `device_id` the link reconnects that number instead, without taking a new slot. The Meta sign-up
  * is not available in production yet: `type: 'meta'` answers `503 meta_connect_disabled` until it is.
  *
- * Reading needs `accounts:read`; creating and revoking, `accounts:operate`. The result arrives three
+ * Reading needs **WhatsApp numbers → View** (`accounts:read`); creating and revoking,
+ * **WhatsApp numbers → Create, connect and delete** (`accounts:operate`). The result arrives three
  * ways: the `device.connected` webhook (with `connect_link_id` and `external_reference`), the
  * `return_url`, or `get`. The other `device.*` events carry the link that last connected the number.
  *
@@ -21586,7 +21588,8 @@ declare class Devices extends Resource {
     /**
      * `POST /api/v1/devices`: creates a number that connects by QR code (`connection: 'qr'`), with
      * `connected: false`. Then show its QR with `qr`, or send your customer a connect link
-     * (`connectLinks.create`). Needs `accounts:operate`. It takes a slot of the plan, with the panel's
+     * (`connectLinks.create`). Needs **WhatsApp numbers → Create, connect and delete**
+     * (`accounts:operate`). It takes a slot of the plan, with the panel's
      * rejections: `403 numbers_not_included`, `403 number_limit_reached`, `422 qr_requires_coexistence`
      * and `422 method_already_present` (`same_number_as` adds QR to a number in coexistence instead).
      * An account has at most one QR number waiting to be scanned: another one is `409
@@ -21648,7 +21651,8 @@ declare class Devices extends Resource {
     /**
      * `DELETE /api/v1/devices/{device}`: deletes the number and frees its slot of the plan. An
      * official number stops receiving through Funnelchat but stays registered with Meta; a QR one
-     * logs out. Irreversible; needs `accounts:operate`. Sends `device.deleted`.
+     * logs out. Irreversible; needs **WhatsApp numbers → Create, connect and delete**
+     * (`accounts:operate`). Sends `device.deleted`.
      */
     delete(device: DeviceId$3, options?: RequestOptions): APIPromise<Record<string, unknown>>;
     /** `PUT /api/v1/devices/{device}`: also changes `external_reference`. */
@@ -21702,7 +21706,8 @@ declare class Devices extends Resource {
      * 0 once connected) and have it scanned right away: WhatsApp changes the code every few seconds and
      * an old one no longer links, so show the latest and never store or forward a QR. Only for QR
      * numbers (an official one is `422 provider_unsupported`); needs
-     * `accounts:operate`, since scanning it gives control of a WhatsApp. A number that cannot connect now
+     * **WhatsApp numbers → Create, connect and delete** (`accounts:operate`), since scanning it gives
+     * control of a WhatsApp. A number that cannot connect now
      * answers `409` (`trial_number_blocked`, `number_suspended_by_plan`, `device_inactive`…).
      */
     qr(device: DeviceId$3, options?: RequestOptions): APIPromise<{
@@ -21744,7 +21749,8 @@ type RunId = PathParams<'/api/v1/forms/families/{familyId}/responses/{runId}', '
 type DeviceId$2 = PathParams<'/api/v1/forms/{id}/numbers/{deviceId}', 'DELETE'>['deviceId'];
 /**
  * WhatsApp forms (conversations area): build them, publish them on your numbers and read the
- * answers. Reading needs `conversations:read`; the rest, `conversations:write`.
+ * answers. Reading needs **Contacts and conversations → View** (`conversations:read`); the rest,
+ * **Contacts and conversations → Edit** (`conversations:write`).
  *
  * Two ids: `id` is one version of a form; `family_id` is the form itself (every version). You send
  * a form by its `family_id` with `messages.sendForm`, and `whatsapp_form.completed` brings it as
@@ -21901,7 +21907,7 @@ declare class Forms extends Resource {
 type GroupId = PathParams<'/api/v1/groups/{group}', 'GET'>['group'];
 type GroupUid = PathParams<'/api/v1/groups/{groupUid}/metadata', 'GET'>['groupUid'];
 type DeviceId$1 = PathParams<'/api/v1/devices/{device}/groups', 'GET'>['device'];
-/** WhatsApp groups (communities area): read them, their participants, events and messages. Permission `communities:read`. */
+/** WhatsApp groups (communities area): read them, their participants, events and messages. Permission: **Groups and campaigns → View** (`communities:read`). */
 declare class Groups extends Resource {
     /** `GET /api/v1/groups`, paginated. */
     list(query?: Query<'/api/v1/groups'>, options?: RequestOptions): PagePromise<{
@@ -22108,8 +22114,8 @@ type SendMessageParams = Omit<SendMessageBody, 'contact_id'> & {
  * delivered. The rest arrives by `message.status_changed` (with the same `id` as `message_id`) or
  * with {@link Messages.get}.
  *
- * Sending with an API key needs the `conversations:send` permission and is subject to the
- * WhatsApp rules: `422 window_closed`, `422 antiblock_*`, `422 recipient_*`,
+ * Sending with an API key needs **Contacts and conversations → Send** (`conversations:send`) and
+ * is subject to the WhatsApp rules: `422 window_closed`, `422 antiblock_*`, `422 recipient_*`,
  * `422 provider_unsupported`, `429 rate_limited` (with `retryAfter`) and `429 mac_lockout_24h`. A
  * rejected send stores nothing (see `SEND_ERROR_CODES`). Sends are never retried automatically
  * unless you pass `retrySend: true`.
@@ -23707,10 +23713,13 @@ type SubscriptionId = PathParams<'/api/v1/webhooks/{id}', 'GET'>['id'];
 /**
  * Webhook subscriptions (accounts area) and the verification of deliveries.
  *
- * Reading needs `webhooks:read` and the rest `webhooks:write`; the catalog (`events()`) needs
- * `accounts:read`. A key only sees and manages subscriptions to events of the areas it can read
- * (`conversations:read`, `communities:read`, `accounts:read`): asking for others is a `422` on
- * `events`, and touching a subscription that has them is `403 permission_denied`.
+ * Reading needs **Notifications (webhooks) → View** (`webhooks:read`) and the rest
+ * **Notifications (webhooks) → Manage** (`webhooks:write`); the catalog (`events()`) needs
+ * **WhatsApp numbers → View** (`accounts:read`). A key only sees and manages subscriptions to
+ * events of the areas it can read: **Contacts and conversations → View** (`conversations:read`),
+ * **Groups and campaigns → View** (`communities:read`) and **WhatsApp numbers → View**
+ * (`accounts:read`). Asking for others is a `422` on `events`, and touching a subscription that
+ * has them is `403 permission_denied`.
  */
 declare class Webhooks extends Resource {
     /** Same as `Funnelchat.webhooks.verify`. */
@@ -23908,7 +23917,7 @@ declare class Funnelchat {
         readonly verify: typeof verify;
         readonly constructEvent: typeof constructEvent;
     };
-    static readonly VERSION = "0.2.0";
+    static readonly VERSION = "0.2.1";
     readonly baseUrl: string;
     readonly timeoutMs: number;
     readonly maxRetries: number;
@@ -23973,6 +23982,6 @@ interface RouteInfo {
 declare const routes: readonly RouteInfo[];
 
 /** The SDK version, sent in the `User-Agent`. A test keeps it equal to package.json. */
-declare const VERSION = "0.2.0";
+declare const VERSION = "0.2.1";
 
 export { ACCESS_ERROR_CODES, APIConnectionError, APIConnectionTimeoutError, APIError, APIPromise, type APIResponse, APIUserAbortError, type AccessErrorCode, type ApiPath, AuthenticationError, BASE_URLS, BadRequestError, type Body, type ClientOptions, ConflictError, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, DEFAULT_TOLERANCE_SECONDS, type Environment, type FieldErrors, Funnelchat, FunnelchatError, type HttpMethod, IDEMPOTENCY_ERROR_CODES, type IdempotencyErrorCode, type IdempotentRequestOptions, InternalServerError, type KnownErrorCode, type ListItem, NUMBER_ERROR_CODES, NotFoundError, type NumberErrorCode, Page, PagePromise, type PathParams, PermissionDeniedError, type Query, type QueryParams, REQUEST_ID_HEADER, RateLimitError, type RawBody, type RequestBody, type RequestOptions, type ResponseBody, type RouteInfo, SEND_ERROR_CODES, SIGNATURE_HEADER, type SendErrorCode, type SendMessageParams, type TypedRequestOptions, UnprocessableEntityError, UnsupportedMediaTypeError, type UntypedRequestOptions, VERSION, type VerifyOptions, type WebhookEvent, type WebhookEventData, type WebhookEventEnvelope, type WebhookEventInfo, type WebhookEventOf, type WebhookEventType, type webhooks as WebhookSchemas, WebhookVerificationError, type WebhookVerificationFailure, type components, constructEvent, Funnelchat as default, isNumberQuotaError, isSendRuleError, type operations, type paths, routes, verify, webhookEvents };

package/dist/index.d.ts

@@ -4900,7 +4900,7 @@ interface paths {
         };
         /**
          * The QR code to connect a number
-         * @description Creates the WhatsApp instance when needed. Only for QR numbers: an official one answers `422 provider_unsupported`. Scanning the QR gives control of a WhatsApp, so it needs `accounts:operate`. Every call brings the code of that moment: ask again every `expires_in` seconds (5 with a QR) and replace the image with the latest one; the answer carries `Cache-Control: no-store`.
+         * @description Creates the WhatsApp instance when needed. Only for QR numbers: an official one answers `422 provider_unsupported`. Scanning the QR gives control of a WhatsApp, so it needs **WhatsApp numbers → Create, connect and delete** (`accounts:operate`). Every call brings the code of that moment: ask again every `expires_in` seconds (5 with a QR) and replace the image with the latest one; the answer carries `Cache-Control: no-store`.
          */
         get: operations["pendingDevice.qr"];
         put?: never;
@@ -9594,7 +9594,7 @@ interface components {
             /** @description `https`, public and without user or password. */
             url: string;
             description?: string | null;
-            /** @description Types of the catalog (`GET /api/v1/webhooks/events`). The key needs the `{area}:read` permission of the area of each type. */
+            /** @description Types of the catalog (`GET /api/v1/webhooks/events`). The key needs the **View** permission of the area of each type in the panel (`{area}:read`), such as **WhatsApp numbers → View** (`accounts:read`). */
             events: string[];
             filters?: components["schemas"]["PendingWebhookSubscriptionFilters"] | null;
         };
@@ -21057,8 +21057,9 @@ interface RequestOptions {
     /** Overrides the client's `maxRetries` for this request. */
     maxRetries?: number;
     /**
-     * Allows automatic retries of a non-idempotent send (`POST` with `conversations:send`) for this
-     * request. Off by default: a retried send can deliver the same message twice.
+     * Allows automatic retries of a non-idempotent send for this request: a `POST` that needs
+     * **Contacts and conversations → Send** (`conversations:send`). Off by default: a retried send
+     * can deliver the same message twice.
      */
     retrySend?: boolean;
     /** Cancels the request. */
@@ -21133,7 +21134,8 @@ type LinkId = PathParams<'/api/v1/connect-links/{link}', 'GET'>['link'];
  * `device_id` the link reconnects that number instead, without taking a new slot. The Meta sign-up
  * is not available in production yet: `type: 'meta'` answers `503 meta_connect_disabled` until it is.
  *
- * Reading needs `accounts:read`; creating and revoking, `accounts:operate`. The result arrives three
+ * Reading needs **WhatsApp numbers → View** (`accounts:read`); creating and revoking,
+ * **WhatsApp numbers → Create, connect and delete** (`accounts:operate`). The result arrives three
  * ways: the `device.connected` webhook (with `connect_link_id` and `external_reference`), the
  * `return_url`, or `get`. The other `device.*` events carry the link that last connected the number.
  *
@@ -21586,7 +21588,8 @@ declare class Devices extends Resource {
     /**
      * `POST /api/v1/devices`: creates a number that connects by QR code (`connection: 'qr'`), with
      * `connected: false`. Then show its QR with `qr`, or send your customer a connect link
-     * (`connectLinks.create`). Needs `accounts:operate`. It takes a slot of the plan, with the panel's
+     * (`connectLinks.create`). Needs **WhatsApp numbers → Create, connect and delete**
+     * (`accounts:operate`). It takes a slot of the plan, with the panel's
      * rejections: `403 numbers_not_included`, `403 number_limit_reached`, `422 qr_requires_coexistence`
      * and `422 method_already_present` (`same_number_as` adds QR to a number in coexistence instead).
      * An account has at most one QR number waiting to be scanned: another one is `409
@@ -21648,7 +21651,8 @@ declare class Devices extends Resource {
     /**
      * `DELETE /api/v1/devices/{device}`: deletes the number and frees its slot of the plan. An
      * official number stops receiving through Funnelchat but stays registered with Meta; a QR one
-     * logs out. Irreversible; needs `accounts:operate`. Sends `device.deleted`.
+     * logs out. Irreversible; needs **WhatsApp numbers → Create, connect and delete**
+     * (`accounts:operate`). Sends `device.deleted`.
      */
     delete(device: DeviceId$3, options?: RequestOptions): APIPromise<Record<string, unknown>>;
     /** `PUT /api/v1/devices/{device}`: also changes `external_reference`. */
@@ -21702,7 +21706,8 @@ declare class Devices extends Resource {
      * 0 once connected) and have it scanned right away: WhatsApp changes the code every few seconds and
      * an old one no longer links, so show the latest and never store or forward a QR. Only for QR
      * numbers (an official one is `422 provider_unsupported`); needs
-     * `accounts:operate`, since scanning it gives control of a WhatsApp. A number that cannot connect now
+     * **WhatsApp numbers → Create, connect and delete** (`accounts:operate`), since scanning it gives
+     * control of a WhatsApp. A number that cannot connect now
      * answers `409` (`trial_number_blocked`, `number_suspended_by_plan`, `device_inactive`…).
      */
     qr(device: DeviceId$3, options?: RequestOptions): APIPromise<{
@@ -21744,7 +21749,8 @@ type RunId = PathParams<'/api/v1/forms/families/{familyId}/responses/{runId}', '
 type DeviceId$2 = PathParams<'/api/v1/forms/{id}/numbers/{deviceId}', 'DELETE'>['deviceId'];
 /**
  * WhatsApp forms (conversations area): build them, publish them on your numbers and read the
- * answers. Reading needs `conversations:read`; the rest, `conversations:write`.
+ * answers. Reading needs **Contacts and conversations → View** (`conversations:read`); the rest,
+ * **Contacts and conversations → Edit** (`conversations:write`).
  *
  * Two ids: `id` is one version of a form; `family_id` is the form itself (every version). You send
  * a form by its `family_id` with `messages.sendForm`, and `whatsapp_form.completed` brings it as
@@ -21901,7 +21907,7 @@ declare class Forms extends Resource {
 type GroupId = PathParams<'/api/v1/groups/{group}', 'GET'>['group'];
 type GroupUid = PathParams<'/api/v1/groups/{groupUid}/metadata', 'GET'>['groupUid'];
 type DeviceId$1 = PathParams<'/api/v1/devices/{device}/groups', 'GET'>['device'];
-/** WhatsApp groups (communities area): read them, their participants, events and messages. Permission `communities:read`. */
+/** WhatsApp groups (communities area): read them, their participants, events and messages. Permission: **Groups and campaigns → View** (`communities:read`). */
 declare class Groups extends Resource {
     /** `GET /api/v1/groups`, paginated. */
     list(query?: Query<'/api/v1/groups'>, options?: RequestOptions): PagePromise<{
@@ -22108,8 +22114,8 @@ type SendMessageParams = Omit<SendMessageBody, 'contact_id'> & {
  * delivered. The rest arrives by `message.status_changed` (with the same `id` as `message_id`) or
  * with {@link Messages.get}.
  *
- * Sending with an API key needs the `conversations:send` permission and is subject to the
- * WhatsApp rules: `422 window_closed`, `422 antiblock_*`, `422 recipient_*`,
+ * Sending with an API key needs **Contacts and conversations → Send** (`conversations:send`) and
+ * is subject to the WhatsApp rules: `422 window_closed`, `422 antiblock_*`, `422 recipient_*`,
  * `422 provider_unsupported`, `429 rate_limited` (with `retryAfter`) and `429 mac_lockout_24h`. A
  * rejected send stores nothing (see `SEND_ERROR_CODES`). Sends are never retried automatically
  * unless you pass `retrySend: true`.
@@ -23707,10 +23713,13 @@ type SubscriptionId = PathParams<'/api/v1/webhooks/{id}', 'GET'>['id'];
 /**
  * Webhook subscriptions (accounts area) and the verification of deliveries.
  *
- * Reading needs `webhooks:read` and the rest `webhooks:write`; the catalog (`events()`) needs
- * `accounts:read`. A key only sees and manages subscriptions to events of the areas it can read
- * (`conversations:read`, `communities:read`, `accounts:read`): asking for others is a `422` on
- * `events`, and touching a subscription that has them is `403 permission_denied`.
+ * Reading needs **Notifications (webhooks) → View** (`webhooks:read`) and the rest
+ * **Notifications (webhooks) → Manage** (`webhooks:write`); the catalog (`events()`) needs
+ * **WhatsApp numbers → View** (`accounts:read`). A key only sees and manages subscriptions to
+ * events of the areas it can read: **Contacts and conversations → View** (`conversations:read`),
+ * **Groups and campaigns → View** (`communities:read`) and **WhatsApp numbers → View**
+ * (`accounts:read`). Asking for others is a `422` on `events`, and touching a subscription that
+ * has them is `403 permission_denied`.
  */
 declare class Webhooks extends Resource {
     /** Same as `Funnelchat.webhooks.verify`. */
@@ -23908,7 +23917,7 @@ declare class Funnelchat {
         readonly verify: typeof verify;
         readonly constructEvent: typeof constructEvent;
     };
-    static readonly VERSION = "0.2.0";
+    static readonly VERSION = "0.2.1";
     readonly baseUrl: string;
     readonly timeoutMs: number;
     readonly maxRetries: number;
@@ -23973,6 +23982,6 @@ interface RouteInfo {
 declare const routes: readonly RouteInfo[];
 
 /** The SDK version, sent in the `User-Agent`. A test keeps it equal to package.json. */
-declare const VERSION = "0.2.0";
+declare const VERSION = "0.2.1";
 
 export { ACCESS_ERROR_CODES, APIConnectionError, APIConnectionTimeoutError, APIError, APIPromise, type APIResponse, APIUserAbortError, type AccessErrorCode, type ApiPath, AuthenticationError, BASE_URLS, BadRequestError, type Body, type ClientOptions, ConflictError, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, DEFAULT_TOLERANCE_SECONDS, type Environment, type FieldErrors, Funnelchat, FunnelchatError, type HttpMethod, IDEMPOTENCY_ERROR_CODES, type IdempotencyErrorCode, type IdempotentRequestOptions, InternalServerError, type KnownErrorCode, type ListItem, NUMBER_ERROR_CODES, NotFoundError, type NumberErrorCode, Page, PagePromise, type PathParams, PermissionDeniedError, type Query, type QueryParams, REQUEST_ID_HEADER, RateLimitError, type RawBody, type RequestBody, type RequestOptions, type ResponseBody, type RouteInfo, SEND_ERROR_CODES, SIGNATURE_HEADER, type SendErrorCode, type SendMessageParams, type TypedRequestOptions, UnprocessableEntityError, UnsupportedMediaTypeError, type UntypedRequestOptions, VERSION, type VerifyOptions, type WebhookEvent, type WebhookEventData, type WebhookEventEnvelope, type WebhookEventInfo, type WebhookEventOf, type WebhookEventType, type webhooks as WebhookSchemas, WebhookVerificationError, type WebhookVerificationFailure, type components, constructEvent, Funnelchat as default, isNumberQuotaError, isSendRuleError, type operations, type paths, routes, verify, webhookEvents };

package/dist/index.js

@@ -919,7 +919,8 @@ var Devices = class extends Resource {
   /**
    * `POST /api/v1/devices`: creates a number that connects by QR code (`connection: 'qr'`), with
    * `connected: false`. Then show its QR with `qr`, or send your customer a connect link
-   * (`connectLinks.create`). Needs `accounts:operate`. It takes a slot of the plan, with the panel's
+   * (`connectLinks.create`). Needs **WhatsApp numbers → Create, connect and delete**
+   * (`accounts:operate`). It takes a slot of the plan, with the panel's
    * rejections: `403 numbers_not_included`, `403 number_limit_reached`, `422 qr_requires_coexistence`
    * and `422 method_already_present` (`same_number_as` adds QR to a number in coexistence instead).
    * An account has at most one QR number waiting to be scanned: another one is `409
@@ -940,7 +941,8 @@ var Devices = class extends Resource {
   /**
    * `DELETE /api/v1/devices/{device}`: deletes the number and frees its slot of the plan. An
    * official number stops receiving through Funnelchat but stays registered with Meta; a QR one
-   * logs out. Irreversible; needs `accounts:operate`. Sends `device.deleted`.
+   * logs out. Irreversible; needs **WhatsApp numbers → Create, connect and delete**
+   * (`accounts:operate`). Sends `device.deleted`.
    */
   delete(device, options) {
     return this.client.request("DELETE", "/api/v1/devices/{device}", { ...options, path: { device } });
@@ -955,7 +957,8 @@ var Devices = class extends Resource {
    * 0 once connected) and have it scanned right away: WhatsApp changes the code every few seconds and
    * an old one no longer links, so show the latest and never store or forward a QR. Only for QR
    * numbers (an official one is `422 provider_unsupported`); needs
-   * `accounts:operate`, since scanning it gives control of a WhatsApp. A number that cannot connect now
+   * **WhatsApp numbers → Create, connect and delete** (`accounts:operate`), since scanning it gives
+   * control of a WhatsApp. A number that cannot connect now
    * answers `409` (`trial_number_blocked`, `number_suspended_by_plan`, `device_inactive`…).
    */
   qr(device, options) {
@@ -1380,7 +1383,7 @@ var Webhooks = class extends Resource {
 };
 
 // src/version.ts
-var VERSION = "0.2.0";
+var VERSION = "0.2.1";
 
 // src/client.ts
 var BASE_URLS = {