rebilly-js-sdk 62.211.0 → 62.212.1

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 62.211.0 (2026-10-09)
+## 62.212.1 (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

@@ -1883,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']
@@ -3066,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"];
@@ -5726,7 +5736,10 @@ export interface corePaths {
     get: operations["GetTrackingListCollection"];
   };
   "/tracking/webhooks": {
-    /** Retrieves webhook tracking logs. */
+    /**
+     * Retrieves webhook tracking logs.
+     * Logs are sorted by creation time in descending order.
+     */
     get: operations["GetTrackingWebhookCollection"];
   };
   "/tracking/webhooks/{id}": {
@@ -5776,6 +5789,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"];
@@ -9574,7 +9594,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.
@@ -23396,7 +23420,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. */
@@ -23677,6 +23702,16 @@ export interface coreComponents {
       customerId?: string;
       _links?: coreComponents["schemas"]["SelfLink"];
     };
+    /**
+     * Date and time when the resource is created.
+     * This value is set automatically when the resource is created.
+     */
+    CreatedTimeNoSort: string;
+    /**
+     * Date and time when the resource is updated.
+     * This value is set automatically when the resource is updated.
+     */
+    UpdatedTimeNoSort: string;
     /**
      * Webhook tracking log.
      * This log contains information about a webhook request and its response.
@@ -23703,15 +23738,16 @@ 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. */
       attempt?: number;
       /** Date and time when the webhook is sent. */
       sentTime?: coreComponents["schemas"]["ServerTimestamp"];
-      createdTime?: coreComponents["schemas"]["CreatedTime"];
-      updatedTime?: coreComponents["schemas"]["UpdatedTime"];
+      createdTime?: coreComponents["schemas"]["CreatedTimeNoSort"];
+      updatedTime?: coreComponents["schemas"]["UpdatedTimeNoSort"];
       _links?: coreComponents["schemas"]["SelfLink"];
     };
     User: {
@@ -23769,6 +23805,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;
@@ -28330,7 +28375,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;
@@ -33287,7 +33335,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: {
@@ -44196,7 +44249,10 @@ export interface operations {
       403: coreComponents["responses"]["Forbidden"];
     };
   };
-  /** Retrieves webhook tracking logs. */
+  /**
+   * Retrieves webhook tracking logs.
+   * Logs are sorted by creation time in descending order.
+   */
   GetTrackingWebhookCollection: {
     parameters: {
       query: {
@@ -44207,11 +44263,6 @@ export interface operations {
         limit?: coreComponents["parameters"]["collectionLimit"];
         /** Specifies the starting point within the collection of items to be returned. */
         offset?: coreComponents["parameters"]["collectionOffset"];
-        /**
-         * Sorts and orders the collection of items. To sort in descending
-         * order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
-         */
-        sort?: coreComponents["parameters"]["collectionSort"];
         /**
          * Criteria for filtering collection items.
          * This field requires a special format.
@@ -44438,6 +44489,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: {
@@ -49361,7 +49451,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.
@@ -63183,7 +63277,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. */
@@ -63464,6 +63559,16 @@ export interface storefrontComponents {
       customerId?: string;
       _links?: storefrontComponents["schemas"]["SelfLink"];
     };
+    /**
+     * Date and time when the resource is created.
+     * This value is set automatically when the resource is created.
+     */
+    CreatedTimeNoSort: string;
+    /**
+     * Date and time when the resource is updated.
+     * This value is set automatically when the resource is updated.
+     */
+    UpdatedTimeNoSort: string;
     /**
      * Webhook tracking log.
      * This log contains information about a webhook request and its response.
@@ -63490,15 +63595,16 @@ 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. */
       attempt?: number;
       /** Date and time when the webhook is sent. */
       sentTime?: storefrontComponents["schemas"]["ServerTimestamp"];
-      createdTime?: storefrontComponents["schemas"]["CreatedTime"];
-      updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
+      createdTime?: storefrontComponents["schemas"]["CreatedTimeNoSort"];
+      updatedTime?: storefrontComponents["schemas"]["UpdatedTimeNoSort"];
       _links?: storefrontComponents["schemas"]["SelfLink"];
     };
     User: {
@@ -63556,6 +63662,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;
@@ -68117,7 +68232,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;
@@ -76504,7 +76622,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.
@@ -90326,7 +90448,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. */
@@ -90607,6 +90730,16 @@ export interface reportsComponents {
       customerId?: string;
       _links?: reportsComponents["schemas"]["SelfLink"];
     };
+    /**
+     * Date and time when the resource is created.
+     * This value is set automatically when the resource is created.
+     */
+    CreatedTimeNoSort: string;
+    /**
+     * Date and time when the resource is updated.
+     * This value is set automatically when the resource is updated.
+     */
+    UpdatedTimeNoSort: string;
     /**
      * Webhook tracking log.
      * This log contains information about a webhook request and its response.
@@ -90633,15 +90766,16 @@ 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. */
       attempt?: number;
       /** Date and time when the webhook is sent. */
       sentTime?: reportsComponents["schemas"]["ServerTimestamp"];
-      createdTime?: reportsComponents["schemas"]["CreatedTime"];
-      updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
+      createdTime?: reportsComponents["schemas"]["CreatedTimeNoSort"];
+      updatedTime?: reportsComponents["schemas"]["UpdatedTimeNoSort"];
       _links?: reportsComponents["schemas"]["SelfLink"];
     };
     User: {
@@ -90699,6 +90833,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;
@@ -95260,7 +95403,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;
@@ -101088,6 +101234,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;
@@ -103585,7 +103734,7 @@ declare module "resources/tracking-resource" {
             id: any;
         }): rebilly.GetTrackingTaxResponsePromise;
         getAllListsChangesHistory({ limit, offset, sort, filter, q, }?: rebilly.GetTrackingListCollectionRequest): rebilly.GetTrackingListCollectionResponsePromise;
-        getAllWebhookTrackingLogs({ limit, offset, sort, filter, q, }?: rebilly.GetTrackingWebhookCollectionRequest): rebilly.GetTrackingWebhookCollectionResponsePromise;
+        getAllWebhookTrackingLogs({ limit, offset, filter, q, }?: rebilly.GetTrackingWebhookCollectionRequest): rebilly.GetTrackingWebhookCollectionResponsePromise;
         getWebhookTrackingLog({ id }: {
             id: any;
         }): rebilly.GetTrackingWebhookResponsePromise;
@@ -103676,6 +103825,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;
@@ -105255,7 +105411,7 @@ declare module "resources/api-instance" {
                 id: any;
             }): rebilly.GetTrackingTaxResponsePromise;
             getAllListsChangesHistory({ limit, offset, sort, filter, q, }?: rebilly.GetTrackingListCollectionRequest): rebilly.GetTrackingListCollectionResponsePromise;
-            getAllWebhookTrackingLogs({ limit, offset, sort, filter, q, }?: rebilly.GetTrackingWebhookCollectionRequest): rebilly.GetTrackingWebhookCollectionResponsePromise;
+            getAllWebhookTrackingLogs({ limit, offset, filter, q, }?: rebilly.GetTrackingWebhookCollectionRequest): rebilly.GetTrackingWebhookCollectionResponsePromise;
             getWebhookTrackingLog({ id }: {
                 id: any;
             }): rebilly.GetTrackingWebhookResponsePromise;
@@ -105333,6 +105489,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;