rebilly-js-sdk 62.189.0 → 62.190.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,3 @@
1
- ## 62.189.0 (2026-09-30)
1
+ ## 62.190.0 (2026-09-30)
2
2
 
3
- ### 🧱 Updated Dependencies
4
-
5
- - Updated eslint-config to 4.31.0
3
+ This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.
@@ -1741,6 +1741,11 @@ declare namespace rebilly {
1741
1741
  type PostPayoutRequestAllocationsProcessResponse = operations['PostPayoutRequestAllocationsProcess']['responses']['204']
1742
1742
  type PostPayoutRequestAllocationsProcessResponsePromise = Promise<{fields: PostPayoutRequestAllocationsProcessResponse}>
1743
1743
 
1744
+ type PostPayoutRequestBatchOperationsRequest = operations['PostPayoutRequestBatchOperations']['requestBody']['content']['application/json']
1745
+ type CreatePayoutRequestBatchOperationsRequest = { id?: string, data: PostPayoutRequestBatchOperationsRequest, expand?: string }
1746
+ type PostPayoutRequestBatchOperationsResponse = operations['PostPayoutRequestBatchOperations']['responses']['200']['content']['application/json']
1747
+ type PostPayoutRequestBatchOperationsResponsePromise = Promise<{fields: PostPayoutRequestBatchOperationsResponse}>
1748
+
1744
1749
  type PostPayoutRequestBatchPreviewRequest = operations['PostPayoutRequestBatchPreview']['requestBody']['content']['application/json']
1745
1750
  type CreatePayoutRequestBatchPreviewRequest = { id?: string, data: PostPayoutRequestBatchPreviewRequest, expand?: string }
1746
1751
  type PostPayoutRequestBatchPreviewResponse = operations['PostPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
@@ -5514,6 +5519,27 @@ export interface corePaths {
5514
5519
  */
5515
5520
  post: operations["PostPayoutRequestAllocationsProcess"];
5516
5521
  };
5522
+ "/payout-request-batch-operations": {
5523
+ /**
5524
+ * Creates a payout request batch operation and applies one action to every payout request in the batch.
5525
+ * A payout request batch groups payout requests so one action applies to every request in the group.
5526
+ *
5527
+ * The `type` field specifies the action:
5528
+ * - `approve`: Approves payout requests in the `ready` status.
5529
+ * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
5530
+ * - `unblock`: Removes the block from blocked payout requests.
5531
+ * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
5532
+ * - `process`: Queues pending allocations of the payout requests in the batch for processing.
5533
+ *
5534
+ * Each payout request is checked independently.
5535
+ * Payout requests that do not qualify for the action are skipped.
5536
+ * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
5537
+ * If queueing fails, no allocation is queued and the operation returns an error.
5538
+ * The operation completes before the response returns.
5539
+ * If the batch does not exist, the operation returns a `422` response.
5540
+ */
5541
+ post: operations["PostPayoutRequestBatchOperations"];
5542
+ };
5517
5543
  "/payout-request-batch-previews": {
5518
5544
  /**
5519
5545
  * 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 {
5572
5598
  * Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm.
5573
5599
  *
5574
5600
  * Each payout request is processed independently.
5601
+ * This endpoint is deprecated.
5602
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
5575
5603
  */
5576
5604
  post: operations["PostPayoutRequestBatchAutoAllocate"];
5577
5605
  parameters: {
@@ -5587,6 +5615,8 @@ export interface corePaths {
5587
5615
  *
5588
5616
  * Each payout request is processed independently.
5589
5617
  * Only payout requests with a status of `ready` can be approved.
5618
+ * This endpoint is deprecated.
5619
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
5590
5620
  */
5591
5621
  post: operations["PostPayoutRequestBatchApprove"];
5592
5622
  parameters: {
@@ -5601,6 +5631,8 @@ export interface corePaths {
5601
5631
  * Blocks all payout requests in a specified batch.
5602
5632
  *
5603
5633
  * Each payout request is processed independently.
5634
+ * This endpoint is deprecated.
5635
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
5604
5636
  */
5605
5637
  post: operations["PostPayoutRequestBatchBlock"];
5606
5638
  parameters: {
@@ -5664,6 +5696,8 @@ export interface corePaths {
5664
5696
  * Leaves payout requests without a block unchanged.
5665
5697
  * Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
5666
5698
  * This operation is atomic.
5699
+ * This endpoint is deprecated.
5700
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
5667
5701
  */
5668
5702
  post: operations["PostPayoutRequestBatchUnblock"];
5669
5703
  parameters: {
@@ -22959,6 +22993,76 @@ export interface coreComponents {
22959
22993
  status?: number;
22960
22994
  invalidFields?: coreComponents["schemas"]["InvalidFields"];
22961
22995
  } & coreComponents["schemas"]["BaseProblem"];
22996
+ ApprovePayoutRequestBatchOperation: {
22997
+ /** Type of operation that approves payout requests in the batch. */
22998
+ type: "approve";
22999
+ /**
23000
+ * ID of the payout request batch.
23001
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23002
+ */
23003
+ batchId: string;
23004
+ };
23005
+ BlockPayoutRequestBatchOperation: {
23006
+ /** Type of operation that blocks payout requests in the batch. */
23007
+ type: "block";
23008
+ /**
23009
+ * ID of the payout request batch.
23010
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23011
+ */
23012
+ batchId: string;
23013
+ reason: coreComponents["schemas"]["PayoutRequestBlockReason"];
23014
+ /** Additional description for blocking the payout requests in the batch. */
23015
+ description?: string | null;
23016
+ };
23017
+ UnblockPayoutRequestBatchOperation: {
23018
+ /** Type of operation that removes the block from payout requests in the batch. */
23019
+ type: "unblock";
23020
+ /**
23021
+ * ID of the payout request batch.
23022
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23023
+ */
23024
+ batchId: string;
23025
+ };
23026
+ AutoAllocatePayoutRequestBatchOperation: {
23027
+ /** Type of operation that creates allocations automatically for payout requests in the batch. */
23028
+ type: "auto-allocate";
23029
+ /**
23030
+ * ID of the payout request batch.
23031
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23032
+ */
23033
+ batchId: string;
23034
+ };
23035
+ ProcessPayoutRequestBatchOperation: {
23036
+ /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
23037
+ type: "process";
23038
+ /**
23039
+ * ID of the payout request batch.
23040
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23041
+ */
23042
+ batchId: string;
23043
+ };
23044
+ /** Action to apply to a payout request batch. */
23045
+ PayoutRequestBatchOperationRequest:
23046
+ | coreComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
23047
+ | coreComponents["schemas"]["BlockPayoutRequestBatchOperation"]
23048
+ | coreComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
23049
+ | coreComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
23050
+ | coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
23051
+ /**
23052
+ * Action applied to every payout request in a payout request batch.
23053
+ * A payout request batch groups payout requests so one action applies to every request in the group.
23054
+ */
23055
+ PayoutRequestBatchOperation: {
23056
+ /** Type of action applied to the batch. */
23057
+ type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
23058
+ /** ID of the payout request batch. */
23059
+ batchId: string;
23060
+ /**
23061
+ * Status of the operation.
23062
+ * The operation completes before the response returns, so the status is always `completed`.
23063
+ */
23064
+ status: "completed";
23065
+ };
22962
23066
  PayoutRequestBatch: {
22963
23067
  /** ID of the batch. */
22964
23068
  id?: string;
@@ -42950,6 +43054,45 @@ export interface operations {
42950
43054
  };
42951
43055
  };
42952
43056
  };
43057
+ /**
43058
+ * Creates a payout request batch operation and applies one action to every payout request in the batch.
43059
+ * A payout request batch groups payout requests so one action applies to every request in the group.
43060
+ *
43061
+ * The `type` field specifies the action:
43062
+ * - `approve`: Approves payout requests in the `ready` status.
43063
+ * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
43064
+ * - `unblock`: Removes the block from blocked payout requests.
43065
+ * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
43066
+ * - `process`: Queues pending allocations of the payout requests in the batch for processing.
43067
+ *
43068
+ * Each payout request is checked independently.
43069
+ * Payout requests that do not qualify for the action are skipped.
43070
+ * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
43071
+ * If queueing fails, no allocation is queued and the operation returns an error.
43072
+ * The operation completes before the response returns.
43073
+ * If the batch does not exist, the operation returns a `422` response.
43074
+ */
43075
+ PostPayoutRequestBatchOperations: {
43076
+ responses: {
43077
+ /** Batch operation completed. */
43078
+ 200: {
43079
+ headers: {};
43080
+ content: {
43081
+ "application/json": coreComponents["schemas"]["PayoutRequestBatchOperation"];
43082
+ };
43083
+ };
43084
+ 401: coreComponents["responses"]["Unauthorized"];
43085
+ 403: coreComponents["responses"]["Forbidden"];
43086
+ 422: coreComponents["responses"]["ValidationError"];
43087
+ 429: coreComponents["responses"]["TooManyRequests"];
43088
+ };
43089
+ /** Action to apply to a payout request batch. */
43090
+ requestBody: {
43091
+ content: {
43092
+ "application/json": coreComponents["schemas"]["PayoutRequestBatchOperationRequest"];
43093
+ };
43094
+ };
43095
+ };
42953
43096
  /**
42954
43097
  * Creates a preview of the payout requests that match a specified filter and that a batch can include.
42955
43098
  * This operation does not create a batch or change payout requests.
@@ -43200,6 +43343,8 @@ export interface operations {
43200
43343
  * Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm.
43201
43344
  *
43202
43345
  * Each payout request is processed independently.
43346
+ * This endpoint is deprecated.
43347
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
43203
43348
  */
43204
43349
  PostPayoutRequestBatchAutoAllocate: {
43205
43350
  parameters: {
@@ -43229,6 +43374,8 @@ export interface operations {
43229
43374
  *
43230
43375
  * Each payout request is processed independently.
43231
43376
  * Only payout requests with a status of `ready` can be approved.
43377
+ * This endpoint is deprecated.
43378
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
43232
43379
  */
43233
43380
  PostPayoutRequestBatchApprove: {
43234
43381
  parameters: {
@@ -43257,6 +43404,8 @@ export interface operations {
43257
43404
  * Blocks all payout requests in a specified batch.
43258
43405
  *
43259
43406
  * Each payout request is processed independently.
43407
+ * This endpoint is deprecated.
43408
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
43260
43409
  */
43261
43410
  PostPayoutRequestBatchBlock: {
43262
43411
  parameters: {
@@ -43422,6 +43571,8 @@ export interface operations {
43422
43571
  * Leaves payout requests without a block unchanged.
43423
43572
  * Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership.
43424
43573
  * This operation is atomic.
43574
+ * This endpoint is deprecated.
43575
+ * Use [Create a payout request batch operation](../PostPayoutRequestBatchOperations) instead.
43425
43576
  */
43426
43577
  PostPayoutRequestBatchUnblock: {
43427
43578
  parameters: {
@@ -62464,6 +62615,76 @@ export interface storefrontComponents {
62464
62615
  status?: number;
62465
62616
  invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
62466
62617
  } & storefrontComponents["schemas"]["BaseProblem"];
62618
+ ApprovePayoutRequestBatchOperation: {
62619
+ /** Type of operation that approves payout requests in the batch. */
62620
+ type: "approve";
62621
+ /**
62622
+ * ID of the payout request batch.
62623
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62624
+ */
62625
+ batchId: string;
62626
+ };
62627
+ BlockPayoutRequestBatchOperation: {
62628
+ /** Type of operation that blocks payout requests in the batch. */
62629
+ type: "block";
62630
+ /**
62631
+ * ID of the payout request batch.
62632
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62633
+ */
62634
+ batchId: string;
62635
+ reason: storefrontComponents["schemas"]["PayoutRequestBlockReason"];
62636
+ /** Additional description for blocking the payout requests in the batch. */
62637
+ description?: string | null;
62638
+ };
62639
+ UnblockPayoutRequestBatchOperation: {
62640
+ /** Type of operation that removes the block from payout requests in the batch. */
62641
+ type: "unblock";
62642
+ /**
62643
+ * ID of the payout request batch.
62644
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62645
+ */
62646
+ batchId: string;
62647
+ };
62648
+ AutoAllocatePayoutRequestBatchOperation: {
62649
+ /** Type of operation that creates allocations automatically for payout requests in the batch. */
62650
+ type: "auto-allocate";
62651
+ /**
62652
+ * ID of the payout request batch.
62653
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62654
+ */
62655
+ batchId: string;
62656
+ };
62657
+ ProcessPayoutRequestBatchOperation: {
62658
+ /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
62659
+ type: "process";
62660
+ /**
62661
+ * ID of the payout request batch.
62662
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62663
+ */
62664
+ batchId: string;
62665
+ };
62666
+ /** Action to apply to a payout request batch. */
62667
+ PayoutRequestBatchOperationRequest:
62668
+ | storefrontComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
62669
+ | storefrontComponents["schemas"]["BlockPayoutRequestBatchOperation"]
62670
+ | storefrontComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
62671
+ | storefrontComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
62672
+ | storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
62673
+ /**
62674
+ * Action applied to every payout request in a payout request batch.
62675
+ * A payout request batch groups payout requests so one action applies to every request in the group.
62676
+ */
62677
+ PayoutRequestBatchOperation: {
62678
+ /** Type of action applied to the batch. */
62679
+ type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
62680
+ /** ID of the payout request batch. */
62681
+ batchId: string;
62682
+ /**
62683
+ * Status of the operation.
62684
+ * The operation completes before the response returns, so the status is always `completed`.
62685
+ */
62686
+ status: "completed";
62687
+ };
62467
62688
  PayoutRequestBatch: {
62468
62689
  /** ID of the batch. */
62469
62690
  id?: string;
@@ -89065,6 +89286,76 @@ export interface reportsComponents {
89065
89286
  status?: number;
89066
89287
  invalidFields?: reportsComponents["schemas"]["InvalidFields"];
89067
89288
  } & reportsComponents["schemas"]["BaseProblem"];
89289
+ ApprovePayoutRequestBatchOperation: {
89290
+ /** Type of operation that approves payout requests in the batch. */
89291
+ type: "approve";
89292
+ /**
89293
+ * ID of the payout request batch.
89294
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89295
+ */
89296
+ batchId: string;
89297
+ };
89298
+ BlockPayoutRequestBatchOperation: {
89299
+ /** Type of operation that blocks payout requests in the batch. */
89300
+ type: "block";
89301
+ /**
89302
+ * ID of the payout request batch.
89303
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89304
+ */
89305
+ batchId: string;
89306
+ reason: reportsComponents["schemas"]["PayoutRequestBlockReason"];
89307
+ /** Additional description for blocking the payout requests in the batch. */
89308
+ description?: string | null;
89309
+ };
89310
+ UnblockPayoutRequestBatchOperation: {
89311
+ /** Type of operation that removes the block from payout requests in the batch. */
89312
+ type: "unblock";
89313
+ /**
89314
+ * ID of the payout request batch.
89315
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89316
+ */
89317
+ batchId: string;
89318
+ };
89319
+ AutoAllocatePayoutRequestBatchOperation: {
89320
+ /** Type of operation that creates allocations automatically for payout requests in the batch. */
89321
+ type: "auto-allocate";
89322
+ /**
89323
+ * ID of the payout request batch.
89324
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89325
+ */
89326
+ batchId: string;
89327
+ };
89328
+ ProcessPayoutRequestBatchOperation: {
89329
+ /** Type of operation that initiates processing of pending allocations for payout requests in the batch. */
89330
+ type: "process";
89331
+ /**
89332
+ * ID of the payout request batch.
89333
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89334
+ */
89335
+ batchId: string;
89336
+ };
89337
+ /** Action to apply to a payout request batch. */
89338
+ PayoutRequestBatchOperationRequest:
89339
+ | reportsComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
89340
+ | reportsComponents["schemas"]["BlockPayoutRequestBatchOperation"]
89341
+ | reportsComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
89342
+ | reportsComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
89343
+ | reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"];
89344
+ /**
89345
+ * Action applied to every payout request in a payout request batch.
89346
+ * A payout request batch groups payout requests so one action applies to every request in the group.
89347
+ */
89348
+ PayoutRequestBatchOperation: {
89349
+ /** Type of action applied to the batch. */
89350
+ type: "approve" | "block" | "unblock" | "auto-allocate" | "process";
89351
+ /** ID of the payout request batch. */
89352
+ batchId: string;
89353
+ /**
89354
+ * Status of the operation.
89355
+ * The operation completes before the response returns, so the status is always `completed`.
89356
+ */
89357
+ status: "completed";
89358
+ };
89068
89359
  PayoutRequestBatch: {
89069
89360
  /** ID of the batch. */
89070
89361
  id?: string;
@@ -99752,6 +100043,10 @@ declare module "rebilly-js-sdk" {
99752
100043
  export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
99753
100044
  export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
99754
100045
  export type PostPayoutRequestAllocationsProcessResponsePromise = rebilly.PostPayoutRequestAllocationsProcessResponsePromise;
100046
+ export type PostPayoutRequestBatchOperationsRequest = rebilly.PostPayoutRequestBatchOperationsRequest;
100047
+ export type CreatePayoutRequestBatchOperationsRequest = rebilly.CreatePayoutRequestBatchOperationsRequest;
100048
+ export type PostPayoutRequestBatchOperationsResponse = rebilly.PostPayoutRequestBatchOperationsResponse;
100049
+ export type PostPayoutRequestBatchOperationsResponsePromise = rebilly.PostPayoutRequestBatchOperationsResponsePromise;
99755
100050
  export type PostPayoutRequestBatchPreviewRequest = rebilly.PostPayoutRequestBatchPreviewRequest;
99756
100051
  export type CreatePayoutRequestBatchPreviewRequest = rebilly.CreatePayoutRequestBatchPreviewRequest;
99757
100052
  export type PostPayoutRequestBatchPreviewResponse = rebilly.PostPayoutRequestBatchPreviewResponse;