rebilly-js-sdk 62.186.0 → 62.188.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 +4 -2
- package/dist/rebilly-js-sdk.d.cts +108 -2
- package/dist/rebilly-js-sdk.d.mts +108 -2
- package/dist/rebilly-js-sdk.d.ts +108 -2
- package/dist/rebilly-js-sdk.es.mjs +120 -111
- package/dist/rebilly-js-sdk.umd.js +2 -2
- package/package.json +1 -1
- package/src/resources/api-instance.js +4 -0
- package/src/resources/payout-request-batch-previews-resource.js +12 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
## 62.
|
|
1
|
+
## 62.188.0 (2026-09-30)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
### Features
|
|
4
|
+
|
|
5
|
+
- **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#27667](https://github.com/Rebilly/rebilly/pull/27667))
|
|
@@ -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 PostPayoutRequestBatchPreviewRequest = operations['PostPayoutRequestBatchPreview']['requestBody']['content']['application/json']
|
|
1745
|
+
type CreatePayoutRequestBatchPreviewRequest = { id?: string, data: PostPayoutRequestBatchPreviewRequest, expand?: string }
|
|
1746
|
+
type PostPayoutRequestBatchPreviewResponse = operations['PostPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
|
|
1747
|
+
type PostPayoutRequestBatchPreviewResponsePromise = Promise<{fields: PostPayoutRequestBatchPreviewResponse}>
|
|
1748
|
+
|
|
1744
1749
|
type GetPayoutRequestBatchCollectionRequest = operations['GetPayoutRequestBatchCollection']['parameters']["query"] & (operations['GetPayoutRequestBatchCollection']['parameters'] extends {path: {}} ? operations['GetPayoutRequestBatchCollection']['parameters']["path"] : {})
|
|
1745
1750
|
|
|
1746
1751
|
type GetPayoutRequestBatchCollectionResponse = operations['GetPayoutRequestBatchCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -5509,6 +5514,17 @@ export interface corePaths {
|
|
|
5509
5514
|
*/
|
|
5510
5515
|
post: operations["PostPayoutRequestAllocationsProcess"];
|
|
5511
5516
|
};
|
|
5517
|
+
"/payout-request-batch-previews": {
|
|
5518
|
+
/**
|
|
5519
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
5520
|
+
* This operation does not create a batch or change payout requests.
|
|
5521
|
+
*
|
|
5522
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
5523
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
5524
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
5525
|
+
*/
|
|
5526
|
+
post: operations["PostPayoutRequestBatchPreview"];
|
|
5527
|
+
};
|
|
5512
5528
|
"/payout-request-batches": {
|
|
5513
5529
|
/** Retrieves a list of payout request batches. */
|
|
5514
5530
|
get: operations["GetPayoutRequestBatchCollection"];
|
|
@@ -5526,7 +5542,7 @@ export interface corePaths {
|
|
|
5526
5542
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
5527
5543
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
5528
5544
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
5529
|
-
* To view the number of matching items before creating the batch, use the [
|
|
5545
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
5530
5546
|
*/
|
|
5531
5547
|
post: operations["PostPayoutRequestBatch"];
|
|
5532
5548
|
};
|
|
@@ -5662,6 +5678,9 @@ export interface corePaths {
|
|
|
5662
5678
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
5663
5679
|
*
|
|
5664
5680
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
5681
|
+
*
|
|
5682
|
+
* This endpoint is deprecated.
|
|
5683
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
5665
5684
|
*/
|
|
5666
5685
|
get: operations["GetPayoutRequestBatchPreview"];
|
|
5667
5686
|
};
|
|
@@ -42931,6 +42950,72 @@ export interface operations {
|
|
|
42931
42950
|
};
|
|
42932
42951
|
};
|
|
42933
42952
|
};
|
|
42953
|
+
/**
|
|
42954
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
42955
|
+
* This operation does not create a batch or change payout requests.
|
|
42956
|
+
*
|
|
42957
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
42958
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
42959
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
42960
|
+
*/
|
|
42961
|
+
PostPayoutRequestBatchPreview: {
|
|
42962
|
+
responses: {
|
|
42963
|
+
/** Preview created. */
|
|
42964
|
+
200: {
|
|
42965
|
+
content: {
|
|
42966
|
+
"application/json": {
|
|
42967
|
+
/** Total number of payout requests that match the filter, regardless of the batch limit. */
|
|
42968
|
+
matchingCount: number;
|
|
42969
|
+
/**
|
|
42970
|
+
* Number of payout requests that a batch includes when you use the same filter.
|
|
42971
|
+
* This value is the lower of `matchingCount` and the number of payout requests that the batch can accept.
|
|
42972
|
+
*/
|
|
42973
|
+
selectedCount: number;
|
|
42974
|
+
/** Number of unique customers in the selected payout requests. */
|
|
42975
|
+
customerCount: number;
|
|
42976
|
+
/** Total amount grouped by currency for the selected payout requests. */
|
|
42977
|
+
totalAmountByCurrency: {
|
|
42978
|
+
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
42979
|
+
amount: number;
|
|
42980
|
+
}[];
|
|
42981
|
+
};
|
|
42982
|
+
};
|
|
42983
|
+
};
|
|
42984
|
+
/** Invalid filter provided. */
|
|
42985
|
+
400: {
|
|
42986
|
+
content: {
|
|
42987
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
42988
|
+
};
|
|
42989
|
+
};
|
|
42990
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42991
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42992
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
42993
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42994
|
+
};
|
|
42995
|
+
/** Payout request batch preview resource. */
|
|
42996
|
+
requestBody: {
|
|
42997
|
+
content: {
|
|
42998
|
+
"application/json": {
|
|
42999
|
+
/**
|
|
43000
|
+
* Filter string that is used to select payout requests.
|
|
43001
|
+
* This field uses the same format as collection filter parameters.
|
|
43002
|
+
*
|
|
43003
|
+
* Use semicolons to separate multiple filter conditions.
|
|
43004
|
+
* Available filter fields: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
43005
|
+
*
|
|
43006
|
+
* If a `batchId` filter is provided, it is ignored.
|
|
43007
|
+
* Payout requests that are already included in a batch are always excluded from the results.
|
|
43008
|
+
*/
|
|
43009
|
+
filter: string;
|
|
43010
|
+
/**
|
|
43011
|
+
* ID of the payout request batch to add payout requests to.
|
|
43012
|
+
* If this field is provided, the preview selects only as many payout requests as the batch can accept.
|
|
43013
|
+
*/
|
|
43014
|
+
batchId?: string;
|
|
43015
|
+
};
|
|
43016
|
+
};
|
|
43017
|
+
};
|
|
43018
|
+
};
|
|
42934
43019
|
/** Retrieves a list of payout request batches. */
|
|
42935
43020
|
GetPayoutRequestBatchCollection: {
|
|
42936
43021
|
parameters: {
|
|
@@ -42987,7 +43072,7 @@ export interface operations {
|
|
|
42987
43072
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
42988
43073
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
42989
43074
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
42990
|
-
* To view the number of matching items before creating the batch, use the [
|
|
43075
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
42991
43076
|
*/
|
|
42992
43077
|
PostPayoutRequestBatch: {
|
|
42993
43078
|
responses: {
|
|
@@ -43363,6 +43448,9 @@ export interface operations {
|
|
|
43363
43448
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
43364
43449
|
*
|
|
43365
43450
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
43451
|
+
*
|
|
43452
|
+
* This endpoint is deprecated.
|
|
43453
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
43366
43454
|
*/
|
|
43367
43455
|
GetPayoutRequestBatchPreview: {
|
|
43368
43456
|
parameters: {
|
|
@@ -99664,6 +99752,10 @@ declare module "rebilly-js-sdk" {
|
|
|
99664
99752
|
export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
|
|
99665
99753
|
export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
|
|
99666
99754
|
export type PostPayoutRequestAllocationsProcessResponsePromise = rebilly.PostPayoutRequestAllocationsProcessResponsePromise;
|
|
99755
|
+
export type PostPayoutRequestBatchPreviewRequest = rebilly.PostPayoutRequestBatchPreviewRequest;
|
|
99756
|
+
export type CreatePayoutRequestBatchPreviewRequest = rebilly.CreatePayoutRequestBatchPreviewRequest;
|
|
99757
|
+
export type PostPayoutRequestBatchPreviewResponse = rebilly.PostPayoutRequestBatchPreviewResponse;
|
|
99758
|
+
export type PostPayoutRequestBatchPreviewResponsePromise = rebilly.PostPayoutRequestBatchPreviewResponsePromise;
|
|
99667
99759
|
export type GetPayoutRequestBatchCollectionRequest = rebilly.GetPayoutRequestBatchCollectionRequest;
|
|
99668
99760
|
export type GetPayoutRequestBatchCollectionResponse = rebilly.GetPayoutRequestBatchCollectionResponse;
|
|
99669
99761
|
export type GetPayoutRequestBatchCollectionResponsePromise = rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
@@ -101699,6 +101791,15 @@ declare module "resources/payout-request-auto-allocations-resource" {
|
|
|
101699
101791
|
}): any;
|
|
101700
101792
|
};
|
|
101701
101793
|
}
|
|
101794
|
+
declare module "resources/payout-request-batch-previews-resource" {
|
|
101795
|
+
export default function PayoutRequestBatchPreviewsResource({ apiHandler }: {
|
|
101796
|
+
apiHandler: any;
|
|
101797
|
+
}): {
|
|
101798
|
+
create({ data }: {
|
|
101799
|
+
data: any;
|
|
101800
|
+
}): any;
|
|
101801
|
+
};
|
|
101802
|
+
}
|
|
101702
101803
|
declare module "resources/payout-request-batches-resource" {
|
|
101703
101804
|
export default function PayoutRequestBatchesResource({ apiHandler }: {
|
|
101704
101805
|
apiHandler: any;
|
|
@@ -103496,6 +103597,11 @@ declare module "resources/api-instance" {
|
|
|
103496
103597
|
data: any;
|
|
103497
103598
|
}): any;
|
|
103498
103599
|
};
|
|
103600
|
+
payoutRequestBatchPreviews: {
|
|
103601
|
+
create({ data }: {
|
|
103602
|
+
data: any;
|
|
103603
|
+
}): any;
|
|
103604
|
+
};
|
|
103499
103605
|
payoutRequestBatches: {
|
|
103500
103606
|
getAll({ limit, offset, q, filter, sort, }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
103501
103607
|
create({ data }: {
|
|
@@ -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 PostPayoutRequestBatchPreviewRequest = operations['PostPayoutRequestBatchPreview']['requestBody']['content']['application/json']
|
|
1745
|
+
type CreatePayoutRequestBatchPreviewRequest = { id?: string, data: PostPayoutRequestBatchPreviewRequest, expand?: string }
|
|
1746
|
+
type PostPayoutRequestBatchPreviewResponse = operations['PostPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
|
|
1747
|
+
type PostPayoutRequestBatchPreviewResponsePromise = Promise<{fields: PostPayoutRequestBatchPreviewResponse}>
|
|
1748
|
+
|
|
1744
1749
|
type GetPayoutRequestBatchCollectionRequest = operations['GetPayoutRequestBatchCollection']['parameters']["query"] & (operations['GetPayoutRequestBatchCollection']['parameters'] extends {path: {}} ? operations['GetPayoutRequestBatchCollection']['parameters']["path"] : {})
|
|
1745
1750
|
|
|
1746
1751
|
type GetPayoutRequestBatchCollectionResponse = operations['GetPayoutRequestBatchCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -5509,6 +5514,17 @@ export interface corePaths {
|
|
|
5509
5514
|
*/
|
|
5510
5515
|
post: operations["PostPayoutRequestAllocationsProcess"];
|
|
5511
5516
|
};
|
|
5517
|
+
"/payout-request-batch-previews": {
|
|
5518
|
+
/**
|
|
5519
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
5520
|
+
* This operation does not create a batch or change payout requests.
|
|
5521
|
+
*
|
|
5522
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
5523
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
5524
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
5525
|
+
*/
|
|
5526
|
+
post: operations["PostPayoutRequestBatchPreview"];
|
|
5527
|
+
};
|
|
5512
5528
|
"/payout-request-batches": {
|
|
5513
5529
|
/** Retrieves a list of payout request batches. */
|
|
5514
5530
|
get: operations["GetPayoutRequestBatchCollection"];
|
|
@@ -5526,7 +5542,7 @@ export interface corePaths {
|
|
|
5526
5542
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
5527
5543
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
5528
5544
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
5529
|
-
* To view the number of matching items before creating the batch, use the [
|
|
5545
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
5530
5546
|
*/
|
|
5531
5547
|
post: operations["PostPayoutRequestBatch"];
|
|
5532
5548
|
};
|
|
@@ -5662,6 +5678,9 @@ export interface corePaths {
|
|
|
5662
5678
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
5663
5679
|
*
|
|
5664
5680
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
5681
|
+
*
|
|
5682
|
+
* This endpoint is deprecated.
|
|
5683
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
5665
5684
|
*/
|
|
5666
5685
|
get: operations["GetPayoutRequestBatchPreview"];
|
|
5667
5686
|
};
|
|
@@ -42931,6 +42950,72 @@ export interface operations {
|
|
|
42931
42950
|
};
|
|
42932
42951
|
};
|
|
42933
42952
|
};
|
|
42953
|
+
/**
|
|
42954
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
42955
|
+
* This operation does not create a batch or change payout requests.
|
|
42956
|
+
*
|
|
42957
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
42958
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
42959
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
42960
|
+
*/
|
|
42961
|
+
PostPayoutRequestBatchPreview: {
|
|
42962
|
+
responses: {
|
|
42963
|
+
/** Preview created. */
|
|
42964
|
+
200: {
|
|
42965
|
+
content: {
|
|
42966
|
+
"application/json": {
|
|
42967
|
+
/** Total number of payout requests that match the filter, regardless of the batch limit. */
|
|
42968
|
+
matchingCount: number;
|
|
42969
|
+
/**
|
|
42970
|
+
* Number of payout requests that a batch includes when you use the same filter.
|
|
42971
|
+
* This value is the lower of `matchingCount` and the number of payout requests that the batch can accept.
|
|
42972
|
+
*/
|
|
42973
|
+
selectedCount: number;
|
|
42974
|
+
/** Number of unique customers in the selected payout requests. */
|
|
42975
|
+
customerCount: number;
|
|
42976
|
+
/** Total amount grouped by currency for the selected payout requests. */
|
|
42977
|
+
totalAmountByCurrency: {
|
|
42978
|
+
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
42979
|
+
amount: number;
|
|
42980
|
+
}[];
|
|
42981
|
+
};
|
|
42982
|
+
};
|
|
42983
|
+
};
|
|
42984
|
+
/** Invalid filter provided. */
|
|
42985
|
+
400: {
|
|
42986
|
+
content: {
|
|
42987
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
42988
|
+
};
|
|
42989
|
+
};
|
|
42990
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42991
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42992
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
42993
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42994
|
+
};
|
|
42995
|
+
/** Payout request batch preview resource. */
|
|
42996
|
+
requestBody: {
|
|
42997
|
+
content: {
|
|
42998
|
+
"application/json": {
|
|
42999
|
+
/**
|
|
43000
|
+
* Filter string that is used to select payout requests.
|
|
43001
|
+
* This field uses the same format as collection filter parameters.
|
|
43002
|
+
*
|
|
43003
|
+
* Use semicolons to separate multiple filter conditions.
|
|
43004
|
+
* Available filter fields: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
43005
|
+
*
|
|
43006
|
+
* If a `batchId` filter is provided, it is ignored.
|
|
43007
|
+
* Payout requests that are already included in a batch are always excluded from the results.
|
|
43008
|
+
*/
|
|
43009
|
+
filter: string;
|
|
43010
|
+
/**
|
|
43011
|
+
* ID of the payout request batch to add payout requests to.
|
|
43012
|
+
* If this field is provided, the preview selects only as many payout requests as the batch can accept.
|
|
43013
|
+
*/
|
|
43014
|
+
batchId?: string;
|
|
43015
|
+
};
|
|
43016
|
+
};
|
|
43017
|
+
};
|
|
43018
|
+
};
|
|
42934
43019
|
/** Retrieves a list of payout request batches. */
|
|
42935
43020
|
GetPayoutRequestBatchCollection: {
|
|
42936
43021
|
parameters: {
|
|
@@ -42987,7 +43072,7 @@ export interface operations {
|
|
|
42987
43072
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
42988
43073
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
42989
43074
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
42990
|
-
* To view the number of matching items before creating the batch, use the [
|
|
43075
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
42991
43076
|
*/
|
|
42992
43077
|
PostPayoutRequestBatch: {
|
|
42993
43078
|
responses: {
|
|
@@ -43363,6 +43448,9 @@ export interface operations {
|
|
|
43363
43448
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
43364
43449
|
*
|
|
43365
43450
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
43451
|
+
*
|
|
43452
|
+
* This endpoint is deprecated.
|
|
43453
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
43366
43454
|
*/
|
|
43367
43455
|
GetPayoutRequestBatchPreview: {
|
|
43368
43456
|
parameters: {
|
|
@@ -99664,6 +99752,10 @@ declare module "rebilly-js-sdk" {
|
|
|
99664
99752
|
export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
|
|
99665
99753
|
export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
|
|
99666
99754
|
export type PostPayoutRequestAllocationsProcessResponsePromise = rebilly.PostPayoutRequestAllocationsProcessResponsePromise;
|
|
99755
|
+
export type PostPayoutRequestBatchPreviewRequest = rebilly.PostPayoutRequestBatchPreviewRequest;
|
|
99756
|
+
export type CreatePayoutRequestBatchPreviewRequest = rebilly.CreatePayoutRequestBatchPreviewRequest;
|
|
99757
|
+
export type PostPayoutRequestBatchPreviewResponse = rebilly.PostPayoutRequestBatchPreviewResponse;
|
|
99758
|
+
export type PostPayoutRequestBatchPreviewResponsePromise = rebilly.PostPayoutRequestBatchPreviewResponsePromise;
|
|
99667
99759
|
export type GetPayoutRequestBatchCollectionRequest = rebilly.GetPayoutRequestBatchCollectionRequest;
|
|
99668
99760
|
export type GetPayoutRequestBatchCollectionResponse = rebilly.GetPayoutRequestBatchCollectionResponse;
|
|
99669
99761
|
export type GetPayoutRequestBatchCollectionResponsePromise = rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
@@ -101699,6 +101791,15 @@ declare module "resources/payout-request-auto-allocations-resource" {
|
|
|
101699
101791
|
}): any;
|
|
101700
101792
|
};
|
|
101701
101793
|
}
|
|
101794
|
+
declare module "resources/payout-request-batch-previews-resource" {
|
|
101795
|
+
export default function PayoutRequestBatchPreviewsResource({ apiHandler }: {
|
|
101796
|
+
apiHandler: any;
|
|
101797
|
+
}): {
|
|
101798
|
+
create({ data }: {
|
|
101799
|
+
data: any;
|
|
101800
|
+
}): any;
|
|
101801
|
+
};
|
|
101802
|
+
}
|
|
101702
101803
|
declare module "resources/payout-request-batches-resource" {
|
|
101703
101804
|
export default function PayoutRequestBatchesResource({ apiHandler }: {
|
|
101704
101805
|
apiHandler: any;
|
|
@@ -103496,6 +103597,11 @@ declare module "resources/api-instance" {
|
|
|
103496
103597
|
data: any;
|
|
103497
103598
|
}): any;
|
|
103498
103599
|
};
|
|
103600
|
+
payoutRequestBatchPreviews: {
|
|
103601
|
+
create({ data }: {
|
|
103602
|
+
data: any;
|
|
103603
|
+
}): any;
|
|
103604
|
+
};
|
|
103499
103605
|
payoutRequestBatches: {
|
|
103500
103606
|
getAll({ limit, offset, q, filter, sort, }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
103501
103607
|
create({ data }: {
|
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -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 PostPayoutRequestBatchPreviewRequest = operations['PostPayoutRequestBatchPreview']['requestBody']['content']['application/json']
|
|
1745
|
+
type CreatePayoutRequestBatchPreviewRequest = { id?: string, data: PostPayoutRequestBatchPreviewRequest, expand?: string }
|
|
1746
|
+
type PostPayoutRequestBatchPreviewResponse = operations['PostPayoutRequestBatchPreview']['responses']['200']['content']['application/json']
|
|
1747
|
+
type PostPayoutRequestBatchPreviewResponsePromise = Promise<{fields: PostPayoutRequestBatchPreviewResponse}>
|
|
1748
|
+
|
|
1744
1749
|
type GetPayoutRequestBatchCollectionRequest = operations['GetPayoutRequestBatchCollection']['parameters']["query"] & (operations['GetPayoutRequestBatchCollection']['parameters'] extends {path: {}} ? operations['GetPayoutRequestBatchCollection']['parameters']["path"] : {})
|
|
1745
1750
|
|
|
1746
1751
|
type GetPayoutRequestBatchCollectionResponse = operations['GetPayoutRequestBatchCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -5509,6 +5514,17 @@ export interface corePaths {
|
|
|
5509
5514
|
*/
|
|
5510
5515
|
post: operations["PostPayoutRequestAllocationsProcess"];
|
|
5511
5516
|
};
|
|
5517
|
+
"/payout-request-batch-previews": {
|
|
5518
|
+
/**
|
|
5519
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
5520
|
+
* This operation does not create a batch or change payout requests.
|
|
5521
|
+
*
|
|
5522
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
5523
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
5524
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
5525
|
+
*/
|
|
5526
|
+
post: operations["PostPayoutRequestBatchPreview"];
|
|
5527
|
+
};
|
|
5512
5528
|
"/payout-request-batches": {
|
|
5513
5529
|
/** Retrieves a list of payout request batches. */
|
|
5514
5530
|
get: operations["GetPayoutRequestBatchCollection"];
|
|
@@ -5526,7 +5542,7 @@ export interface corePaths {
|
|
|
5526
5542
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
5527
5543
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
5528
5544
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
5529
|
-
* To view the number of matching items before creating the batch, use the [
|
|
5545
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
5530
5546
|
*/
|
|
5531
5547
|
post: operations["PostPayoutRequestBatch"];
|
|
5532
5548
|
};
|
|
@@ -5662,6 +5678,9 @@ export interface corePaths {
|
|
|
5662
5678
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
5663
5679
|
*
|
|
5664
5680
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
5681
|
+
*
|
|
5682
|
+
* This endpoint is deprecated.
|
|
5683
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
5665
5684
|
*/
|
|
5666
5685
|
get: operations["GetPayoutRequestBatchPreview"];
|
|
5667
5686
|
};
|
|
@@ -42931,6 +42950,72 @@ export interface operations {
|
|
|
42931
42950
|
};
|
|
42932
42951
|
};
|
|
42933
42952
|
};
|
|
42953
|
+
/**
|
|
42954
|
+
* Creates a preview of the payout requests that match a specified filter and that a batch can include.
|
|
42955
|
+
* This operation does not create a batch or change payout requests.
|
|
42956
|
+
*
|
|
42957
|
+
* A batch can contain a maximum of 1000 payout requests.
|
|
42958
|
+
* If more payout requests match the filter than the batch can accept, only the oldest payout requests are selected, sorted by creation time.
|
|
42959
|
+
* To preview payout requests to add to an existing batch, provide the `batchId` of that batch.
|
|
42960
|
+
*/
|
|
42961
|
+
PostPayoutRequestBatchPreview: {
|
|
42962
|
+
responses: {
|
|
42963
|
+
/** Preview created. */
|
|
42964
|
+
200: {
|
|
42965
|
+
content: {
|
|
42966
|
+
"application/json": {
|
|
42967
|
+
/** Total number of payout requests that match the filter, regardless of the batch limit. */
|
|
42968
|
+
matchingCount: number;
|
|
42969
|
+
/**
|
|
42970
|
+
* Number of payout requests that a batch includes when you use the same filter.
|
|
42971
|
+
* This value is the lower of `matchingCount` and the number of payout requests that the batch can accept.
|
|
42972
|
+
*/
|
|
42973
|
+
selectedCount: number;
|
|
42974
|
+
/** Number of unique customers in the selected payout requests. */
|
|
42975
|
+
customerCount: number;
|
|
42976
|
+
/** Total amount grouped by currency for the selected payout requests. */
|
|
42977
|
+
totalAmountByCurrency: {
|
|
42978
|
+
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
42979
|
+
amount: number;
|
|
42980
|
+
}[];
|
|
42981
|
+
};
|
|
42982
|
+
};
|
|
42983
|
+
};
|
|
42984
|
+
/** Invalid filter provided. */
|
|
42985
|
+
400: {
|
|
42986
|
+
content: {
|
|
42987
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
42988
|
+
};
|
|
42989
|
+
};
|
|
42990
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42991
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42992
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
42993
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42994
|
+
};
|
|
42995
|
+
/** Payout request batch preview resource. */
|
|
42996
|
+
requestBody: {
|
|
42997
|
+
content: {
|
|
42998
|
+
"application/json": {
|
|
42999
|
+
/**
|
|
43000
|
+
* Filter string that is used to select payout requests.
|
|
43001
|
+
* This field uses the same format as collection filter parameters.
|
|
43002
|
+
*
|
|
43003
|
+
* Use semicolons to separate multiple filter conditions.
|
|
43004
|
+
* Available filter fields: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
43005
|
+
*
|
|
43006
|
+
* If a `batchId` filter is provided, it is ignored.
|
|
43007
|
+
* Payout requests that are already included in a batch are always excluded from the results.
|
|
43008
|
+
*/
|
|
43009
|
+
filter: string;
|
|
43010
|
+
/**
|
|
43011
|
+
* ID of the payout request batch to add payout requests to.
|
|
43012
|
+
* If this field is provided, the preview selects only as many payout requests as the batch can accept.
|
|
43013
|
+
*/
|
|
43014
|
+
batchId?: string;
|
|
43015
|
+
};
|
|
43016
|
+
};
|
|
43017
|
+
};
|
|
43018
|
+
};
|
|
42934
43019
|
/** Retrieves a list of payout request batches. */
|
|
42935
43020
|
GetPayoutRequestBatchCollection: {
|
|
42936
43021
|
parameters: {
|
|
@@ -42987,7 +43072,7 @@ export interface operations {
|
|
|
42987
43072
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
42988
43073
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
42989
43074
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
42990
|
-
* To view the number of matching items before creating the batch, use the [
|
|
43075
|
+
* To view the number of matching items before creating the batch, use the [Create a payout request batch preview](../PostPayoutRequestBatchPreview) operation.
|
|
42991
43076
|
*/
|
|
42992
43077
|
PostPayoutRequestBatch: {
|
|
42993
43078
|
responses: {
|
|
@@ -43363,6 +43448,9 @@ export interface operations {
|
|
|
43363
43448
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
43364
43449
|
*
|
|
43365
43450
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview.
|
|
43451
|
+
*
|
|
43452
|
+
* This endpoint is deprecated.
|
|
43453
|
+
* Use [Create a payout request batch preview](../PostPayoutRequestBatchPreview) instead.
|
|
43366
43454
|
*/
|
|
43367
43455
|
GetPayoutRequestBatchPreview: {
|
|
43368
43456
|
parameters: {
|
|
@@ -99664,6 +99752,10 @@ declare module "rebilly-js-sdk" {
|
|
|
99664
99752
|
export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
|
|
99665
99753
|
export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
|
|
99666
99754
|
export type PostPayoutRequestAllocationsProcessResponsePromise = rebilly.PostPayoutRequestAllocationsProcessResponsePromise;
|
|
99755
|
+
export type PostPayoutRequestBatchPreviewRequest = rebilly.PostPayoutRequestBatchPreviewRequest;
|
|
99756
|
+
export type CreatePayoutRequestBatchPreviewRequest = rebilly.CreatePayoutRequestBatchPreviewRequest;
|
|
99757
|
+
export type PostPayoutRequestBatchPreviewResponse = rebilly.PostPayoutRequestBatchPreviewResponse;
|
|
99758
|
+
export type PostPayoutRequestBatchPreviewResponsePromise = rebilly.PostPayoutRequestBatchPreviewResponsePromise;
|
|
99667
99759
|
export type GetPayoutRequestBatchCollectionRequest = rebilly.GetPayoutRequestBatchCollectionRequest;
|
|
99668
99760
|
export type GetPayoutRequestBatchCollectionResponse = rebilly.GetPayoutRequestBatchCollectionResponse;
|
|
99669
99761
|
export type GetPayoutRequestBatchCollectionResponsePromise = rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
@@ -101699,6 +101791,15 @@ declare module "resources/payout-request-auto-allocations-resource" {
|
|
|
101699
101791
|
}): any;
|
|
101700
101792
|
};
|
|
101701
101793
|
}
|
|
101794
|
+
declare module "resources/payout-request-batch-previews-resource" {
|
|
101795
|
+
export default function PayoutRequestBatchPreviewsResource({ apiHandler }: {
|
|
101796
|
+
apiHandler: any;
|
|
101797
|
+
}): {
|
|
101798
|
+
create({ data }: {
|
|
101799
|
+
data: any;
|
|
101800
|
+
}): any;
|
|
101801
|
+
};
|
|
101802
|
+
}
|
|
101702
101803
|
declare module "resources/payout-request-batches-resource" {
|
|
101703
101804
|
export default function PayoutRequestBatchesResource({ apiHandler }: {
|
|
101704
101805
|
apiHandler: any;
|
|
@@ -103496,6 +103597,11 @@ declare module "resources/api-instance" {
|
|
|
103496
103597
|
data: any;
|
|
103497
103598
|
}): any;
|
|
103498
103599
|
};
|
|
103600
|
+
payoutRequestBatchPreviews: {
|
|
103601
|
+
create({ data }: {
|
|
103602
|
+
data: any;
|
|
103603
|
+
}): any;
|
|
103604
|
+
};
|
|
103499
103605
|
payoutRequestBatches: {
|
|
103500
103606
|
getAll({ limit, offset, q, filter, sort, }?: rebilly.GetPayoutRequestBatchCollectionRequest): rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
103501
103607
|
create({ data }: {
|