rebilly-js-sdk 62.210.0 → 62.212.0

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 62.210.0 (2026-10-08)
+## 62.212.0 (2026-10-09)
 
 This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.

package/dist/rebilly-js-sdk.d.cts

@@ -1552,11 +1552,17 @@ declare namespace rebilly {
   type PutGatewayAccountFinancialSettingsResponse = operations['PutGatewayAccountFinancialSettings']['responses']['201']['content']['application/json']
   type PutGatewayAccountFinancialSettingsResponsePromise = Promise<{fields: PutGatewayAccountFinancialSettingsResponse}>
   
+  
+  type GetDigitalWalletOnboardingApplePayResponse = operations['GetDigitalWalletOnboardingApplePay']['responses']['200']['content']['application/json']
+  type GetDigitalWalletOnboardingApplePayResponsePromise = Promise<{fields: GetDigitalWalletOnboardingApplePayResponse}>
   type PostDigitalWalletOnboardingApplePayRequest = operations['PostDigitalWalletOnboardingApplePay']['requestBody']['content']['application/json']
   type CreateDigitalWalletOnboardingApplePayRequest = { id?: string,  data: PostDigitalWalletOnboardingApplePayRequest, expand?: string }
   type PostDigitalWalletOnboardingApplePayResponse = operations['PostDigitalWalletOnboardingApplePay']['responses']['201']['content']['application/json']
   type PostDigitalWalletOnboardingApplePayResponsePromise = Promise<{fields: PostDigitalWalletOnboardingApplePayResponse}>
   
+  type DeleteDigitalWalletOnboardingApplePayDomainResponse = operations['DeleteDigitalWalletOnboardingApplePayDomain']['responses']['204']
+  type DeleteDigitalWalletOnboardingApplePayDomainResponsePromise = Promise<{fields: DeleteDigitalWalletOnboardingApplePayDomainResponse}>
+  
   type GetGridSegmentCollectionRequest = operations['GetGridSegmentCollection']['parameters']["query"] & (operations['GetGridSegmentCollection']['parameters'] extends {path: {}} ? operations['GetGridSegmentCollection']['parameters']["path"] : {})
   
   type GetGridSegmentCollectionResponse = operations['GetGridSegmentCollection']['responses']['200']['content']['application/json'][0]
@@ -1877,6 +1883,11 @@ declare namespace rebilly {
   type PostWebhookResponse = operations['PostWebhook']['responses']['201']['content']['application/json']
   type PostWebhookResponsePromise = Promise<{fields: PostWebhookResponse}>
   
+  type GetWebhookEventCollectionRequest = operations['GetWebhookEventCollection']['parameters']["query"] & (operations['GetWebhookEventCollection']['parameters'] extends {path: {}} ? operations['GetWebhookEventCollection']['parameters']["path"] : {})
+  
+  type GetWebhookEventCollectionResponse = operations['GetWebhookEventCollection']['responses']['200']['content']['application/json'][0]
+  type GetWebhookEventCollectionResponsePromise = Promise<{ items: {fields: GetWebhookEventCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  
   type GetWebhookRequest = { id: string }
 
   type GetWebhookResponse = operations['GetWebhook']['responses']['200']['content']['application/json']
@@ -3060,7 +3071,12 @@ export interface corePaths {
     };
   };
   "/invoices": {
-    /** Retrieves a list of invoices. */
+    /**
+     * Retrieves a list of invoices.
+     * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
+     * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
+     * Search results can lag briefly behind a write.
+     */
     get: operations["GetInvoiceCollection"];
     /** Creates an invoice. */
     post: operations["PostInvoice"];
@@ -5220,6 +5236,11 @@ export interface corePaths {
     };
   };
   "/digital-wallets/onboarding/apple-pay": {
+    /**
+     * Retrieves the domains that Apple Pay has registered for the organization.
+     * Apple Pay registers domains for the whole organization, not for one gateway account.
+     */
+    get: operations["GetDigitalWalletOnboardingApplePay"];
     /**
      * Registers a domain for Apple Pay.
      *
@@ -5231,6 +5252,19 @@ export interface corePaths {
      */
     post: operations["PostDigitalWalletOnboardingApplePay"];
   };
+  "/digital-wallets/onboarding/apple-pay/{domain}": {
+    /**
+     * Removes a domain from Apple Pay for the organization.
+     * Apple Pay stops working on the domain.
+     */
+    delete: operations["DeleteDigitalWalletOnboardingApplePayDomain"];
+    parameters: {
+      path: {
+        /** Domain to remove from Apple Pay. */
+        domain: string;
+      };
+    };
+  };
   "/grid-segments": {
     /** Retrieves a user's UI segments. */
     get: operations["GetGridSegmentCollection"];
@@ -5752,6 +5786,13 @@ export interface corePaths {
     /** Creates a webhook. */
     post: operations["PostWebhook"];
   };
+  "/webhook-events": {
+    /**
+     * Retrieves the event types that your organization can use in the events filter of a webhook.
+     * If your organization uses the Replay add-on, the list also contains Replay event types.
+     */
+    get: operations["GetWebhookEventCollection"];
+  };
   "/webhooks/{id}": {
     /** Retrieves a webhook with a specified ID. */
     get: operations["GetWebhook"];
@@ -9550,7 +9591,11 @@ export interface coreComponents {
       /** Specifies if the order is a new order. */
       isNewOrder?: boolean;
       customerId: coreComponents["schemas"]["CustomerId"];
-      /** Invoice transactions array. */
+      /**
+       * Up to 10 of the most recent transactions for the invoice.
+       * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
+       * Search results can lag briefly behind a write.
+       */
       transactions?: coreComponents["schemas"]["Transaction"][];
       /**
        * Invoice payment retry instruction.
@@ -22230,6 +22275,11 @@ export interface coreComponents {
         period: coreComponents["schemas"]["SchedulingMethodDateInterval"];
       }[];
     };
+    /** Apple Pay domains of the organization. */
+    DigitalWalletOnboardingApplePayDomains: {
+      /** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
+      domains: string[];
+    };
     /** Register a domain with Apple Pay and associate it with Rebilly. */
     DigitalWalletOnboardingApplePay: {
       /** Domain to register. */
@@ -23367,7 +23417,8 @@ export interface coreComponents {
        * Event types that trigger the webhook.
        * If empty, all event types trigger the webhook.
        */
-      eventsFilter?: coreComponents["schemas"]["GlobalEventType"][];
+      eventsFilter?: (Partial<coreComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>)[];
       status?: "active" | "inactive";
       method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
       /** URL that receives requests when a specified event occurs. */
@@ -23674,7 +23725,8 @@ export interface coreComponents {
       /** ID of the main entity related to the event type. */
       entityId?: string;
       organizationId?: coreComponents["schemas"]["OrganizationId"];
-      eventType?: coreComponents["schemas"]["GlobalEventType"];
+      eventType?: Partial<coreComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>;
       /** Source that triggered the webhook. */
       source?: "webhooks" | "rules";
       /** Number of attempts to send the webhook. */
@@ -23740,6 +23792,15 @@ export interface coreComponents {
       allowedIps?: coreComponents["schemas"]["AllowedIps"];
       _links?: coreComponents["schemas"]["SelfLink"];
     };
+    WebhookEvent: {
+      /** Event type that a webhook can subscribe to. */
+      eventType: string;
+      /**
+       * Product in which the event occurs.
+       * Use this value to distinguish between Replay events and non-Replay events.
+       */
+      product: "core" | "replay";
+    };
     CustomerInformation: {
       /** Currency code in ISO 4217 format. */
       currency?: string;
@@ -28301,7 +28362,10 @@ export interface coreComponents {
       transactionId?: string | null;
       /** ID of the payout request that received the merged amount. */
       mergedIntoPayoutRequestId?: string;
-      /** ID of the related Replay transfer. */
+      /**
+       * ID of the transfer that reserves the payout funds.
+       * This value is `null` if no transfer exists.
+       */
       replayTransferId?: string | null;
       /** Specifies whether the allocation is created automatically. */
       isAutoAllocation?: boolean;
@@ -33258,7 +33322,12 @@ export interface operations {
       403: coreComponents["responses"]["Forbidden"];
     };
   };
-  /** Retrieves a list of invoices. */
+  /**
+   * Retrieves a list of invoices.
+   * Each invoice in the list includes up to 10 of the most recent transactions in `transactions`.
+   * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
+   * Search results can lag briefly behind a write.
+   */
   GetInvoiceCollection: {
     parameters: {
       query: {
@@ -42141,6 +42210,23 @@ export interface operations {
       };
     };
   };
+  /**
+   * Retrieves the domains that Apple Pay has registered for the organization.
+   * Apple Pay registers domains for the whole organization, not for one gateway account.
+   */
+  GetDigitalWalletOnboardingApplePay: {
+    responses: {
+      /** Apple Pay domains retrieved. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["DigitalWalletOnboardingApplePayDomains"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      409: coreComponents["responses"]["Conflict"];
+    };
+  };
   /**
    * Registers a domain for Apple Pay.
    *
@@ -42178,6 +42264,27 @@ export interface operations {
       };
     };
   };
+  /**
+   * Removes a domain from Apple Pay for the organization.
+   * Apple Pay stops working on the domain.
+   */
+  DeleteDigitalWalletOnboardingApplePayDomain: {
+    parameters: {
+      path: {
+        /** Domain to remove from Apple Pay. */
+        domain: string;
+      };
+    };
+    responses: {
+      /** Apple Pay domain removed. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      409: coreComponents["responses"]["Conflict"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+  };
   /** Retrieves a user's UI segments. */
   GetGridSegmentCollection: {
     parameters: {
@@ -44371,6 +44478,45 @@ export interface operations {
     };
     requestBody: coreComponents["requestBodies"]["GlobalWebhook"];
   };
+  /**
+   * Retrieves the event types that your organization can use in the events filter of a webhook.
+   * If your organization uses the Replay add-on, the list also contains Replay event types.
+   */
+  GetWebhookEventCollection: {
+    parameters: {
+      query: {
+        /**
+         * Limit the number of collection items to be returned.
+         * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
+         */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** Specifies the starting point within the collection of items to be returned. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+        /**
+         * Criteria for filtering collection items.
+         * This field requires a special format.
+         * Use `,` to specify multiple allowed values.
+         * Use `;` to specify multiple fields.
+         *
+         * For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /** Use this field to perform a partial search of text fields. */
+        q?: coreComponents["parameters"]["collectionQuery"];
+      };
+    };
+    responses: {
+      /** Webhook event types retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["WebhookEvent"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
   /** Retrieves a webhook with a specified ID. */
   GetWebhook: {
     parameters: {
@@ -49294,7 +49440,11 @@ export interface storefrontComponents {
       /** Specifies if the order is a new order. */
       isNewOrder?: boolean;
       customerId: storefrontComponents["schemas"]["CustomerId"];
-      /** Invoice transactions array. */
+      /**
+       * Up to 10 of the most recent transactions for the invoice.
+       * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
+       * Search results can lag briefly behind a write.
+       */
       transactions?: storefrontComponents["schemas"]["Transaction"][];
       /**
        * Invoice payment retry instruction.
@@ -61974,6 +62124,11 @@ export interface storefrontComponents {
         period: storefrontComponents["schemas"]["SchedulingMethodDateInterval"];
       }[];
     };
+    /** Apple Pay domains of the organization. */
+    DigitalWalletOnboardingApplePayDomains: {
+      /** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
+      domains: string[];
+    };
     /** Register a domain with Apple Pay and associate it with Rebilly. */
     DigitalWalletOnboardingApplePay: {
       /** Domain to register. */
@@ -63111,7 +63266,8 @@ export interface storefrontComponents {
        * Event types that trigger the webhook.
        * If empty, all event types trigger the webhook.
        */
-      eventsFilter?: storefrontComponents["schemas"]["GlobalEventType"][];
+      eventsFilter?: (Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>)[];
       status?: "active" | "inactive";
       method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
       /** URL that receives requests when a specified event occurs. */
@@ -63418,7 +63574,8 @@ export interface storefrontComponents {
       /** ID of the main entity related to the event type. */
       entityId?: string;
       organizationId?: storefrontComponents["schemas"]["OrganizationId"];
-      eventType?: storefrontComponents["schemas"]["GlobalEventType"];
+      eventType?: Partial<storefrontComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>;
       /** Source that triggered the webhook. */
       source?: "webhooks" | "rules";
       /** Number of attempts to send the webhook. */
@@ -63484,6 +63641,15 @@ export interface storefrontComponents {
       allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
       _links?: storefrontComponents["schemas"]["SelfLink"];
     };
+    WebhookEvent: {
+      /** Event type that a webhook can subscribe to. */
+      eventType: string;
+      /**
+       * Product in which the event occurs.
+       * Use this value to distinguish between Replay events and non-Replay events.
+       */
+      product: "core" | "replay";
+    };
     CustomerInformation: {
       /** Currency code in ISO 4217 format. */
       currency?: string;
@@ -68045,7 +68211,10 @@ export interface storefrontComponents {
       transactionId?: string | null;
       /** ID of the payout request that received the merged amount. */
       mergedIntoPayoutRequestId?: string;
-      /** ID of the related Replay transfer. */
+      /**
+       * ID of the transfer that reserves the payout funds.
+       * This value is `null` if no transfer exists.
+       */
       replayTransferId?: string | null;
       /** Specifies whether the allocation is created automatically. */
       isAutoAllocation?: boolean;
@@ -76432,7 +76601,11 @@ export interface reportsComponents {
       /** Specifies if the order is a new order. */
       isNewOrder?: boolean;
       customerId: reportsComponents["schemas"]["CustomerId"];
-      /** Invoice transactions array. */
+      /**
+       * Up to 10 of the most recent transactions for the invoice.
+       * To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter.
+       * Search results can lag briefly behind a write.
+       */
       transactions?: reportsComponents["schemas"]["Transaction"][];
       /**
        * Invoice payment retry instruction.
@@ -89112,6 +89285,11 @@ export interface reportsComponents {
         period: reportsComponents["schemas"]["SchedulingMethodDateInterval"];
       }[];
     };
+    /** Apple Pay domains of the organization. */
+    DigitalWalletOnboardingApplePayDomains: {
+      /** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
+      domains: string[];
+    };
     /** Register a domain with Apple Pay and associate it with Rebilly. */
     DigitalWalletOnboardingApplePay: {
       /** Domain to register. */
@@ -90249,7 +90427,8 @@ export interface reportsComponents {
        * Event types that trigger the webhook.
        * If empty, all event types trigger the webhook.
        */
-      eventsFilter?: reportsComponents["schemas"]["GlobalEventType"][];
+      eventsFilter?: (Partial<reportsComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>)[];
       status?: "active" | "inactive";
       method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
       /** URL that receives requests when a specified event occurs. */
@@ -90556,7 +90735,8 @@ export interface reportsComponents {
       /** ID of the main entity related to the event type. */
       entityId?: string;
       organizationId?: reportsComponents["schemas"]["OrganizationId"];
-      eventType?: reportsComponents["schemas"]["GlobalEventType"];
+      eventType?: Partial<reportsComponents["schemas"]["GlobalEventType"]> &
+        Partial<string>;
       /** Source that triggered the webhook. */
       source?: "webhooks" | "rules";
       /** Number of attempts to send the webhook. */
@@ -90622,6 +90802,15 @@ export interface reportsComponents {
       allowedIps?: reportsComponents["schemas"]["AllowedIps"];
       _links?: reportsComponents["schemas"]["SelfLink"];
     };
+    WebhookEvent: {
+      /** Event type that a webhook can subscribe to. */
+      eventType: string;
+      /**
+       * Product in which the event occurs.
+       * Use this value to distinguish between Replay events and non-Replay events.
+       */
+      product: "core" | "replay";
+    };
     CustomerInformation: {
       /** Currency code in ISO 4217 format. */
       currency?: string;
@@ -95183,7 +95372,10 @@ export interface reportsComponents {
       transactionId?: string | null;
       /** ID of the payout request that received the merged amount. */
       mergedIntoPayoutRequestId?: string;
-      /** ID of the related Replay transfer. */
+      /**
+       * ID of the transfer that reserves the payout funds.
+       * This value is `null` if no transfer exists.
+       */
       replayTransferId?: string | null;
       /** Specifies whether the allocation is created automatically. */
       isAutoAllocation?: boolean;
@@ -100770,10 +100962,14 @@ declare module "rebilly-js-sdk" {
     export type PutGatewayAccountFinancialSettingsRequest = rebilly.PutGatewayAccountFinancialSettingsRequest;
     export type PutGatewayAccountFinancialSettingsResponse = rebilly.PutGatewayAccountFinancialSettingsResponse;
     export type PutGatewayAccountFinancialSettingsResponsePromise = rebilly.PutGatewayAccountFinancialSettingsResponsePromise;
+    export type GetDigitalWalletOnboardingApplePayResponse = rebilly.GetDigitalWalletOnboardingApplePayResponse;
+    export type GetDigitalWalletOnboardingApplePayResponsePromise = rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
     export type PostDigitalWalletOnboardingApplePayRequest = rebilly.PostDigitalWalletOnboardingApplePayRequest;
     export type CreateDigitalWalletOnboardingApplePayRequest = rebilly.CreateDigitalWalletOnboardingApplePayRequest;
     export type PostDigitalWalletOnboardingApplePayResponse = rebilly.PostDigitalWalletOnboardingApplePayResponse;
     export type PostDigitalWalletOnboardingApplePayResponsePromise = rebilly.PostDigitalWalletOnboardingApplePayResponsePromise;
+    export type DeleteDigitalWalletOnboardingApplePayDomainResponse = rebilly.DeleteDigitalWalletOnboardingApplePayDomainResponse;
+    export type DeleteDigitalWalletOnboardingApplePayDomainResponsePromise = rebilly.DeleteDigitalWalletOnboardingApplePayDomainResponsePromise;
     export type GetGridSegmentCollectionRequest = rebilly.GetGridSegmentCollectionRequest;
     export type GetGridSegmentCollectionResponse = rebilly.GetGridSegmentCollectionResponse;
     export type GetGridSegmentCollectionResponsePromise = rebilly.GetGridSegmentCollectionResponsePromise;
@@ -101007,6 +101203,9 @@ declare module "rebilly-js-sdk" {
     export type CreateWebhookRequest = rebilly.CreateWebhookRequest;
     export type PostWebhookResponse = rebilly.PostWebhookResponse;
     export type PostWebhookResponsePromise = rebilly.PostWebhookResponsePromise;
+    export type GetWebhookEventCollectionRequest = rebilly.GetWebhookEventCollectionRequest;
+    export type GetWebhookEventCollectionResponse = rebilly.GetWebhookEventCollectionResponse;
+    export type GetWebhookEventCollectionResponsePromise = rebilly.GetWebhookEventCollectionResponsePromise;
     export type GetWebhookRequest = rebilly.GetWebhookRequest;
     export type GetWebhookResponse = rebilly.GetWebhookResponse;
     export type GetWebhookResponsePromise = rebilly.GetWebhookResponsePromise;
@@ -102092,9 +102291,13 @@ declare module "resources/digital-wallets-resource" {
         validate({ data }: {
             data: any;
         }): any;
+        getApplePayDomains(): rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
         create({ data }: {
             data: any;
         }): any;
+        deleteApplePayDomain({ domain }: {
+            domain: any;
+        }): any;
     };
 }
 declare module "resources/disputes-resource" {
@@ -103591,6 +103794,13 @@ declare module "resources/users-resource" {
         }): rebilly.PutUserResponsePromise;
     };
 }
+declare module "resources/webhook-events-resource" {
+    export default function WebhookEventsResource({ apiHandler }: {
+        apiHandler: any;
+    }): {
+        getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
+    };
+}
 declare module "resources/webhooks-resource" {
     export default function WebhooksResource({ apiHandler }: {
         apiHandler: any;
@@ -104002,9 +104212,13 @@ declare module "resources/api-instance" {
             validate({ data }: {
                 data: any;
             }): any;
+            getApplePayDomains(): rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
             create({ data }: {
                 data: any;
             }): any;
+            deleteApplePayDomain({ domain }: {
+                domain: any;
+            }): any;
         };
         disputes: {
             getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetDisputeCollectionRequest): rebilly.GetDisputeCollectionResponsePromise;
@@ -105244,6 +105458,9 @@ declare module "resources/api-instance" {
                 data: any;
             }): rebilly.PutUserResponsePromise;
         };
+        webhookEvents: {
+            getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
+        };
         webhooks: {
             getAll({ limit, offset, filter }?: rebilly.GetWebhookCollectionRequest): rebilly.GetWebhookCollectionResponsePromise;
             create({ id, data }: rebilly.CreateWebhookRequest): rebilly.PostWebhookResponsePromise;