@augustusbank/typescript-sdk 0.11.0

package/resources/webhook-subscriptions.d.mts

@@ -0,0 +1,221 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class WebhookSubscriptions extends APIResource {
+    /**
+     * Creates a new webhook subscription.
+     */
+    create(body: WebhookSubscriptionCreateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionCreateResponse>;
+    /**
+     * Retrieves a webhook subscription by ID.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionRetrieveResponse>;
+    /**
+     * Updates the URL and/or subscribed events.
+     */
+    update(id: string, body: WebhookSubscriptionUpdateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionUpdateResponse>;
+    /**
+     * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     */
+    list(query?: WebhookSubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<WebhookSubscriptionListResponsesCursorPage, WebhookSubscriptionListResponse>;
+    /**
+     * Permanently deletes a webhook subscription. This cannot be undone.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionDeleteResponse>;
+    /**
+     * Dispatches a signed `ping.test` event to this subscription's URL through the
+     * same pipeline as real events. Useful for verifying your receiver's reachability
+     * 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.
+     */
+    sendTestEvent(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionSendTestEventResponse>;
+}
+export type WebhookSubscriptionListResponsesCursorPage = CursorPage<WebhookSubscriptionListResponse>;
+export interface WebhookSubscriptionCreateResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionRetrieveResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionUpdateResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionListResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionDeleteResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionSendTestEventResponse {
+    /**
+     * Unique identifier of the event. Matches the envelope `id` delivered in the
+     * webhook payload and is stable across subscription fan-out and retries.
+     */
+    id: string;
+    /**
+     * API version the event payload was rendered at. Stable across retries and
+     * redeliveries, and mirrored in the webhook envelope `api_version` field.
+     */
+    api_version: string;
+    /**
+     * ISO 8601 UTC timestamp when the event was created.
+     */
+    created_at: string;
+    /**
+     * Event payload. Shape matches the resource schema for `event_type`.
+     */
+    data: {
+        [key: string]: unknown;
+    };
+    /**
+     * Event type.
+     */
+    event_type: 'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'ping.test';
+    /**
+     * Resource type discriminator.
+     */
+    type: 'event';
+}
+export interface WebhookSubscriptionCreateParams {
+    /**
+     * Event types to subscribe to. 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' | '*'>;
+    /**
+     * The HTTPS URL where webhook events will be delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionUpdateParams {
+    /**
+     * Event types to subscribe to. 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' | '*'>;
+    /**
+     * The HTTPS URL where webhook events will be delivered.
+     */
+    url?: string;
+}
+export interface WebhookSubscriptionListParams extends CursorPageParams {
+}
+export declare namespace WebhookSubscriptions {
+    export { type WebhookSubscriptionCreateResponse as WebhookSubscriptionCreateResponse, type WebhookSubscriptionRetrieveResponse as WebhookSubscriptionRetrieveResponse, type WebhookSubscriptionUpdateResponse as WebhookSubscriptionUpdateResponse, type WebhookSubscriptionListResponse as WebhookSubscriptionListResponse, type WebhookSubscriptionDeleteResponse as WebhookSubscriptionDeleteResponse, type WebhookSubscriptionSendTestEventResponse as WebhookSubscriptionSendTestEventResponse, type WebhookSubscriptionListResponsesCursorPage as WebhookSubscriptionListResponsesCursorPage, type WebhookSubscriptionCreateParams as WebhookSubscriptionCreateParams, type WebhookSubscriptionUpdateParams as WebhookSubscriptionUpdateParams, type WebhookSubscriptionListParams as WebhookSubscriptionListParams, };
+}
+//# sourceMappingURL=webhook-subscriptions.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-subscriptions.d.mts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,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,CACtB,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,CACtB,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,CACtB,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,CACtB,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,CACtB,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,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,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,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"}

package/resources/webhook-subscriptions.d.ts

@@ -0,0 +1,221 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class WebhookSubscriptions extends APIResource {
+    /**
+     * Creates a new webhook subscription.
+     */
+    create(body: WebhookSubscriptionCreateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionCreateResponse>;
+    /**
+     * Retrieves a webhook subscription by ID.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionRetrieveResponse>;
+    /**
+     * Updates the URL and/or subscribed events.
+     */
+    update(id: string, body: WebhookSubscriptionUpdateParams, options?: RequestOptions): APIPromise<WebhookSubscriptionUpdateResponse>;
+    /**
+     * Lists webhook subscriptions for the merchant with cursor-based pagination.
+     */
+    list(query?: WebhookSubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<WebhookSubscriptionListResponsesCursorPage, WebhookSubscriptionListResponse>;
+    /**
+     * Permanently deletes a webhook subscription. This cannot be undone.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionDeleteResponse>;
+    /**
+     * Dispatches a signed `ping.test` event to this subscription's URL through the
+     * same pipeline as real events. Useful for verifying your receiver's reachability
+     * 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.
+     */
+    sendTestEvent(id: string, options?: RequestOptions): APIPromise<WebhookSubscriptionSendTestEventResponse>;
+}
+export type WebhookSubscriptionListResponsesCursorPage = CursorPage<WebhookSubscriptionListResponse>;
+export interface WebhookSubscriptionCreateResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionRetrieveResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionUpdateResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionListResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionDeleteResponse {
+    /**
+     * Unique identifier of the webhook subscription.
+     */
+    id: string;
+    /**
+     * ISO 8601 UTC timestamp when the subscription was created.
+     */
+    created_at: string;
+    /**
+     * Event types this subscription receives.
+     */
+    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'>;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'webhook_subscription';
+    /**
+     * ISO 8601 UTC timestamp when the subscription was last updated.
+     */
+    updated_at: string;
+    /**
+     * The HTTPS URL where webhook events are delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionSendTestEventResponse {
+    /**
+     * Unique identifier of the event. Matches the envelope `id` delivered in the
+     * webhook payload and is stable across subscription fan-out and retries.
+     */
+    id: string;
+    /**
+     * API version the event payload was rendered at. Stable across retries and
+     * redeliveries, and mirrored in the webhook envelope `api_version` field.
+     */
+    api_version: string;
+    /**
+     * ISO 8601 UTC timestamp when the event was created.
+     */
+    created_at: string;
+    /**
+     * Event payload. Shape matches the resource schema for `event_type`.
+     */
+    data: {
+        [key: string]: unknown;
+    };
+    /**
+     * Event type.
+     */
+    event_type: 'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'ping.test';
+    /**
+     * Resource type discriminator.
+     */
+    type: 'event';
+}
+export interface WebhookSubscriptionCreateParams {
+    /**
+     * Event types to subscribe to. 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' | '*'>;
+    /**
+     * The HTTPS URL where webhook events will be delivered.
+     */
+    url: string;
+}
+export interface WebhookSubscriptionUpdateParams {
+    /**
+     * Event types to subscribe to. 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' | '*'>;
+    /**
+     * The HTTPS URL where webhook events will be delivered.
+     */
+    url?: string;
+}
+export interface WebhookSubscriptionListParams extends CursorPageParams {
+}
+export declare namespace WebhookSubscriptions {
+    export { type WebhookSubscriptionCreateResponse as WebhookSubscriptionCreateResponse, type WebhookSubscriptionRetrieveResponse as WebhookSubscriptionRetrieveResponse, type WebhookSubscriptionUpdateResponse as WebhookSubscriptionUpdateResponse, type WebhookSubscriptionListResponse as WebhookSubscriptionListResponse, type WebhookSubscriptionDeleteResponse as WebhookSubscriptionDeleteResponse, type WebhookSubscriptionSendTestEventResponse as WebhookSubscriptionSendTestEventResponse, type WebhookSubscriptionListResponsesCursorPage as WebhookSubscriptionListResponsesCursorPage, type WebhookSubscriptionCreateParams as WebhookSubscriptionCreateParams, type WebhookSubscriptionUpdateParams as WebhookSubscriptionUpdateParams, type WebhookSubscriptionListParams as WebhookSubscriptionListParams, };
+}
+//# sourceMappingURL=webhook-subscriptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-subscriptions.d.ts","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,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,CACtB,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,CACtB,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,CACtB,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,CACtB,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,CACtB,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,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,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,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"}

package/resources/webhook-subscriptions.js

@@ -0,0 +1,54 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookSubscriptions = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class WebhookSubscriptions extends resource_1.APIResource {
+    /**
+     * Creates a new webhook subscription.
+     */
+    create(body, options) {
+        return this._client.post('/v1/webhook_subscriptions', { body, ...options });
+    }
+    /**
+     * Retrieves a webhook subscription by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/v1/webhook_subscriptions/${id}`, options);
+    }
+    /**
+     * Updates the URL and/or subscribed events.
+     */
+    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.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/webhook_subscriptions', (pagination_1.CursorPage), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Permanently deletes a webhook subscription. This cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/webhook_subscriptions/${id}`, options);
+    }
+    /**
+     * Dispatches a signed `ping.test` event to this subscription's URL through the
+     * same pipeline as real events. Useful for verifying your receiver's reachability
+     * 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.
+     */
+    sendTestEvent(id, options) {
+        return this._client.post((0, path_1.path) `/v1/webhook_subscriptions/${id}/send_test_event`, options);
+    }
+}
+exports.WebhookSubscriptions = WebhookSubscriptions;
+//# sourceMappingURL=webhook-subscriptions.js.map

package/resources/webhook-subscriptions.js.map

@@ -0,0 +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"}

package/resources/webhook-subscriptions.mjs

@@ -0,0 +1,50 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class WebhookSubscriptions extends APIResource {
+    /**
+     * Creates a new webhook subscription.
+     */
+    create(body, options) {
+        return this._client.post('/v1/webhook_subscriptions', { body, ...options });
+    }
+    /**
+     * Retrieves a webhook subscription by ID.
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/v1/webhook_subscriptions/${id}`, options);
+    }
+    /**
+     * Updates the URL and/or subscribed events.
+     */
+    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.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/webhook_subscriptions', (CursorPage), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Permanently deletes a webhook subscription. This cannot be undone.
+     */
+    delete(id, options) {
+        return this._client.delete(path `/v1/webhook_subscriptions/${id}`, options);
+    }
+    /**
+     * Dispatches a signed `ping.test` event to this subscription's URL through the
+     * same pipeline as real events. Useful for verifying your receiver's reachability
+     * 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.
+     */
+    sendTestEvent(id, options) {
+        return this._client.post(path `/v1/webhook_subscriptions/${id}/send_test_event`, options);
+    }
+}
+//# sourceMappingURL=webhook-subscriptions.mjs.map

package/resources/webhook-subscriptions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-subscriptions.mjs","sourceRoot":"","sources":["../src/resources/webhook-subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,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"}