x-twitter-scraper 0.12.4 → 0.13.0

package/resources/trends.d.ts

@@ -6,7 +6,8 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class Trends extends APIResource {
     /**
-     * Get trending hashtags and topics by region (alias)
+     * Returns current regional trends through the compatibility route. Each request
+     * costs 1 credit, however many trends it returns.
      */
     list(query?: TrendListParams | null | undefined, options?: RequestOptions): APIPromise<TrendListResponse>;
 }
@@ -20,17 +21,17 @@ export declare namespace TrendListResponse {
         name: string;
         description?: string;
         /**
-         * Promotion identifier from X. Null for organic trends.
+         * Promotion ID for this trend, or null when organic.
          */
         promotedContent?: string | null;
         query?: string;
         rank?: number;
         /**
-         * Approximate public post volume when X supplies it.
+         * Estimated post volume for this trend.
          */
         tweetVolume?: number | null;
         /**
-         * X search URL for the trend.
+         * Search URL associated with this trend.
          */
         url?: string;
     }
@@ -41,7 +42,22 @@ export interface TrendListParams {
      */
     count?: number;
     /**
-     * Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+     * Fields to keep in each row, comma-separated. Use dots for nested fields, such as
+     * author.username. A list keeps the field in each item. Case & underscores do not
+     * matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
+     * always stay. An unknown name answers 400 unknown_field with the valid names,
+     * before any read. The price stays the same. SDK row types then hold only the
+     * named fields.
+     */
+    fields?: string;
+    /**
+     * Fields to drop from each row, comma-separated. It takes the same names as
+     * fields. With fields, it drops from the kept fields.
+     */
+    omit?: string;
+    /**
+     * The WOEID of any place X lists trends for (1=Worldwide, 23424977=US,
+     * 23424975=UK, 23424969=Turkey). List places with GET /x/trends/locations.
      */
     woeid?: number;
 }

package/resources/trends.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trends.d.ts","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}
+{"version":3,"file":"trends.d.ts","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAGjC;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}

package/resources/trends.js

@@ -11,7 +11,8 @@ const resource_1 = require("../core/resource.js");
  */
 class Trends extends resource_1.APIResource {
     /**
-     * Get trending hashtags and topics by region (alias)
+     * Returns current regional trends through the compatibility route. Each request
+     * costs 1 credit, however many trends it returns.
      */
     list(query = {}, options) {
         return this._client.get('/trends', { query, ...options });

package/resources/trends.js.map

@@ -1 +1 @@
-{"version":3,"file":"trends.js","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAVD,wBAUC"}
+{"version":3,"file":"trends.js","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAXD,wBAWC"}

package/resources/trends.mjs

@@ -8,7 +8,8 @@ import { APIResource } from "../core/resource.mjs";
  */
 export class Trends extends APIResource {
     /**
-     * Get trending hashtags and topics by region (alias)
+     * Returns current regional trends through the compatibility route. Each request
+     * costs 1 credit, however many trends it returns.
      */
     list(query = {}, options) {
         return this._client.get('/trends', { query, ...options });

package/resources/trends.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"trends.mjs","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF"}
+{"version":3,"file":"trends.mjs","sourceRoot":"","sources":["../src/resources/trends.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF"}

package/resources/webhooks.d.mts

@@ -7,7 +7,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare class Webhooks extends APIResource {
     /**
-     * Create webhook
+     * Registers an endpoint for signed event deliveries.
      *
      * @example
      * ```ts
@@ -19,11 +19,12 @@ export declare class Webhooks extends APIResource {
      */
     create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
     /**
-     * Update webhook
+     * Updates an endpoint, event selection, or delivery settings.
      *
      * @example
      * ```ts
      * const webhook = await client.webhooks.update('id', {
+     *   eventTypes: ['tweet.new'],
      *   isActive: true,
      *   url: 'https://example.com/webhook',
      * });
@@ -31,16 +32,32 @@ export declare class Webhooks extends APIResource {
      */
     update(id: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook>;
     /**
-     * List webhooks
+     * Returns configured webhook endpoints and delivery states.
      *
      * @example
      * ```ts
      * const webhooks = await client.webhooks.list();
      * ```
      */
-    list(options?: RequestOptions): APIPromise<WebhookListResponse>;
+    list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
     /**
-     * Deactivate webhook
+     * Returns a t.me link to @XquikBot that connects a Telegram chat to the account's
+     * monitor events. Opening it & pressing Start connects the chat, which then gets
+     * each event as a message. The link works once, within 15 minutes. The chat
+     * appears in the webhook list with the URL telegram:<chat ID>, with deliveries,
+     * retries & resume as any webhook. In the chat, /stop pauses its alerts. It costs
+     * no credits.
+     *
+     * @example
+     * ```ts
+     * const response = await client.webhooks.createTelegramLink({
+     *   eventTypes: ['tweet.new', 'tweet.reply'],
+     * });
+     * ```
+     */
+    createTelegramLink(body?: WebhookCreateTelegramLinkParams | null | undefined, options?: RequestOptions): APIPromise<WebhookCreateTelegramLinkResponse>;
+    /**
+     * Stops future deliveries to the selected webhook.
      *
      * @example
      * ```ts
@@ -49,16 +66,16 @@ export declare class Webhooks extends APIResource {
      */
     deactivate(id: string, options?: RequestOptions): APIPromise<WebhookDeactivateResponse>;
     /**
-     * List webhook deliveries
+     * Returns delivery attempts and response outcomes, newest first.
      *
      * @example
      * ```ts
      * const response = await client.webhooks.listDeliveries('id');
      * ```
      */
-    listDeliveries(id: string, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse>;
+    listDeliveries(id: string, query?: WebhookListDeliveriesParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse>;
     /**
-     * Test and resume webhook endpoint
+     * Tests the endpoint before resuming a manually paused webhook.
      *
      * @example
      * ```ts
@@ -67,7 +84,7 @@ export declare class Webhooks extends APIResource {
      */
     resume(id: string, options?: RequestOptions): APIPromise<WebhookResumeResponse>;
     /**
-     * Test webhook endpoint
+     * Sends a signed test event to the configured endpoint.
      *
      * @example
      * ```ts
@@ -81,6 +98,9 @@ export declare class Webhooks extends APIResource {
  */
 export interface Delivery {
     id: string;
+    /**
+     * Whole number from 0.
+     */
     attempts: number;
     createdAt: string;
     status: string;
@@ -100,8 +120,8 @@ export interface Webhook {
     consecutiveFailures: number;
     createdAt: string;
     /**
-     * Endpoint delivery state. needs_attention means delivery stopped after repeated
-     * failures.
+     * Endpoint delivery state. paused means the user paused delivery. needs_attention
+     * marks repeated failures. Delivery attempts continue.
      */
     deliveryStatus: 'active' | 'paused' | 'needs_attention';
     /**
@@ -109,7 +129,7 @@ export interface Webhook {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * Consecutive delivery failures that pause the endpoint.
+     * Maximum reported failures before needs_attention. It does not pause delivery.
      */
     failureHardCap: number;
     isActive: boolean;
@@ -129,13 +149,27 @@ export interface WebhookCreateResponse {
     url: string;
 }
 export interface WebhookListResponse {
+    hasMore: boolean;
     webhooks: Array<Webhook>;
+    nextCursor?: string;
+}
+export interface WebhookCreateTelegramLinkResponse {
+    /**
+     * When the link stops working, 15 minutes on.
+     */
+    expiresAt: string;
+    /**
+     * Opens @XquikBot with the link's code.
+     */
+    url: string;
 }
 export interface WebhookDeactivateResponse {
     success: true;
 }
 export interface WebhookListDeliveriesResponse {
     deliveries: Array<Delivery>;
+    hasMore: boolean;
+    nextCursor?: string;
 }
 export interface WebhookResumeResponse {
     statusCode: number;
@@ -156,7 +190,9 @@ export interface WebhookCreateParams {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * HTTPS URL
+     * HTTPS URL. A Discord channel webhook URL gets each event as a Discord message, &
+     * a Slack incoming webhook URL as a Slack message. To deliver to Telegram, use
+     * POST /webhooks/telegram instead.
      */
     url: string;
 }
@@ -168,7 +204,37 @@ export interface WebhookUpdateParams {
     isActive?: boolean;
     url?: string;
 }
+export interface WebhookListParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+     * next page.
+     */
+    limit?: number;
+}
+export interface WebhookCreateTelegramLinkParams {
+    /**
+     * Array of event types to subscribe to.
+     */
+    eventTypes?: Array<Shared.EventType>;
+}
+export interface WebhookListDeliveriesParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum deliveries per page: 1 to 100, default 100. Pass nextCursor as cursor
+     * for the next page.
+     */
+    limit?: number;
+}
 export declare namespace Webhooks {
-    export { type Delivery as Delivery, type Webhook as Webhook, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeactivateResponse as WebhookDeactivateResponse, type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse, type WebhookResumeResponse as WebhookResumeResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, };
+    export { type Delivery as Delivery, type Webhook as Webhook, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookCreateTelegramLinkResponse as WebhookCreateTelegramLinkResponse, type WebhookDeactivateResponse as WebhookDeactivateResponse, type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse, type WebhookResumeResponse as WebhookResumeResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookCreateTelegramLinkParams as WebhookCreateTelegramLinkParams, type WebhookListDeliveriesParams as WebhookListDeliveriesParams, };
 }
 //# sourceMappingURL=webhooks.d.mts.map

package/resources/webhooks.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIvF;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI/F;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI/E;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAChB,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIvF;;;;;;;OAOG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI/E;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE5B,OAAO,EAAE,OAAO,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/webhooks.d.ts

@@ -7,7 +7,7 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class Webhooks extends APIResource {
     /**
-     * Create webhook
+     * Registers an endpoint for signed event deliveries.
      *
      * @example
      * ```ts
@@ -19,11 +19,12 @@ export declare class Webhooks extends APIResource {
      */
     create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
     /**
-     * Update webhook
+     * Updates an endpoint, event selection, or delivery settings.
      *
      * @example
      * ```ts
      * const webhook = await client.webhooks.update('id', {
+     *   eventTypes: ['tweet.new'],
      *   isActive: true,
      *   url: 'https://example.com/webhook',
      * });
@@ -31,16 +32,32 @@ export declare class Webhooks extends APIResource {
      */
     update(id: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook>;
     /**
-     * List webhooks
+     * Returns configured webhook endpoints and delivery states.
      *
      * @example
      * ```ts
      * const webhooks = await client.webhooks.list();
      * ```
      */
-    list(options?: RequestOptions): APIPromise<WebhookListResponse>;
+    list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
     /**
-     * Deactivate webhook
+     * Returns a t.me link to @XquikBot that connects a Telegram chat to the account's
+     * monitor events. Opening it & pressing Start connects the chat, which then gets
+     * each event as a message. The link works once, within 15 minutes. The chat
+     * appears in the webhook list with the URL telegram:<chat ID>, with deliveries,
+     * retries & resume as any webhook. In the chat, /stop pauses its alerts. It costs
+     * no credits.
+     *
+     * @example
+     * ```ts
+     * const response = await client.webhooks.createTelegramLink({
+     *   eventTypes: ['tweet.new', 'tweet.reply'],
+     * });
+     * ```
+     */
+    createTelegramLink(body?: WebhookCreateTelegramLinkParams | null | undefined, options?: RequestOptions): APIPromise<WebhookCreateTelegramLinkResponse>;
+    /**
+     * Stops future deliveries to the selected webhook.
      *
      * @example
      * ```ts
@@ -49,16 +66,16 @@ export declare class Webhooks extends APIResource {
      */
     deactivate(id: string, options?: RequestOptions): APIPromise<WebhookDeactivateResponse>;
     /**
-     * List webhook deliveries
+     * Returns delivery attempts and response outcomes, newest first.
      *
      * @example
      * ```ts
      * const response = await client.webhooks.listDeliveries('id');
      * ```
      */
-    listDeliveries(id: string, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse>;
+    listDeliveries(id: string, query?: WebhookListDeliveriesParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse>;
     /**
-     * Test and resume webhook endpoint
+     * Tests the endpoint before resuming a manually paused webhook.
      *
      * @example
      * ```ts
@@ -67,7 +84,7 @@ export declare class Webhooks extends APIResource {
      */
     resume(id: string, options?: RequestOptions): APIPromise<WebhookResumeResponse>;
     /**
-     * Test webhook endpoint
+     * Sends a signed test event to the configured endpoint.
      *
      * @example
      * ```ts
@@ -81,6 +98,9 @@ export declare class Webhooks extends APIResource {
  */
 export interface Delivery {
     id: string;
+    /**
+     * Whole number from 0.
+     */
     attempts: number;
     createdAt: string;
     status: string;
@@ -100,8 +120,8 @@ export interface Webhook {
     consecutiveFailures: number;
     createdAt: string;
     /**
-     * Endpoint delivery state. needs_attention means delivery stopped after repeated
-     * failures.
+     * Endpoint delivery state. paused means the user paused delivery. needs_attention
+     * marks repeated failures. Delivery attempts continue.
      */
     deliveryStatus: 'active' | 'paused' | 'needs_attention';
     /**
@@ -109,7 +129,7 @@ export interface Webhook {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * Consecutive delivery failures that pause the endpoint.
+     * Maximum reported failures before needs_attention. It does not pause delivery.
      */
     failureHardCap: number;
     isActive: boolean;
@@ -129,13 +149,27 @@ export interface WebhookCreateResponse {
     url: string;
 }
 export interface WebhookListResponse {
+    hasMore: boolean;
     webhooks: Array<Webhook>;
+    nextCursor?: string;
+}
+export interface WebhookCreateTelegramLinkResponse {
+    /**
+     * When the link stops working, 15 minutes on.
+     */
+    expiresAt: string;
+    /**
+     * Opens @XquikBot with the link's code.
+     */
+    url: string;
 }
 export interface WebhookDeactivateResponse {
     success: true;
 }
 export interface WebhookListDeliveriesResponse {
     deliveries: Array<Delivery>;
+    hasMore: boolean;
+    nextCursor?: string;
 }
 export interface WebhookResumeResponse {
     statusCode: number;
@@ -156,7 +190,9 @@ export interface WebhookCreateParams {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * HTTPS URL
+     * HTTPS URL. A Discord channel webhook URL gets each event as a Discord message, &
+     * a Slack incoming webhook URL as a Slack message. To deliver to Telegram, use
+     * POST /webhooks/telegram instead.
      */
     url: string;
 }
@@ -168,7 +204,37 @@ export interface WebhookUpdateParams {
     isActive?: boolean;
     url?: string;
 }
+export interface WebhookListParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+     * next page.
+     */
+    limit?: number;
+}
+export interface WebhookCreateTelegramLinkParams {
+    /**
+     * Array of event types to subscribe to.
+     */
+    eventTypes?: Array<Shared.EventType>;
+}
+export interface WebhookListDeliveriesParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum deliveries per page: 1 to 100, default 100. Pass nextCursor as cursor
+     * for the next page.
+     */
+    limit?: number;
+}
 export declare namespace Webhooks {
-    export { type Delivery as Delivery, type Webhook as Webhook, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeactivateResponse as WebhookDeactivateResponse, type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse, type WebhookResumeResponse as WebhookResumeResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, };
+    export { type Delivery as Delivery, type Webhook as Webhook, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookCreateTelegramLinkResponse as WebhookCreateTelegramLinkResponse, type WebhookDeactivateResponse as WebhookDeactivateResponse, type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse, type WebhookResumeResponse as WebhookResumeResponse, type WebhookTestResponse as WebhookTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookCreateTelegramLinkParams as WebhookCreateTelegramLinkParams, type WebhookListDeliveriesParams as WebhookListDeliveriesParams, };
 }
 //# sourceMappingURL=webhooks.d.ts.map

package/resources/webhooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIvF;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI/F;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI/E;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAChB,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIvF;;;;;;;OAOG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI/E;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,iBAAiB,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE5B,OAAO,EAAE,OAAO,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/webhooks.js

@@ -12,7 +12,7 @@ const path_1 = require("../internal/utils/path.js");
  */
 class Webhooks extends resource_1.APIResource {
     /**
-     * Create webhook
+     * Registers an endpoint for signed event deliveries.
      *
      * @example
      * ```ts
@@ -26,11 +26,12 @@ class Webhooks extends resource_1.APIResource {
         return this._client.post('/webhooks', { body, ...options });
     }
     /**
-     * Update webhook
+     * Updates an endpoint, event selection, or delivery settings.
      *
      * @example
      * ```ts
      * const webhook = await client.webhooks.update('id', {
+     *   eventTypes: ['tweet.new'],
      *   isActive: true,
      *   url: 'https://example.com/webhook',
      * });
@@ -40,18 +41,36 @@ class Webhooks extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/webhooks/${id}`, { body, ...options });
     }
     /**
-     * List webhooks
+     * Returns configured webhook endpoints and delivery states.
      *
      * @example
      * ```ts
      * const webhooks = await client.webhooks.list();
      * ```
      */
-    list(options) {
-        return this._client.get('/webhooks', options);
+    list(query = {}, options) {
+        return this._client.get('/webhooks', { query, ...options });
     }
     /**
-     * Deactivate webhook
+     * Returns a t.me link to @XquikBot that connects a Telegram chat to the account's
+     * monitor events. Opening it & pressing Start connects the chat, which then gets
+     * each event as a message. The link works once, within 15 minutes. The chat
+     * appears in the webhook list with the URL telegram:<chat ID>, with deliveries,
+     * retries & resume as any webhook. In the chat, /stop pauses its alerts. It costs
+     * no credits.
+     *
+     * @example
+     * ```ts
+     * const response = await client.webhooks.createTelegramLink({
+     *   eventTypes: ['tweet.new', 'tweet.reply'],
+     * });
+     * ```
+     */
+    createTelegramLink(body = {}, options) {
+        return this._client.post('/webhooks/telegram', { body, ...options });
+    }
+    /**
+     * Stops future deliveries to the selected webhook.
      *
      * @example
      * ```ts
@@ -62,18 +81,18 @@ class Webhooks extends resource_1.APIResource {
         return this._client.delete((0, path_1.path) `/webhooks/${id}`, options);
     }
     /**
-     * List webhook deliveries
+     * Returns delivery attempts and response outcomes, newest first.
      *
      * @example
      * ```ts
      * const response = await client.webhooks.listDeliveries('id');
      * ```
      */
-    listDeliveries(id, options) {
-        return this._client.get((0, path_1.path) `/webhooks/${id}/deliveries`, options);
+    listDeliveries(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/webhooks/${id}/deliveries`, { query, ...options });
     }
     /**
-     * Test and resume webhook endpoint
+     * Tests the endpoint before resuming a manually paused webhook.
      *
      * @example
      * ```ts
@@ -84,7 +103,7 @@ class Webhooks extends resource_1.APIResource {
         return this._client.post((0, path_1.path) `/webhooks/${id}/resume`, options);
     }
     /**
-     * Test webhook endpoint
+     * Sends a signed test event to the configured endpoint.
      *
      * @example
      * ```ts

package/resources/webhooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA1FD,4BA0FC"}
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/resources/webhooks.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAChB,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CACZ,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAxHD,4BAwHC"}