@augustusbank/typescript-sdk 0.21.0 → 0.22.0

package/resources/webhook-subscriptions.d.mts

@@ -5,22 +5,63 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class WebhookSubscriptions extends APIResource {
     /**
      * Creates a new webhook subscription.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.create({
+     *     events: ['payout.paid'],
+     *     url: 'https://sandbox.example.com/webhooks/augustus',
+     *   });
+     * ```
      */
     create(body: WebhookSubscriptionCreateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionCreateResponse>;
     /**
      * Retrieves a webhook subscription by ID.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.retrieve(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionRetrieveResponse>;
     /**
      * Updates the URL and/or subscribed events.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.update(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     update(id: string, body: WebhookSubscriptionUpdateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionUpdateResponse>;
     /**
      * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const webhookSubscriptionListResponse of client.webhookSubscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: WebhookSubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<WebhookSubscriptionListResponsesCursorPage, WebhookSubscriptionListResponse>;
     /**
      * Permanently deletes a webhook subscription. This cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.delete(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionDeleteResponse>;
     /**
@@ -29,6 +70,14 @@ export declare class WebhookSubscriptions extends APIResource {
      * and signature verification in any environment without creating a real business
      * event. Test-event failures do not affect the subscription's health counters or
      * trigger failure-notification emails.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.webhookSubscriptions.sendTestEvent(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     sendTestEvent(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionSendTestEventResponse>;
 }
@@ -205,13 +254,14 @@ export interface WebhookSubscriptionCreateParams {
 }
 export interface WebhookSubscriptionUpdateParams {
     /**
-     * Event types to subscribe to. Use ["*"] for all events.
+     * New event types. Omit or send null to keep the current events. Use ["*"] for all
+     * events.
      */
-    events?: Array<'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'account_holder.active' | 'account_holder.closed' | '*'>;
+    events?: Array<'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'account_holder.active' | 'account_holder.closed' | '*'> | null;
     /**
-     * The HTTPS URL where webhook events will be delivered.
+     * The new HTTPS URL. Omit or send null to keep the current URL.
      */
-    url?: string;
+    url?: string | null;
 }
 export interface WebhookSubscriptionListParams extends CursorPageParams {
 }

package/resources/webhook-subscriptions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook-subscriptions.d.mts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,+BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,+BAA+B,CAAC;IAO3F;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;CAG1G;AAED,MAAM,MAAM,0CAA0C,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAC;AAErG,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,WAAW,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;CAAG;AAE1E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"webhook-subscriptions.d.mts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,+BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,+BAA+B,CAAC;IAO3F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;CAG1G;AAED,MAAM,MAAM,0CAA0C,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAC;AAErG,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,WAAW,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;CAAG;AAE1E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/webhook-subscriptions.d.ts

@@ -5,22 +5,63 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class WebhookSubscriptions extends APIResource {
     /**
      * Creates a new webhook subscription.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.create({
+     *     events: ['payout.paid'],
+     *     url: 'https://sandbox.example.com/webhooks/augustus',
+     *   });
+     * ```
      */
     create(body: WebhookSubscriptionCreateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionCreateResponse>;
     /**
      * Retrieves a webhook subscription by ID.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.retrieve(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionRetrieveResponse>;
     /**
      * Updates the URL and/or subscribed events.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.update(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     update(id: string, body: WebhookSubscriptionUpdateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionUpdateResponse>;
     /**
      * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const webhookSubscriptionListResponse of client.webhookSubscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: WebhookSubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<WebhookSubscriptionListResponsesCursorPage, WebhookSubscriptionListResponse>;
     /**
      * Permanently deletes a webhook subscription. This cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.delete(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionDeleteResponse>;
     /**
@@ -29,6 +70,14 @@ export declare class WebhookSubscriptions extends APIResource {
      * and signature verification in any environment without creating a real business
      * event. Test-event failures do not affect the subscription's health counters or
      * trigger failure-notification emails.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.webhookSubscriptions.sendTestEvent(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     sendTestEvent(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionSendTestEventResponse>;
 }
@@ -205,13 +254,14 @@ export interface WebhookSubscriptionCreateParams {
 }
 export interface WebhookSubscriptionUpdateParams {
     /**
-     * Event types to subscribe to. Use ["*"] for all events.
+     * New event types. Omit or send null to keep the current events. Use ["*"] for all
+     * events.
      */
-    events?: Array<'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'account_holder.active' | 'account_holder.closed' | '*'>;
+    events?: Array<'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'account_holder.active' | 'account_holder.closed' | '*'> | null;
     /**
-     * The HTTPS URL where webhook events will be delivered.
+     * The new HTTPS URL. Omit or send null to keep the current URL.
      */
-    url?: string;
+    url?: string | null;
 }
 export interface WebhookSubscriptionListParams extends CursorPageParams {
 }

package/resources/webhook-subscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook-subscriptions.d.ts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,+BAA+B,CAAC;IAO3F;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;CAG1G;AAED,MAAM,MAAM,0CAA0C,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAC;AAErG,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,WAAW,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;CAAG;AAE1E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"webhook-subscriptions.d.ts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,+BAA+B,CAAC;IAO3F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;CAG1G;AAED,MAAM,MAAM,0CAA0C,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAC;AAErG,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,WAAW,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,uBAAuB,GACvB,uBAAuB,GACvB,GAAG,CACN,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;CAAG;AAE1E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/webhook-subscriptions.js

@@ -8,24 +8,57 @@ const path_1 = require("../internal/utils/path.js");
 class WebhookSubscriptions extends resource_1.APIResource {
     /**
      * Creates a new webhook subscription.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.create({
+     *     events: ['payout.paid'],
+     *     url: 'https://sandbox.example.com/webhooks/augustus',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/webhook_subscriptions', { body, ...options });
     }
     /**
      * Retrieves a webhook subscription by ID.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.retrieve(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/v1/webhook_subscriptions/${id}`, options);
     }
     /**
      * Updates the URL and/or subscribed events.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.update(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     update(id, body, options) {
         return this._client.post((0, path_1.path) `/v1/webhook_subscriptions/${id}`, { body, ...options });
     }
     /**
      * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const webhookSubscriptionListResponse of client.webhookSubscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/webhook_subscriptions', (pagination_1.CursorPage), {
@@ -35,6 +68,14 @@ class WebhookSubscriptions extends resource_1.APIResource {
     }
     /**
      * Permanently deletes a webhook subscription. This cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.delete(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/v1/webhook_subscriptions/${id}`, options);
@@ -45,6 +86,14 @@ class WebhookSubscriptions extends resource_1.APIResource {
      * and signature verification in any environment without creating a real business
      * event. Test-event failures do not affect the subscription's health counters or
      * trigger failure-notification emails.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.webhookSubscriptions.sendTestEvent(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     sendTestEvent(id, options) {
         return this._client.post((0, path_1.path) `/v1/webhook_subscriptions/${id}/send_test_event`, options);

package/resources/webhook-subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhook-subscriptions.js","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;OAEG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,uBAA2C,CAAA,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AA3DD,oDA2DC"}
+{"version":3,"file":"webhook-subscriptions.js","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,uBAA2C,CAAA,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AA5GD,oDA4GC"}

package/resources/webhook-subscriptions.mjs

@@ -5,24 +5,57 @@ import { path } from "../internal/utils/path.mjs";
 export class WebhookSubscriptions extends APIResource {
     /**
      * Creates a new webhook subscription.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.create({
+     *     events: ['payout.paid'],
+     *     url: 'https://sandbox.example.com/webhooks/augustus',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/webhook_subscriptions', { body, ...options });
     }
     /**
      * Retrieves a webhook subscription by ID.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.retrieve(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(path `/v1/webhook_subscriptions/${id}`, options);
     }
     /**
      * Updates the URL and/or subscribed events.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.update(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     update(id, body, options) {
         return this._client.post(path `/v1/webhook_subscriptions/${id}`, { body, ...options });
     }
     /**
      * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const webhookSubscriptionListResponse of client.webhookSubscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/webhook_subscriptions', (CursorPage), {
@@ -32,6 +65,14 @@ export class WebhookSubscriptions extends APIResource {
     }
     /**
      * Permanently deletes a webhook subscription. This cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const webhookSubscription =
+     *   await client.webhookSubscriptions.delete(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     delete(id, options) {
         return this._client.delete(path `/v1/webhook_subscriptions/${id}`, options);
@@ -42,6 +83,14 @@ export class WebhookSubscriptions extends APIResource {
      * and signature verification in any environment without creating a real business
      * event. Test-event failures do not affect the subscription's health counters or
      * trigger failure-notification emails.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.webhookSubscriptions.sendTestEvent(
+     *     '550e8400-e29b-41d4-a716-446655440009',
+     *   );
+     * ```
      */
     sendTestEvent(id, options) {
         return this._client.post(path `/v1/webhook_subscriptions/${id}/send_test_event`, options);

package/resources/webhook-subscriptions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"webhook-subscriptions.mjs","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,UAA2C,CAAA,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,6BAA6B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF"}
+{"version":3,"file":"webhook-subscriptions.mjs","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,UAA2C,CAAA,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,6BAA6B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,6BAA6B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF"}