rebilly-js-sdk 62.188.0 → 62.190.0

package/CHANGELOG.md

@@ -1,5 +1,3 @@
-## 62.188.0 (2026-09-30)
+## 62.190.0 (2026-09-30)
 
-### Features
-
-- **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#27667](https://github.com/Rebilly/rebilly/pull/27667))
+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

@@ -1741,6 +1741,11 @@ declare namespace rebilly {
   type PostPayoutRequestAllocationsProcessResponse = operations['PostPayoutRequestAllocationsProcess']['responses']['204']
   type PostPayoutRequestAllocationsProcessResponsePromise = Promise<{fields: PostPayoutRequestAllocationsProcessResponse}>
   
+  type PostPayoutRequestBatchOperationsRequest = operations['PostPayoutRequestBatchOperations']['requestBody']['content']['application/json']
+  type CreatePayoutRequestBatchOperationsRequest = { id?: string,  data: PostPayoutRequestBatchOperationsRequest, expand?: string }
+  type PostPayoutRequestBatchOperationsResponse = operations['PostPayoutRequestBatchOperations']['responses']['200']['content']['application/json']
+  type PostPayoutRequestBatchOperationsResponsePromise = Promise<{fields: PostPayoutRequestBatchOperationsResponse}>
+  
   type PostPayoutRequestBatchPreviewRequest = operations['PostPayoutRequestBatchPreview']['requestBody']['content']['application/json']
   type CreatePayoutRequestBatchPreviewRequest = { id?: string,  data: PostPayoutRequestBatchPreviewRequest, expand?: string }
   type PostPayoutRequestBatchPreviewResponse = operations['PostPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
@@ -5514,6 +5519,27 @@ export interface corePaths {
      */
     post: operations["PostPayoutRequestAllocationsProcess"];
   };
+  "/payout-request-batch-operations": {
+    /**
+     * Creates a payout request batch operation and applies one action to every payout request in the batch.
+     * A payout request batch groups payout requests so one action applies to every request in the group.
+     *
+     * The `type` field specifies the action:
+     * - `approve`: Approves payout requests in the `ready` status.
+     * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
+     * - `unblock`: Removes the block from blocked payout requests.
+     * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
+     * - `process`: Queues pending allocations of the payout requests in the batch for processing.
+     *
+     * Each payout request is checked independently.
+     * Payout requests that do not qualify for the action are skipped.
+     * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
+     * If queueing fails, no allocation is queued and the operation returns an error.
+     * The operation completes before the response returns.
+     * If the batch does not exist, the operation returns a `422` response.
+     */
+    post: operations["PostPayoutRequestBatchOperations"];
+  };
   "/payout-request-batch-previews": {
     /**
      * Creates a preview of the payout requests that match a specified filter and that a batch can include.
@@ -5572,6 +5598,8 @@ export interface corePaths {
      * Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm.
      *
      * Each payout request is processed independently.
+     * This endpoint is deprecated.
+     * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
      */
     post: operations["PostPayoutRequestBatchAutoAllocate"];
     parameters: {
@@ -5587,6 +5615,8 @@ export interface corePaths {
      *
      * Each payout request is processed independently.
      * Only payout requests with a status of `ready` can be approved.
+     * This endpoint is deprecated.
+     * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
      */
     post: operations["PostPayoutRequestBatchApprove"];
     parameters: {
@@ -5601,6 +5631,8 @@ export interface corePaths {
      * Blocks all payout requests in a specified batch.
      *
      * Each payout request is processed independently.
+     * This endpoint is deprecated.
+     * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
      */
     post: operations["PostPayoutRequestBatchBlock"];
     parameters: {
@@ -5664,6 +5696,8 @@ export interface corePaths {
      * Leaves payout requests without a block unchanged.
      * Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
      * This operation is atomic.
+     * This endpoint is deprecated.
+     * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
      */
     post: operations["PostPayoutRequestBatchUnblock"];
     parameters: {
@@ -22959,6 +22993,76 @@ export interface coreComponents {
       status?: number;
       invalidFields?: coreComponents["schemas"]["InvalidFields"];
     } & coreComponents["schemas"]["BaseProblem"];
+    ApprovePayoutRequestBatchOperation: {
+      /** Type of operation that approves payout requests in the batch. */
+      type: "approve";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    BlockPayoutRequestBatchOperation: {
+      /** Type of operation that blocks payout requests in the batch. */
+      type: "block";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+      reason: coreComponents["schemas"]["PayoutRequestBlockReason"];
+      /** Additional description for blocking the payout requests in the batch. */
+      description?: string | null;
+    };
+    UnblockPayoutRequestBatchOperation: {
+      /** Type of operation that removes the block from payout requests in the batch. */
+      type: "unblock";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    AutoAllocatePayoutRequestBatchOperation: {
+      /** Type of operation that creates allocations automatically for payout requests in the batch. */
+      type: "auto-allocate";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    ProcessPayoutRequestBatchOperation: {
+      /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
+      type: "process";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    /** Action to apply to a payout request batch. */
+    PayoutRequestBatchOperationRequest:
+      | coreComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
+      | coreComponents["schemas"]["BlockPayoutRequestBatchOperation"]
+      | coreComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
+      | coreComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
+      | coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
+    /**
+     * Action applied to every payout request in a payout request batch.
+     * A payout request batch groups payout requests so one action applies to every request in the group.
+     */
+    PayoutRequestBatchOperation: {
+      /** Type of action applied to the batch. */
+      type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
+      /** ID of the payout request batch. */
+      batchId: string;
+      /**
+       * Status of the operation.
+       * The operation completes before the response returns, so the status is always `completed`.
+       */
+      status: "completed";
+    };
     PayoutRequestBatch: {
       /** ID of the batch. */
       id?: string;
@@ -42950,6 +43054,45 @@ export interface operations {
       };
     };
   };
+  /**
+   * Creates a payout request batch operation and applies one action to every payout request in the batch.
+   * A payout request batch groups payout requests so one action applies to every request in the group.
+   *
+   * The `type` field specifies the action:
+   * - `approve`: Approves payout requests in the `ready` status.
+   * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
+   * - `unblock`: Removes the block from blocked payout requests.
+   * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
+   * - `process`: Queues pending allocations of the payout requests in the batch for processing.
+   *
+   * Each payout request is checked independently.
+   * Payout requests that do not qualify for the action are skipped.
+   * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
+   * If queueing fails, no allocation is queued and the operation returns an error.
+   * The operation completes before the response returns.
+   * If the batch does not exist, the operation returns a `422` response.
+   */
+  PostPayoutRequestBatchOperations: {
+    responses: {
+      /** Batch operation completed. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["PayoutRequestBatchOperation"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+    /** Action to apply to a payout request batch. */
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["PayoutRequestBatchOperationRequest"];
+      };
+    };
+  };
   /**
    * Creates a preview of the payout requests that match a specified filter and that a batch can include.
    * This operation does not create a batch or change payout requests.
@@ -43200,6 +43343,8 @@ export interface operations {
    * Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm.
    *
    * Each payout request is processed independently.
+   * This endpoint is deprecated.
+   * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
    */
   PostPayoutRequestBatchAutoAllocate: {
     parameters: {
@@ -43229,6 +43374,8 @@ export interface operations {
    *
    * Each payout request is processed independently.
    * Only payout requests with a status of `ready` can be approved.
+   * This endpoint is deprecated.
+   * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
    */
   PostPayoutRequestBatchApprove: {
     parameters: {
@@ -43257,6 +43404,8 @@ export interface operations {
    * Blocks all payout requests in a specified batch.
    *
    * Each payout request is processed independently.
+   * This endpoint is deprecated.
+   * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
    */
   PostPayoutRequestBatchBlock: {
     parameters: {
@@ -43422,6 +43571,8 @@ export interface operations {
    * Leaves payout requests without a block unchanged.
    * Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
    * This operation is atomic.
+   * This endpoint is deprecated.
+   * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
    */
   PostPayoutRequestBatchUnblock: {
     parameters: {
@@ -62464,6 +62615,76 @@ export interface storefrontComponents {
       status?: number;
       invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
     } & storefrontComponents["schemas"]["BaseProblem"];
+    ApprovePayoutRequestBatchOperation: {
+      /** Type of operation that approves payout requests in the batch. */
+      type: "approve";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    BlockPayoutRequestBatchOperation: {
+      /** Type of operation that blocks payout requests in the batch. */
+      type: "block";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+      reason: storefrontComponents["schemas"]["PayoutRequestBlockReason"];
+      /** Additional description for blocking the payout requests in the batch. */
+      description?: string | null;
+    };
+    UnblockPayoutRequestBatchOperation: {
+      /** Type of operation that removes the block from payout requests in the batch. */
+      type: "unblock";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    AutoAllocatePayoutRequestBatchOperation: {
+      /** Type of operation that creates allocations automatically for payout requests in the batch. */
+      type: "auto-allocate";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    ProcessPayoutRequestBatchOperation: {
+      /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
+      type: "process";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    /** Action to apply to a payout request batch. */
+    PayoutRequestBatchOperationRequest:
+      | storefrontComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
+      | storefrontComponents["schemas"]["BlockPayoutRequestBatchOperation"]
+      | storefrontComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
+      | storefrontComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
+      | storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
+    /**
+     * Action applied to every payout request in a payout request batch.
+     * A payout request batch groups payout requests so one action applies to every request in the group.
+     */
+    PayoutRequestBatchOperation: {
+      /** Type of action applied to the batch. */
+      type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
+      /** ID of the payout request batch. */
+      batchId: string;
+      /**
+       * Status of the operation.
+       * The operation completes before the response returns, so the status is always `completed`.
+       */
+      status: "completed";
+    };
     PayoutRequestBatch: {
       /** ID of the batch. */
       id?: string;
@@ -89065,6 +89286,76 @@ export interface reportsComponents {
       status?: number;
       invalidFields?: reportsComponents["schemas"]["InvalidFields"];
     } & reportsComponents["schemas"]["BaseProblem"];
+    ApprovePayoutRequestBatchOperation: {
+      /** Type of operation that approves payout requests in the batch. */
+      type: "approve";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    BlockPayoutRequestBatchOperation: {
+      /** Type of operation that blocks payout requests in the batch. */
+      type: "block";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+      reason: reportsComponents["schemas"]["PayoutRequestBlockReason"];
+      /** Additional description for blocking the payout requests in the batch. */
+      description?: string | null;
+    };
+    UnblockPayoutRequestBatchOperation: {
+      /** Type of operation that removes the block from payout requests in the batch. */
+      type: "unblock";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    AutoAllocatePayoutRequestBatchOperation: {
+      /** Type of operation that creates allocations automatically for payout requests in the batch. */
+      type: "auto-allocate";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    ProcessPayoutRequestBatchOperation: {
+      /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
+      type: "process";
+      /**
+       * ID of the payout request batch.
+       * A payout request batch groups payout requests so one action applies to every request in the group.
+       */
+      batchId: string;
+    };
+    /** Action to apply to a payout request batch. */
+    PayoutRequestBatchOperationRequest:
+      | reportsComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
+      | reportsComponents["schemas"]["BlockPayoutRequestBatchOperation"]
+      | reportsComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
+      | reportsComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
+      | reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
+    /**
+     * Action applied to every payout request in a payout request batch.
+     * A payout request batch groups payout requests so one action applies to every request in the group.
+     */
+    PayoutRequestBatchOperation: {
+      /** Type of action applied to the batch. */
+      type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
+      /** ID of the payout request batch. */
+      batchId: string;
+      /**
+       * Status of the operation.
+       * The operation completes before the response returns, so the status is always `completed`.
+       */
+      status: "completed";
+    };
     PayoutRequestBatch: {
       /** ID of the batch. */
       id?: string;
@@ -99752,6 +100043,10 @@ declare module "rebilly-js-sdk" {
     export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
     export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
     export type PostPayoutRequestAllocationsProcessResponsePromise = rebilly.PostPayoutRequestAllocationsProcessResponsePromise;
+    export type PostPayoutRequestBatchOperationsRequest = rebilly.PostPayoutRequestBatchOperationsRequest;
+    export type CreatePayoutRequestBatchOperationsRequest = rebilly.CreatePayoutRequestBatchOperationsRequest;
+    export type PostPayoutRequestBatchOperationsResponse = rebilly.PostPayoutRequestBatchOperationsResponse;
+    export type PostPayoutRequestBatchOperationsResponsePromise = rebilly.PostPayoutRequestBatchOperationsResponsePromise;
     export type PostPayoutRequestBatchPreviewRequest = rebilly.PostPayoutRequestBatchPreviewRequest;
     export type CreatePayoutRequestBatchPreviewRequest = rebilly.CreatePayoutRequestBatchPreviewRequest;
     export type PostPayoutRequestBatchPreviewResponse = rebilly.PostPayoutRequestBatchPreviewResponse;