rebilly-js-sdk 62.209.0 → 62.210.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 +1 -1
- package/dist/rebilly-js-sdk.d.cts +186 -227
- package/dist/rebilly-js-sdk.d.mts +186 -227
- package/dist/rebilly-js-sdk.d.ts +186 -227
- package/dist/rebilly-js-sdk.es.mjs +1 -7
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/resources/payout-request-batches-resource.js +0 -12
package/CHANGELOG.md
CHANGED
|
@@ -1756,16 +1756,6 @@ declare namespace rebilly {
|
|
|
1756
1756
|
type DeletePayoutRequestBatchResponse = operations['DeletePayoutRequestBatch']['responses']['204']
|
|
1757
1757
|
type DeletePayoutRequestBatchResponsePromise = Promise<{fields: DeletePayoutRequestBatchResponse}>
|
|
1758
1758
|
|
|
1759
|
-
type PostPayoutRequestsToBatchRequest = operations['PostPayoutRequestsToBatch']['requestBody']['content']['application/json']
|
|
1760
|
-
type CreatePayoutRequestsToBatchRequest = { id?: string, data: PostPayoutRequestsToBatchRequest, expand?: string }
|
|
1761
|
-
type PostPayoutRequestsToBatchResponse = operations['PostPayoutRequestsToBatch']['responses']['200']['content']['application/json']
|
|
1762
|
-
type PostPayoutRequestsToBatchResponsePromise = Promise<{fields: PostPayoutRequestsToBatchResponse}>
|
|
1763
|
-
|
|
1764
|
-
type PostRemovePayoutRequestsFromBatchRequest = operations['PostRemovePayoutRequestsFromBatch']['requestBody']['content']['application/json']
|
|
1765
|
-
type CreateRemovePayoutRequestsFromBatchRequest = { id?: string, data: PostRemovePayoutRequestsFromBatchRequest, expand?: string }
|
|
1766
|
-
type PostRemovePayoutRequestsFromBatchResponse = operations['PostRemovePayoutRequestsFromBatch']['responses']['200']['content']['application/json']
|
|
1767
|
-
type PostRemovePayoutRequestsFromBatchResponsePromise = Promise<{fields: PostRemovePayoutRequestsFromBatchResponse}>
|
|
1768
|
-
|
|
1769
1759
|
type PostPermissionsEmulationRequest = operations['PostPermissionsEmulation']['requestBody']['content']['application/json']
|
|
1770
1760
|
type CreatePermissionsEmulationRequest = { id?: string, data: PostPermissionsEmulationRequest, expand?: string }
|
|
1771
1761
|
type PostPermissionsEmulationResponse = operations['PostPermissionsEmulation']['responses']['201']['content']['application/json']
|
|
@@ -5529,8 +5519,8 @@ export interface corePaths {
|
|
|
5529
5519
|
};
|
|
5530
5520
|
"/payout-request-batch-operations": {
|
|
5531
5521
|
/**
|
|
5532
|
-
* Creates a payout request batch operation
|
|
5533
|
-
* A payout request batch
|
|
5522
|
+
* Creates a payout request batch operation that applies one action to a payout request batch.
|
|
5523
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
5534
5524
|
*
|
|
5535
5525
|
* The `type` field specifies the action:
|
|
5536
5526
|
* - `approve`: Approves payout requests in the `ready` status.
|
|
@@ -5538,8 +5528,14 @@ export interface corePaths {
|
|
|
5538
5528
|
* - `unblock`: Removes the block from blocked payout requests.
|
|
5539
5529
|
* - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
|
|
5540
5530
|
* - `process`: Queues pending allocations of the payout requests in the batch for processing.
|
|
5531
|
+
* - `add`: Adds the specified payout requests, or the payout requests that match a filter, to the batch.
|
|
5532
|
+
* - `remove`: Removes the specified payout requests from the batch.
|
|
5541
5533
|
*
|
|
5542
|
-
*
|
|
5534
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
5535
|
+
* For `add` and `remove`, the operation is atomic.
|
|
5536
|
+
* If the operation cannot add or remove a specified payout request,
|
|
5537
|
+
* the operation returns a `409` response and changes no batch membership.
|
|
5538
|
+
* For the other types, each payout request is checked independently.
|
|
5543
5539
|
* Payout requests that do not qualify for the action are skipped.
|
|
5544
5540
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
5545
5541
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
@@ -5601,54 +5597,6 @@ export interface corePaths {
|
|
|
5601
5597
|
};
|
|
5602
5598
|
};
|
|
5603
5599
|
};
|
|
5604
|
-
"/payout-request-batches/{id}/payout-requests": {
|
|
5605
|
-
/**
|
|
5606
|
-
* Adds payout requests to a batch with a specified ID.
|
|
5607
|
-
* Accepts payout requests in any status, with or without allocations.
|
|
5608
|
-
* A batch contains a maximum of 1000 payout requests.
|
|
5609
|
-
*
|
|
5610
|
-
* Provide exactly one of the following fields:
|
|
5611
|
-
* - `payoutRequestIds` to add specific payout requests.
|
|
5612
|
-
* - `filter` to add payout requests that match the filter when the operation runs.
|
|
5613
|
-
*
|
|
5614
|
-
* If any explicitly specified payout request is already associated with a batch,
|
|
5615
|
-
* the operation returns a `409 Conflict` response.
|
|
5616
|
-
* Filter results exclude payout requests that are already associated with a batch.
|
|
5617
|
-
* If more payout requests match the filter than the batch can contain,
|
|
5618
|
-
* the operation adds only the oldest matching requests up to the batch limit,
|
|
5619
|
-
* sorted by creation time.
|
|
5620
|
-
* If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
|
|
5621
|
-
* the operation returns a `409 Conflict` response.
|
|
5622
|
-
* If the batch has reached its payout request limit,
|
|
5623
|
-
* the operation returns a `409 Conflict` response for either selection method.
|
|
5624
|
-
* This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
|
|
5625
|
-
*/
|
|
5626
|
-
post: operations["PostPayoutRequestsToBatch"];
|
|
5627
|
-
parameters: {
|
|
5628
|
-
path: {
|
|
5629
|
-
/** ID of the resource. */
|
|
5630
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
5631
|
-
};
|
|
5632
|
-
};
|
|
5633
|
-
};
|
|
5634
|
-
"/payout-request-batches/{id}/payout-requests/remove": {
|
|
5635
|
-
/**
|
|
5636
|
-
* Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
|
|
5637
|
-
* This operation preserves each payout request, status, and blocked state.
|
|
5638
|
-
* Removes requests regardless of status or allocations.
|
|
5639
|
-
*
|
|
5640
|
-
* This operation is atomic.
|
|
5641
|
-
* If any payout request is not associated with the specified batch,
|
|
5642
|
-
* the operation clears no associations with the batch.
|
|
5643
|
-
*/
|
|
5644
|
-
post: operations["PostRemovePayoutRequestsFromBatch"];
|
|
5645
|
-
parameters: {
|
|
5646
|
-
path: {
|
|
5647
|
-
/** ID of the resource. */
|
|
5648
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
5649
|
-
};
|
|
5650
|
-
};
|
|
5651
|
-
};
|
|
5652
5600
|
"/permissions-emulation": {
|
|
5653
5601
|
/**
|
|
5654
5602
|
* Starts permissions emulation.
|
|
@@ -23030,20 +22978,68 @@ export interface coreComponents {
|
|
|
23030
22978
|
*/
|
|
23031
22979
|
batchId: string;
|
|
23032
22980
|
};
|
|
22981
|
+
AddPayoutRequestBatchOperation: (
|
|
22982
|
+
| { [key: string]: any }
|
|
22983
|
+
| { [key: string]: any }
|
|
22984
|
+
) & {
|
|
22985
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
22986
|
+
type: "add";
|
|
22987
|
+
/**
|
|
22988
|
+
* ID of the payout request batch.
|
|
22989
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
22990
|
+
*/
|
|
22991
|
+
batchId: string;
|
|
22992
|
+
/** IDs of the payout requests to add to the batch. */
|
|
22993
|
+
payoutRequestIds?: string[];
|
|
22994
|
+
/**
|
|
22995
|
+
* Filter string that selects payout requests to add to the batch.
|
|
22996
|
+
* This field uses the same format as filter parameters for collections.
|
|
22997
|
+
* Use semicolons to separate multiple filter conditions.
|
|
22998
|
+
*
|
|
22999
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
23000
|
+
*
|
|
23001
|
+
* The operation ignores a `batchId` filter.
|
|
23002
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
23003
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
23004
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
23005
|
+
* sorted by creation time.
|
|
23006
|
+
*/
|
|
23007
|
+
filter?: string;
|
|
23008
|
+
};
|
|
23009
|
+
RemovePayoutRequestBatchOperation: {
|
|
23010
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
23011
|
+
type: "remove";
|
|
23012
|
+
/**
|
|
23013
|
+
* ID of the payout request batch.
|
|
23014
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
23015
|
+
*/
|
|
23016
|
+
batchId: string;
|
|
23017
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
23018
|
+
payoutRequestIds: string[];
|
|
23019
|
+
};
|
|
23033
23020
|
/** Action to apply to a payout request batch. */
|
|
23034
23021
|
PayoutRequestBatchOperationRequest:
|
|
23035
23022
|
| coreComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
23036
23023
|
| coreComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
23037
23024
|
| coreComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
23038
23025
|
| coreComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
23039
|
-
| coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
23026
|
+
| coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
23027
|
+
| coreComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
23028
|
+
| coreComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
23040
23029
|
/**
|
|
23041
|
-
* Action applied to
|
|
23042
|
-
* A payout request batch
|
|
23030
|
+
* Action applied to a payout request batch.
|
|
23031
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
23043
23032
|
*/
|
|
23044
23033
|
PayoutRequestBatchOperation: {
|
|
23045
23034
|
/** Type of action applied to the batch. */
|
|
23046
|
-
type:
|
|
23035
|
+
type:
|
|
23036
|
+
| "approve"
|
|
23037
|
+
| "block"
|
|
23038
|
+
| "unblock"
|
|
23039
|
+
| "auto-allocate"
|
|
23040
|
+
| "process"
|
|
23041
|
+
| "add"
|
|
23042
|
+
| "remove";
|
|
23047
23043
|
/** ID of the payout request batch. */
|
|
23048
23044
|
batchId: string;
|
|
23049
23045
|
/**
|
|
@@ -43326,8 +43322,8 @@ export interface operations {
|
|
|
43326
43322
|
};
|
|
43327
43323
|
};
|
|
43328
43324
|
/**
|
|
43329
|
-
* Creates a payout request batch operation
|
|
43330
|
-
* A payout request batch
|
|
43325
|
+
* Creates a payout request batch operation that applies one action to a payout request batch.
|
|
43326
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
43331
43327
|
*
|
|
43332
43328
|
* The `type` field specifies the action:
|
|
43333
43329
|
* - `approve`: Approves payout requests in the `ready` status.
|
|
@@ -43335,8 +43331,14 @@ export interface operations {
|
|
|
43335
43331
|
* - `unblock`: Removes the block from blocked payout requests.
|
|
43336
43332
|
* - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
|
|
43337
43333
|
* - `process`: Queues pending allocations of the payout requests in the batch for processing.
|
|
43334
|
+
* - `add`: Adds the specified payout requests, or the payout requests that match a filter, to the batch.
|
|
43335
|
+
* - `remove`: Removes the specified payout requests from the batch.
|
|
43338
43336
|
*
|
|
43339
|
-
*
|
|
43337
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
43338
|
+
* For `add` and `remove`, the operation is atomic.
|
|
43339
|
+
* If the operation cannot add or remove a specified payout request,
|
|
43340
|
+
* the operation returns a `409` response and changes no batch membership.
|
|
43341
|
+
* For the other types, each payout request is checked independently.
|
|
43340
43342
|
* Payout requests that do not qualify for the action are skipped.
|
|
43341
43343
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
43342
43344
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
@@ -43352,8 +43354,20 @@ export interface operations {
|
|
|
43352
43354
|
"application/json": coreComponents["schemas"]["PayoutRequestBatchOperation"];
|
|
43353
43355
|
};
|
|
43354
43356
|
};
|
|
43357
|
+
/** Invalid filter provided or no payout requests match the filter. */
|
|
43358
|
+
400: {
|
|
43359
|
+
content: {
|
|
43360
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
43361
|
+
};
|
|
43362
|
+
};
|
|
43355
43363
|
401: coreComponents["responses"]["Unauthorized"];
|
|
43356
43364
|
403: coreComponents["responses"]["Forbidden"];
|
|
43365
|
+
/** Batch limit reached or would be exceeded by the request, a specified payout request is already associated with another batch, or a specified payout request is not associated with this batch. */
|
|
43366
|
+
409: {
|
|
43367
|
+
content: {
|
|
43368
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
43369
|
+
};
|
|
43370
|
+
};
|
|
43357
43371
|
422: coreComponents["responses"]["ValidationError"];
|
|
43358
43372
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
43359
43373
|
};
|
|
@@ -43610,133 +43624,6 @@ export interface operations {
|
|
|
43610
43624
|
};
|
|
43611
43625
|
requestBody: coreComponents["requestBodies"]["PatchPayoutRequestBatch"];
|
|
43612
43626
|
};
|
|
43613
|
-
/**
|
|
43614
|
-
* Adds payout requests to a batch with a specified ID.
|
|
43615
|
-
* Accepts payout requests in any status, with or without allocations.
|
|
43616
|
-
* A batch contains a maximum of 1000 payout requests.
|
|
43617
|
-
*
|
|
43618
|
-
* Provide exactly one of the following fields:
|
|
43619
|
-
* - `payoutRequestIds` to add specific payout requests.
|
|
43620
|
-
* - `filter` to add payout requests that match the filter when the operation runs.
|
|
43621
|
-
*
|
|
43622
|
-
* If any explicitly specified payout request is already associated with a batch,
|
|
43623
|
-
* the operation returns a `409 Conflict` response.
|
|
43624
|
-
* Filter results exclude payout requests that are already associated with a batch.
|
|
43625
|
-
* If more payout requests match the filter than the batch can contain,
|
|
43626
|
-
* the operation adds only the oldest matching requests up to the batch limit,
|
|
43627
|
-
* sorted by creation time.
|
|
43628
|
-
* If adding explicitly specified payout requests would increase the batch to more than 1000 requests,
|
|
43629
|
-
* the operation returns a `409 Conflict` response.
|
|
43630
|
-
* If the batch has reached its payout request limit,
|
|
43631
|
-
* the operation returns a `409 Conflict` response for either selection method.
|
|
43632
|
-
* This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch.
|
|
43633
|
-
*/
|
|
43634
|
-
PostPayoutRequestsToBatch: {
|
|
43635
|
-
parameters: {
|
|
43636
|
-
path: {
|
|
43637
|
-
/** ID of the resource. */
|
|
43638
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
43639
|
-
};
|
|
43640
|
-
};
|
|
43641
|
-
responses: {
|
|
43642
|
-
/** Payout requests added to the batch. */
|
|
43643
|
-
200: {
|
|
43644
|
-
headers: {};
|
|
43645
|
-
content: {
|
|
43646
|
-
"application/json": coreComponents["schemas"]["PayoutRequestBatch"];
|
|
43647
|
-
};
|
|
43648
|
-
};
|
|
43649
|
-
/** Invalid filter provided or no payout requests match the filter. */
|
|
43650
|
-
400: {
|
|
43651
|
-
content: {
|
|
43652
|
-
"application/json": coreComponents["schemas"]["Problem"];
|
|
43653
|
-
};
|
|
43654
|
-
};
|
|
43655
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
43656
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
43657
|
-
404: coreComponents["responses"]["NotFound"];
|
|
43658
|
-
/** Batch limit reached or would be exceeded, or one or more explicitly specified payout requests are already associated with a batch. */
|
|
43659
|
-
409: {
|
|
43660
|
-
content: {
|
|
43661
|
-
"application/json": coreComponents["schemas"]["Conflict"];
|
|
43662
|
-
};
|
|
43663
|
-
};
|
|
43664
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
43665
|
-
429: coreComponents["responses"]["TooManyRequests"];
|
|
43666
|
-
};
|
|
43667
|
-
/** Selection of payout requests to add to the batch. */
|
|
43668
|
-
requestBody: {
|
|
43669
|
-
content: {
|
|
43670
|
-
"application/json":
|
|
43671
|
-
| {
|
|
43672
|
-
/** IDs of the payout requests to add to the batch. */
|
|
43673
|
-
payoutRequestIds: string[];
|
|
43674
|
-
}
|
|
43675
|
-
| {
|
|
43676
|
-
/**
|
|
43677
|
-
* Filter string that selects payout requests to add to the batch.
|
|
43678
|
-
* This field uses the same format as filter parameters for collections.
|
|
43679
|
-
* Use semicolons to separate multiple filter conditions.
|
|
43680
|
-
*
|
|
43681
|
-
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
43682
|
-
*
|
|
43683
|
-
* This operation ignores a `batchId` filter.
|
|
43684
|
-
* Filter results always exclude payout requests that are already associated with a batch.
|
|
43685
|
-
* If the filter matches more payout requests than the batch can contain,
|
|
43686
|
-
* the operation adds only the oldest matching requests up to the batch limit,
|
|
43687
|
-
* sorted by creation time.
|
|
43688
|
-
*/
|
|
43689
|
-
filter: string;
|
|
43690
|
-
};
|
|
43691
|
-
};
|
|
43692
|
-
};
|
|
43693
|
-
};
|
|
43694
|
-
/**
|
|
43695
|
-
* Removes specified payout requests from a batch with a specified ID by clearing `batchId` on each request.
|
|
43696
|
-
* This operation preserves each payout request, status, and blocked state.
|
|
43697
|
-
* Removes requests regardless of status or allocations.
|
|
43698
|
-
*
|
|
43699
|
-
* This operation is atomic.
|
|
43700
|
-
* If any payout request is not associated with the specified batch,
|
|
43701
|
-
* the operation clears no associations with the batch.
|
|
43702
|
-
*/
|
|
43703
|
-
PostRemovePayoutRequestsFromBatch: {
|
|
43704
|
-
parameters: {
|
|
43705
|
-
path: {
|
|
43706
|
-
/** ID of the resource. */
|
|
43707
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
43708
|
-
};
|
|
43709
|
-
};
|
|
43710
|
-
responses: {
|
|
43711
|
-
/** Payout requests removed from the batch. */
|
|
43712
|
-
200: {
|
|
43713
|
-
headers: {};
|
|
43714
|
-
content: {
|
|
43715
|
-
"application/json": coreComponents["schemas"]["PayoutRequestBatch"];
|
|
43716
|
-
};
|
|
43717
|
-
};
|
|
43718
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
43719
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
43720
|
-
404: coreComponents["responses"]["NotFound"];
|
|
43721
|
-
/** One or more payout requests are not associated with the specified batch. */
|
|
43722
|
-
409: {
|
|
43723
|
-
content: {
|
|
43724
|
-
"application/json": coreComponents["schemas"]["Conflict"];
|
|
43725
|
-
};
|
|
43726
|
-
};
|
|
43727
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
43728
|
-
429: coreComponents["responses"]["TooManyRequests"];
|
|
43729
|
-
};
|
|
43730
|
-
/** Payout requests to remove from the batch. */
|
|
43731
|
-
requestBody: {
|
|
43732
|
-
content: {
|
|
43733
|
-
"application/json": {
|
|
43734
|
-
/** IDs of the payout requests to remove from the batch. */
|
|
43735
|
-
payoutRequestIds: string[];
|
|
43736
|
-
};
|
|
43737
|
-
};
|
|
43738
|
-
};
|
|
43739
|
-
};
|
|
43740
43627
|
/**
|
|
43741
43628
|
* Starts permissions emulation.
|
|
43742
43629
|
*
|
|
@@ -62835,20 +62722,68 @@ export interface storefrontComponents {
|
|
|
62835
62722
|
*/
|
|
62836
62723
|
batchId: string;
|
|
62837
62724
|
};
|
|
62725
|
+
AddPayoutRequestBatchOperation: (
|
|
62726
|
+
| { [key: string]: any }
|
|
62727
|
+
| { [key: string]: any }
|
|
62728
|
+
) & {
|
|
62729
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
62730
|
+
type: "add";
|
|
62731
|
+
/**
|
|
62732
|
+
* ID of the payout request batch.
|
|
62733
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
62734
|
+
*/
|
|
62735
|
+
batchId: string;
|
|
62736
|
+
/** IDs of the payout requests to add to the batch. */
|
|
62737
|
+
payoutRequestIds?: string[];
|
|
62738
|
+
/**
|
|
62739
|
+
* Filter string that selects payout requests to add to the batch.
|
|
62740
|
+
* This field uses the same format as filter parameters for collections.
|
|
62741
|
+
* Use semicolons to separate multiple filter conditions.
|
|
62742
|
+
*
|
|
62743
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
62744
|
+
*
|
|
62745
|
+
* The operation ignores a `batchId` filter.
|
|
62746
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
62747
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
62748
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
62749
|
+
* sorted by creation time.
|
|
62750
|
+
*/
|
|
62751
|
+
filter?: string;
|
|
62752
|
+
};
|
|
62753
|
+
RemovePayoutRequestBatchOperation: {
|
|
62754
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
62755
|
+
type: "remove";
|
|
62756
|
+
/**
|
|
62757
|
+
* ID of the payout request batch.
|
|
62758
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
62759
|
+
*/
|
|
62760
|
+
batchId: string;
|
|
62761
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
62762
|
+
payoutRequestIds: string[];
|
|
62763
|
+
};
|
|
62838
62764
|
/** Action to apply to a payout request batch. */
|
|
62839
62765
|
PayoutRequestBatchOperationRequest:
|
|
62840
62766
|
| storefrontComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
62841
62767
|
| storefrontComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
62842
62768
|
| storefrontComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
62843
62769
|
| storefrontComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
62844
|
-
| storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
62770
|
+
| storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
62771
|
+
| storefrontComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
62772
|
+
| storefrontComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
62845
62773
|
/**
|
|
62846
|
-
* Action applied to
|
|
62847
|
-
* A payout request batch
|
|
62774
|
+
* Action applied to a payout request batch.
|
|
62775
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
62848
62776
|
*/
|
|
62849
62777
|
PayoutRequestBatchOperation: {
|
|
62850
62778
|
/** Type of action applied to the batch. */
|
|
62851
|
-
type:
|
|
62779
|
+
type:
|
|
62780
|
+
| "approve"
|
|
62781
|
+
| "block"
|
|
62782
|
+
| "unblock"
|
|
62783
|
+
| "auto-allocate"
|
|
62784
|
+
| "process"
|
|
62785
|
+
| "add"
|
|
62786
|
+
| "remove";
|
|
62852
62787
|
/** ID of the payout request batch. */
|
|
62853
62788
|
batchId: string;
|
|
62854
62789
|
/**
|
|
@@ -89925,20 +89860,68 @@ export interface reportsComponents {
|
|
|
89925
89860
|
*/
|
|
89926
89861
|
batchId: string;
|
|
89927
89862
|
};
|
|
89863
|
+
AddPayoutRequestBatchOperation: (
|
|
89864
|
+
| { [key: string]: any }
|
|
89865
|
+
| { [key: string]: any }
|
|
89866
|
+
) & {
|
|
89867
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
89868
|
+
type: "add";
|
|
89869
|
+
/**
|
|
89870
|
+
* ID of the payout request batch.
|
|
89871
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
89872
|
+
*/
|
|
89873
|
+
batchId: string;
|
|
89874
|
+
/** IDs of the payout requests to add to the batch. */
|
|
89875
|
+
payoutRequestIds?: string[];
|
|
89876
|
+
/**
|
|
89877
|
+
* Filter string that selects payout requests to add to the batch.
|
|
89878
|
+
* This field uses the same format as filter parameters for collections.
|
|
89879
|
+
* Use semicolons to separate multiple filter conditions.
|
|
89880
|
+
*
|
|
89881
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
89882
|
+
*
|
|
89883
|
+
* The operation ignores a `batchId` filter.
|
|
89884
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
89885
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
89886
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
89887
|
+
* sorted by creation time.
|
|
89888
|
+
*/
|
|
89889
|
+
filter?: string;
|
|
89890
|
+
};
|
|
89891
|
+
RemovePayoutRequestBatchOperation: {
|
|
89892
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
89893
|
+
type: "remove";
|
|
89894
|
+
/**
|
|
89895
|
+
* ID of the payout request batch.
|
|
89896
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
89897
|
+
*/
|
|
89898
|
+
batchId: string;
|
|
89899
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
89900
|
+
payoutRequestIds: string[];
|
|
89901
|
+
};
|
|
89928
89902
|
/** Action to apply to a payout request batch. */
|
|
89929
89903
|
PayoutRequestBatchOperationRequest:
|
|
89930
89904
|
| reportsComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
89931
89905
|
| reportsComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
89932
89906
|
| reportsComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
89933
89907
|
| reportsComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
89934
|
-
| reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
89908
|
+
| reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
89909
|
+
| reportsComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
89910
|
+
| reportsComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
89935
89911
|
/**
|
|
89936
|
-
* Action applied to
|
|
89937
|
-
* A payout request batch
|
|
89912
|
+
* Action applied to a payout request batch.
|
|
89913
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
89938
89914
|
*/
|
|
89939
89915
|
PayoutRequestBatchOperation: {
|
|
89940
89916
|
/** Type of action applied to the batch. */
|
|
89941
|
-
type:
|
|
89917
|
+
type:
|
|
89918
|
+
| "approve"
|
|
89919
|
+
| "block"
|
|
89920
|
+
| "unblock"
|
|
89921
|
+
| "auto-allocate"
|
|
89922
|
+
| "process"
|
|
89923
|
+
| "add"
|
|
89924
|
+
| "remove";
|
|
89942
89925
|
/** ID of the payout request batch. */
|
|
89943
89926
|
batchId: string;
|
|
89944
89927
|
/**
|
|
@@ -100938,14 +100921,6 @@ declare module "rebilly-js-sdk" {
|
|
|
100938
100921
|
export type PatchPayoutRequestBatchResponsePromise = rebilly.PatchPayoutRequestBatchResponsePromise;
|
|
100939
100922
|
export type DeletePayoutRequestBatchResponse = rebilly.DeletePayoutRequestBatchResponse;
|
|
100940
100923
|
export type DeletePayoutRequestBatchResponsePromise = rebilly.DeletePayoutRequestBatchResponsePromise;
|
|
100941
|
-
export type PostPayoutRequestsToBatchRequest = rebilly.PostPayoutRequestsToBatchRequest;
|
|
100942
|
-
export type CreatePayoutRequestsToBatchRequest = rebilly.CreatePayoutRequestsToBatchRequest;
|
|
100943
|
-
export type PostPayoutRequestsToBatchResponse = rebilly.PostPayoutRequestsToBatchResponse;
|
|
100944
|
-
export type PostPayoutRequestsToBatchResponsePromise = rebilly.PostPayoutRequestsToBatchResponsePromise;
|
|
100945
|
-
export type PostRemovePayoutRequestsFromBatchRequest = rebilly.PostRemovePayoutRequestsFromBatchRequest;
|
|
100946
|
-
export type CreateRemovePayoutRequestsFromBatchRequest = rebilly.CreateRemovePayoutRequestsFromBatchRequest;
|
|
100947
|
-
export type PostRemovePayoutRequestsFromBatchResponse = rebilly.PostRemovePayoutRequestsFromBatchResponse;
|
|
100948
|
-
export type PostRemovePayoutRequestsFromBatchResponsePromise = rebilly.PostRemovePayoutRequestsFromBatchResponsePromise;
|
|
100949
100924
|
export type PostPermissionsEmulationRequest = rebilly.PostPermissionsEmulationRequest;
|
|
100950
100925
|
export type CreatePermissionsEmulationRequest = rebilly.CreatePermissionsEmulationRequest;
|
|
100951
100926
|
export type PostPermissionsEmulationResponse = rebilly.PostPermissionsEmulationResponse;
|
|
@@ -102968,14 +102943,6 @@ declare module "resources/payout-request-batches-resource" {
|
|
|
102968
102943
|
id: any;
|
|
102969
102944
|
data: any;
|
|
102970
102945
|
}): any;
|
|
102971
|
-
addPayoutRequests({ id, data }: {
|
|
102972
|
-
id: any;
|
|
102973
|
-
data: any;
|
|
102974
|
-
}): any;
|
|
102975
|
-
removePayoutRequests({ id, data }: {
|
|
102976
|
-
id: any;
|
|
102977
|
-
data: any;
|
|
102978
|
-
}): any;
|
|
102979
102946
|
};
|
|
102980
102947
|
}
|
|
102981
102948
|
declare module "resources/payout-request-splits-resource" {
|
|
@@ -104746,14 +104713,6 @@ declare module "resources/api-instance" {
|
|
|
104746
104713
|
id: any;
|
|
104747
104714
|
data: any;
|
|
104748
104715
|
}): any;
|
|
104749
|
-
addPayoutRequests({ id, data }: {
|
|
104750
|
-
id: any;
|
|
104751
|
-
data: any;
|
|
104752
|
-
}): any;
|
|
104753
|
-
removePayoutRequests({ id, data }: {
|
|
104754
|
-
id: any;
|
|
104755
|
-
data: any;
|
|
104756
|
-
}): any;
|
|
104757
104716
|
};
|
|
104758
104717
|
payoutRequestSplits: {
|
|
104759
104718
|
create({ data }: {
|