rebilly-js-sdk 62.146.0 → 62.148.0

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

@@ -1772,6 +1772,8 @@ declare namespace rebilly {
   type PatchPayoutRequestBatchRequest = operations['PatchPayoutRequestBatch']['requestBody']['content']['application/json']
   type PatchPayoutRequestBatchResponse = operations['PatchPayoutRequestBatch']['responses']['200']['content']['application/json']
   type PatchPayoutRequestBatchResponsePromise = Promise<{fields: PatchPayoutRequestBatchResponse}>
+  type DeletePayoutRequestBatchResponse = operations['DeletePayoutRequestBatch']['responses']['204']
+  type DeletePayoutRequestBatchResponsePromise = Promise<{fields: DeletePayoutRequestBatchResponse}>
   
   type PostPayoutRequestBatchAutoAllocateResponse = operations['PostPayoutRequestBatchAutoAllocate']['responses']['200']['content']['application/json']
   type PostPayoutRequestBatchAutoAllocateResponsePromise = Promise<{fields: PostPayoutRequestBatchAutoAllocateResponse}>
@@ -1784,6 +1786,19 @@ declare namespace rebilly {
   type PostPayoutRequestBatchBlockResponse = operations['PostPayoutRequestBatchBlock']['responses']['200']['content']['application/json']
   type PostPayoutRequestBatchBlockResponsePromise = Promise<{fields: PostPayoutRequestBatchBlockResponse}>
   
+  type PostPayoutRequestsToBatchRequest = operations['PostPayoutRequestsToBatch']['requestBody']['content']['application/json']
+  type CreatePayoutRequestsToBatchRequest = { id?: string,  data: PostPayoutRequestsToBatchRequest, expand?: string }
+  type PostPayoutRequestsToBatchResponse = operations['PostPayoutRequestsToBatch']['responses']['200']['content']['application/json']
+  type PostPayoutRequestsToBatchResponsePromise = Promise<{fields: PostPayoutRequestsToBatchResponse}>
+  
+  type PostRemovePayoutRequestsFromBatchRequest = operations['PostRemovePayoutRequestsFromBatch']['requestBody']['content']['application/json']
+  type CreateRemovePayoutRequestsFromBatchRequest = { id?: string,  data: PostRemovePayoutRequestsFromBatchRequest, expand?: string }
+  type PostRemovePayoutRequestsFromBatchResponse = operations['PostRemovePayoutRequestsFromBatch']['responses']['200']['content']['application/json']
+  type PostRemovePayoutRequestsFromBatchResponsePromise = Promise<{fields: PostRemovePayoutRequestsFromBatchResponse}>
+  
+  type PostPayoutRequestBatchUnblockResponse = operations['PostPayoutRequestBatchUnblock']['responses']['200']['content']['application/json']
+  type PostPayoutRequestBatchUnblockResponsePromise = Promise<{fields: PostPayoutRequestBatchUnblockResponse}>
+  
   type GetPayoutRequestBatchPreviewRequest = operations['GetPayoutRequestBatchPreview']['parameters']
   
   type GetPayoutRequestBatchPreviewResponse = operations['GetPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
@@ -5544,6 +5559,12 @@ export interface corePaths {
   "/payout-request-batches/{id}": {
     /** Retrieves a payout request batch with a specified ID. */
     get: operations["GetPayoutRequestBatch"];
+    /**
+     * Deletes a payout request batch with a specified ID and clears the `batchId` field from every payout request in the batch.
+     * This operation preserves every payout request, status, and blocked state.
+     * This operation is atomic. It clears all `batchId` fields or leaves them all unchanged.
+     */
+    delete: operations["DeletePayoutRequestBatch"];
     /**
      * Partially updates a payout request batch with a specified ID.
      * Use this operation to update the description and allocation order.
@@ -5599,6 +5620,69 @@ export interface corePaths {
       };
     };
   };
+  "/payout-request-batches/{id}/payout-requests": {
+    /**
+     * Adds payout requests to a batch with a specified ID.
+     * Accepts payout requests in any status, with or without allocations.
+     * A batch contains a maximum of 1000 payout requests.
+     *
+     * Provide exactly one of the following fields:
+     * - `payoutRequestIds` to add specific payout requests.
+     * - `filter` to add payout requests that match the filter when the operation runs.
+     *
+     * If any explicitly specified payout request is already associated with a batch,
+     * the operation returns a `409 Conflict` response.
+     * Filter results exclude payout requests that are already associated with a batch.
+     * If more payout requests match the filter than the batch can contain,
+     * the operation adds only the oldest matching requests up to the batch limit,
+     * sorted by creation time.
+     * If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
+     * the operation returns a `409 Conflict` response.
+     * If the batch has reached its payout request limit,
+     * the operation returns a `409 Conflict` response for either selection method.
+     * This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
+     */
+    post: operations["PostPayoutRequestsToBatch"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/payout-request-batches/{id}/payout-requests/remove": {
+    /**
+     * Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
+     * This operation preserves each payout request, status, and blocked state.
+     * Removes requests regardless of status or allocations.
+     *
+     * This operation is atomic.
+     * If any payout request is not associated with the specified batch,
+     * the operation clears no associations with the batch.
+     */
+    post: operations["PostRemovePayoutRequestsFromBatch"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/payout-request-batches/{id}/unblock": {
+    /**
+     * Unblocks every blocked payout request in a batch with a specified ID.
+     * 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.
+     */
+    post: operations["PostPayoutRequestBatchUnblock"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
   "/payout-request-batches/preview": {
     /**
      * Retrieves aggregate information for the payout requests that match a specified filter.
@@ -22656,10 +22740,6 @@ export interface coreComponents {
       userId?: string;
       /** Total number of payout requests in the batch. */
       totalCount?: number;
-      /** Number of payout requests successfully processed. */
-      successCount?: number;
-      /** Number of payout requests that failed to process. */
-      failureCount?: number;
       /** Number of unique customers in the batch. */
       customerCount?: number;
       /** Total payout amount grouped by currency in the batch. */
@@ -22717,7 +22797,7 @@ export interface coreComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
@@ -26976,7 +27056,7 @@ export interface coreComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
@@ -27030,7 +27110,7 @@ export interface coreComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
@@ -42157,6 +42237,8 @@ export interface operations {
         limit?: coreComponents["parameters"]["collectionLimit"];
         /** Specifies the starting point within the collection of items to be returned. */
         offset?: coreComponents["parameters"]["collectionOffset"];
+        /** Use this field to perform a partial search of text fields. */
+        q?: coreComponents["parameters"]["collectionQuery"];
         /**
          * Criteria for filtering collection items.
          * This field requires a special format.
@@ -42276,6 +42358,27 @@ export interface operations {
       429: coreComponents["responses"]["TooManyRequests"];
     };
   };
+  /**
+   * Deletes a payout request batch with a specified ID and clears the `batchId` field from every payout request in the batch.
+   * This operation preserves every payout request, status, and blocked state.
+   * This operation is atomic. It clears all `batchId` fields or leaves them all unchanged.
+   */
+  DeletePayoutRequestBatch: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Payout request batch deleted. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+  };
   /**
    * Partially updates a payout request batch with a specified ID.
    * Use this operation to update the description and allocation order.
@@ -42397,6 +42500,160 @@ export interface operations {
       };
     };
   };
+  /**
+   * Adds payout requests to a batch with a specified ID.
+   * Accepts payout requests in any status, with or without allocations.
+   * A batch contains a maximum of 1000 payout requests.
+   *
+   * Provide exactly one of the following fields:
+   * - `payoutRequestIds` to add specific payout requests.
+   * - `filter` to add payout requests that match the filter when the operation runs.
+   *
+   * If any explicitly specified payout request is already associated with a batch,
+   * the operation returns a `409 Conflict` response.
+   * Filter results exclude payout requests that are already associated with a batch.
+   * If more payout requests match the filter than the batch can contain,
+   * the operation adds only the oldest matching requests up to the batch limit,
+   * sorted by creation time.
+   * If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
+   * the operation returns a `409 Conflict` response.
+   * If the batch has reached its payout request limit,
+   * the operation returns a `409 Conflict` response for either selection method.
+   * This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
+   */
+  PostPayoutRequestsToBatch: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Payout requests added to the batch. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["PayoutRequestBatch"];
+        };
+      };
+      /** Invalid filter provided or no payout requests match the filter. */
+      400: {
+        content: {
+          "application/json": coreComponents["schemas"]["Problem"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      /** Batch limit reached or would be exceeded, or one or more explicitly specified payout requests are already associated with a batch. */
+      409: {
+        content: {
+          "application/json": coreComponents["schemas"]["Conflict"];
+        };
+      };
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+    /** Selection of payout requests to add to the batch. */
+    requestBody: {
+      content: {
+        "application/json":
+          | {
+              /** IDs of the payout requests to add to the batch. */
+              payoutRequestIds: string[];
+            }
+          | {
+              /**
+               * Filter string that selects payout requests to add to the batch.
+               * This field uses the same format as filter parameters for collections.
+               * Use semicolons to separate multiple filter conditions.
+               *
+               * Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
+               *
+               * This operation ignores a `batchId` filter.
+               * Filter results always exclude payout requests that are already associated with a batch.
+               * If the filter matches more payout requests than the batch can contain,
+               * the operation adds only the oldest matching requests up to the batch limit,
+               * sorted by creation time.
+               */
+              filter: string;
+            };
+      };
+    };
+  };
+  /**
+   * Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
+   * This operation preserves each payout request, status, and blocked state.
+   * Removes requests regardless of status or allocations.
+   *
+   * This operation is atomic.
+   * If any payout request is not associated with the specified batch,
+   * the operation clears no associations with the batch.
+   */
+  PostRemovePayoutRequestsFromBatch: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Payout requests removed from the batch. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["PayoutRequestBatch"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      /** One or more payout requests are not associated with the specified batch. */
+      409: {
+        content: {
+          "application/json": coreComponents["schemas"]["Conflict"];
+        };
+      };
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+    /** Payout requests to remove from the batch. */
+    requestBody: {
+      content: {
+        "application/json": {
+          /** IDs of the payout requests to remove from the batch. */
+          payoutRequestIds: string[];
+        };
+      };
+    };
+  };
+  /**
+   * Unblocks every blocked payout request in a batch with a specified ID.
+   * 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.
+   */
+  PostPayoutRequestBatchUnblock: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Payout requests in the batch unblocked. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["PayoutRequestBatch"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+  };
   /**
    * Retrieves aggregate information for the payout requests that match a specified filter.
    *
@@ -61205,10 +61462,6 @@ export interface storefrontComponents {
       userId?: string;
       /** Total number of payout requests in the batch. */
       totalCount?: number;
-      /** Number of payout requests successfully processed. */
-      successCount?: number;
-      /** Number of payout requests that failed to process. */
-      failureCount?: number;
       /** Number of unique customers in the batch. */
       customerCount?: number;
       /** Total payout amount grouped by currency in the batch. */
@@ -61266,7 +61519,7 @@ export interface storefrontComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
@@ -65525,7 +65778,7 @@ export interface storefrontComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
@@ -65579,7 +65832,7 @@ export interface storefrontComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
@@ -87207,10 +87460,6 @@ export interface reportsComponents {
       userId?: string;
       /** Total number of payout requests in the batch. */
       totalCount?: number;
-      /** Number of payout requests successfully processed. */
-      successCount?: number;
-      /** Number of payout requests that failed to process. */
-      failureCount?: number;
       /** Number of unique customers in the batch. */
       customerCount?: number;
       /** Total payout amount grouped by currency in the batch. */
@@ -87268,7 +87517,7 @@ export interface reportsComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: reportsComponents["schemas"]["ContactObject"] | null;
@@ -91527,7 +91776,7 @@ export interface reportsComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: reportsComponents["schemas"]["ContactObject"] | null;
@@ -91581,7 +91830,7 @@ export interface reportsComponents {
         /** ID of the plan. */
         planId: string;
         /** Number of product units in the specified plan. */
-        quantity?: number;
+        quantity: number;
       }[];
       /** Billing address details. */
       billingAddress?: reportsComponents["schemas"]["ContactObject"] | null;
@@ -97461,6 +97710,8 @@ declare module "rebilly-js-sdk" {
     export type PatchPayoutRequestBatchRequest = rebilly.PatchPayoutRequestBatchRequest;
     export type PatchPayoutRequestBatchResponse = rebilly.PatchPayoutRequestBatchResponse;
     export type PatchPayoutRequestBatchResponsePromise = rebilly.PatchPayoutRequestBatchResponsePromise;
+    export type DeletePayoutRequestBatchResponse = rebilly.DeletePayoutRequestBatchResponse;
+    export type DeletePayoutRequestBatchResponsePromise = rebilly.DeletePayoutRequestBatchResponsePromise;
     export type PostPayoutRequestBatchAutoAllocateResponse = rebilly.PostPayoutRequestBatchAutoAllocateResponse;
     export type PostPayoutRequestBatchAutoAllocateResponsePromise = rebilly.PostPayoutRequestBatchAutoAllocateResponsePromise;
     export type PostPayoutRequestBatchApproveResponse = rebilly.PostPayoutRequestBatchApproveResponse;
@@ -97469,6 +97720,16 @@ declare module "rebilly-js-sdk" {
     export type CreatePayoutRequestBatchBlockRequest = rebilly.CreatePayoutRequestBatchBlockRequest;
     export type PostPayoutRequestBatchBlockResponse = rebilly.PostPayoutRequestBatchBlockResponse;
     export type PostPayoutRequestBatchBlockResponsePromise = rebilly.PostPayoutRequestBatchBlockResponsePromise;
+    export type PostPayoutRequestsToBatchRequest = rebilly.PostPayoutRequestsToBatchRequest;
+    export type CreatePayoutRequestsToBatchRequest = rebilly.CreatePayoutRequestsToBatchRequest;
+    export type PostPayoutRequestsToBatchResponse = rebilly.PostPayoutRequestsToBatchResponse;
+    export type PostPayoutRequestsToBatchResponsePromise = rebilly.PostPayoutRequestsToBatchResponsePromise;
+    export type PostRemovePayoutRequestsFromBatchRequest = rebilly.PostRemovePayoutRequestsFromBatchRequest;
+    export type CreateRemovePayoutRequestsFromBatchRequest = rebilly.CreateRemovePayoutRequestsFromBatchRequest;
+    export type PostRemovePayoutRequestsFromBatchResponse = rebilly.PostRemovePayoutRequestsFromBatchResponse;
+    export type PostRemovePayoutRequestsFromBatchResponsePromise = rebilly.PostRemovePayoutRequestsFromBatchResponsePromise;
+    export type PostPayoutRequestBatchUnblockResponse = rebilly.PostPayoutRequestBatchUnblockResponse;
+    export type PostPayoutRequestBatchUnblockResponsePromise = rebilly.PostPayoutRequestBatchUnblockResponsePromise;
     export type GetPayoutRequestBatchPreviewRequest = rebilly.GetPayoutRequestBatchPreviewRequest;
     export type GetPayoutRequestBatchPreviewResponse = rebilly.GetPayoutRequestBatchPreviewResponse;
     export type GetPayoutRequestBatchPreviewResponsePromise = rebilly.GetPayoutRequestBatchPreviewResponsePromise;
@@ -99498,13 +99759,16 @@ declare module "resources/payout-request-batches-resource" {
     export default function PayoutRequestBatchesResource({ apiHandler }: {
         apiHandler: any;
     }): {
-        getAll({ limit, offset, filter, sort }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
+        getAll({ limit, offset, q, filter, sort, }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
         create({ data }: {
             data: any;
         }): any;
         get({ id }: {
             id: any;
         }): rebilly.GetPayoutRequestBatchResponsePromise;
+        delete({ id }: {
+            id: any;
+        }): any;
         patch({ id, data }: {
             id: any;
             data: any;
@@ -99519,6 +99783,17 @@ declare module "resources/payout-request-batches-resource" {
             id: any;
             data: any;
         }): any;
+        addPayoutRequests({ id, data }: {
+            id: any;
+            data: any;
+        }): any;
+        removePayoutRequests({ id, data }: {
+            id: any;
+            data: any;
+        }): any;
+        unblock({ id }: {
+            id: any;
+        }): any;
         preview({ filter }: {
             filter?: any;
         }): rebilly.GetPayoutRequestBatchPreviewResponsePromise;
@@ -101286,13 +101561,16 @@ declare module "resources/api-instance" {
             }): any;
         };
         payoutRequestBatches: {
-            getAll({ limit, offset, filter, sort }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
+            getAll({ limit, offset, q, filter, sort, }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
             create({ data }: {
                 data: any;
             }): any;
             get({ id }: {
                 id: any;
             }): rebilly.GetPayoutRequestBatchResponsePromise;
+            delete({ id }: {
+                id: any;
+            }): any;
             patch({ id, data }: {
                 id: any;
                 data: any;
@@ -101307,6 +101585,17 @@ declare module "resources/api-instance" {
                 id: any;
                 data: any;
             }): any;
+            addPayoutRequests({ id, data }: {
+                id: any;
+                data: any;
+            }): any;
+            removePayoutRequests({ id, data }: {
+                id: any;
+                data: any;
+            }): any;
+            unblock({ id }: {
+                id: any;
+            }): any;
             preview({ filter }: {
                 filter?: any;
             }): rebilly.GetPayoutRequestBatchPreviewResponsePromise;