rebilly-js-sdk 62.185.3 → 62.187.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 +187 -2
- package/dist/rebilly-js-sdk.d.mts +187 -2
- package/dist/rebilly-js-sdk.d.ts +187 -2
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
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
|
};
|
|
@@ -17540,6 +17559,9 @@ export interface coreComponents {
|
|
|
17540
17559
|
| "order-completed"
|
|
17541
17560
|
| "payment-card-created"
|
|
17542
17561
|
| "payment-card-expiration-reminder"
|
|
17562
|
+
| "payment-card-expiration-reminder-1-day"
|
|
17563
|
+
| "payment-card-expiration-reminder-14-days"
|
|
17564
|
+
| "payment-card-expiration-reminder-7-days"
|
|
17543
17565
|
| "payment-card-expired"
|
|
17544
17566
|
| "payment-instrument-modified"
|
|
17545
17567
|
| "payout-request-created"
|
|
@@ -23180,6 +23202,9 @@ export interface coreComponents {
|
|
|
23180
23202
|
| "organization-tax-number-validated"
|
|
23181
23203
|
| "payment-card-created"
|
|
23182
23204
|
| "payment-card-expiration-reminder"
|
|
23205
|
+
| "payment-card-expiration-reminder-1-day"
|
|
23206
|
+
| "payment-card-expiration-reminder-14-days"
|
|
23207
|
+
| "payment-card-expiration-reminder-7-days"
|
|
23183
23208
|
| "payment-card-expired"
|
|
23184
23209
|
| "payment-instrument-modified"
|
|
23185
23210
|
| "payout-request-canceled"
|
|
@@ -30081,6 +30106,31 @@ export interface coreComponents {
|
|
|
30081
30106
|
};
|
|
30082
30107
|
};
|
|
30083
30108
|
};
|
|
30109
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
30110
|
+
PaymentCardExpirationReminderWebhook: {
|
|
30111
|
+
content: {
|
|
30112
|
+
"application/json": {
|
|
30113
|
+
/** ID of the payment card. */
|
|
30114
|
+
paymentCardId?: string;
|
|
30115
|
+
/** Type of event that triggered the webhook. */
|
|
30116
|
+
eventType?:
|
|
30117
|
+
| "payment-card-expiration-reminder-14-days"
|
|
30118
|
+
| "payment-card-expiration-reminder-7-days"
|
|
30119
|
+
| "payment-card-expiration-reminder-1-day";
|
|
30120
|
+
/** Embedded objects related to the payment card event. */
|
|
30121
|
+
_embedded?: {
|
|
30122
|
+
paymentCard?: coreComponents["schemas"]["PaymentCard"];
|
|
30123
|
+
};
|
|
30124
|
+
/** Links to related resources. */
|
|
30125
|
+
_links?: {
|
|
30126
|
+
/** URL of the link. */
|
|
30127
|
+
href?: string;
|
|
30128
|
+
/** Relationship type of the link. */
|
|
30129
|
+
rel?: "paymentCard";
|
|
30130
|
+
}[];
|
|
30131
|
+
};
|
|
30132
|
+
};
|
|
30133
|
+
};
|
|
30084
30134
|
/** Payload of payment instrument-related webhook event. */
|
|
30085
30135
|
PaymentInstrumentWebhook: {
|
|
30086
30136
|
content: {
|
|
@@ -42900,6 +42950,72 @@ export interface operations {
|
|
|
42900
42950
|
};
|
|
42901
42951
|
};
|
|
42902
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
|
+
};
|
|
42903
43019
|
/** Retrieves a list of payout request batches. */
|
|
42904
43020
|
GetPayoutRequestBatchCollection: {
|
|
42905
43021
|
parameters: {
|
|
@@ -42956,7 +43072,7 @@ export interface operations {
|
|
|
42956
43072
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
42957
43073
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
42958
43074
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
42959
|
-
* 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.
|
|
42960
43076
|
*/
|
|
42961
43077
|
PostPayoutRequestBatch: {
|
|
42962
43078
|
responses: {
|
|
@@ -43332,6 +43448,9 @@ export interface operations {
|
|
|
43332
43448
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
43333
43449
|
*
|
|
43334
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.
|
|
43335
43454
|
*/
|
|
43336
43455
|
GetPayoutRequestBatchPreview: {
|
|
43337
43456
|
parameters: {
|
|
@@ -56945,6 +57064,9 @@ export interface storefrontComponents {
|
|
|
56945
57064
|
| "order-completed"
|
|
56946
57065
|
| "payment-card-created"
|
|
56947
57066
|
| "payment-card-expiration-reminder"
|
|
57067
|
+
| "payment-card-expiration-reminder-1-day"
|
|
57068
|
+
| "payment-card-expiration-reminder-14-days"
|
|
57069
|
+
| "payment-card-expiration-reminder-7-days"
|
|
56948
57070
|
| "payment-card-expired"
|
|
56949
57071
|
| "payment-instrument-modified"
|
|
56950
57072
|
| "payout-request-created"
|
|
@@ -62585,6 +62707,9 @@ export interface storefrontComponents {
|
|
|
62585
62707
|
| "organization-tax-number-validated"
|
|
62586
62708
|
| "payment-card-created"
|
|
62587
62709
|
| "payment-card-expiration-reminder"
|
|
62710
|
+
| "payment-card-expiration-reminder-1-day"
|
|
62711
|
+
| "payment-card-expiration-reminder-14-days"
|
|
62712
|
+
| "payment-card-expiration-reminder-7-days"
|
|
62588
62713
|
| "payment-card-expired"
|
|
62589
62714
|
| "payment-instrument-modified"
|
|
62590
62715
|
| "payout-request-canceled"
|
|
@@ -69486,6 +69611,31 @@ export interface storefrontComponents {
|
|
|
69486
69611
|
};
|
|
69487
69612
|
};
|
|
69488
69613
|
};
|
|
69614
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
69615
|
+
PaymentCardExpirationReminderWebhook: {
|
|
69616
|
+
content: {
|
|
69617
|
+
"application/json": {
|
|
69618
|
+
/** ID of the payment card. */
|
|
69619
|
+
paymentCardId?: string;
|
|
69620
|
+
/** Type of event that triggered the webhook. */
|
|
69621
|
+
eventType?:
|
|
69622
|
+
| "payment-card-expiration-reminder-14-days"
|
|
69623
|
+
| "payment-card-expiration-reminder-7-days"
|
|
69624
|
+
| "payment-card-expiration-reminder-1-day";
|
|
69625
|
+
/** Embedded objects related to the payment card event. */
|
|
69626
|
+
_embedded?: {
|
|
69627
|
+
paymentCard?: storefrontComponents["schemas"]["PaymentCard"];
|
|
69628
|
+
};
|
|
69629
|
+
/** Links to related resources. */
|
|
69630
|
+
_links?: {
|
|
69631
|
+
/** URL of the link. */
|
|
69632
|
+
href?: string;
|
|
69633
|
+
/** Relationship type of the link. */
|
|
69634
|
+
rel?: "paymentCard";
|
|
69635
|
+
}[];
|
|
69636
|
+
};
|
|
69637
|
+
};
|
|
69638
|
+
};
|
|
69489
69639
|
/** Payload of payment instrument-related webhook event. */
|
|
69490
69640
|
PaymentInstrumentWebhook: {
|
|
69491
69641
|
content: {
|
|
@@ -83515,6 +83665,9 @@ export interface reportsComponents {
|
|
|
83515
83665
|
| "order-completed"
|
|
83516
83666
|
| "payment-card-created"
|
|
83517
83667
|
| "payment-card-expiration-reminder"
|
|
83668
|
+
| "payment-card-expiration-reminder-1-day"
|
|
83669
|
+
| "payment-card-expiration-reminder-14-days"
|
|
83670
|
+
| "payment-card-expiration-reminder-7-days"
|
|
83518
83671
|
| "payment-card-expired"
|
|
83519
83672
|
| "payment-instrument-modified"
|
|
83520
83673
|
| "payout-request-created"
|
|
@@ -89155,6 +89308,9 @@ export interface reportsComponents {
|
|
|
89155
89308
|
| "organization-tax-number-validated"
|
|
89156
89309
|
| "payment-card-created"
|
|
89157
89310
|
| "payment-card-expiration-reminder"
|
|
89311
|
+
| "payment-card-expiration-reminder-1-day"
|
|
89312
|
+
| "payment-card-expiration-reminder-14-days"
|
|
89313
|
+
| "payment-card-expiration-reminder-7-days"
|
|
89158
89314
|
| "payment-card-expired"
|
|
89159
89315
|
| "payment-instrument-modified"
|
|
89160
89316
|
| "payout-request-canceled"
|
|
@@ -96056,6 +96212,31 @@ export interface reportsComponents {
|
|
|
96056
96212
|
};
|
|
96057
96213
|
};
|
|
96058
96214
|
};
|
|
96215
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
96216
|
+
PaymentCardExpirationReminderWebhook: {
|
|
96217
|
+
content: {
|
|
96218
|
+
"application/json": {
|
|
96219
|
+
/** ID of the payment card. */
|
|
96220
|
+
paymentCardId?: string;
|
|
96221
|
+
/** Type of event that triggered the webhook. */
|
|
96222
|
+
eventType?:
|
|
96223
|
+
| "payment-card-expiration-reminder-14-days"
|
|
96224
|
+
| "payment-card-expiration-reminder-7-days"
|
|
96225
|
+
| "payment-card-expiration-reminder-1-day";
|
|
96226
|
+
/** Embedded objects related to the payment card event. */
|
|
96227
|
+
_embedded?: {
|
|
96228
|
+
paymentCard?: reportsComponents["schemas"]["PaymentCard"];
|
|
96229
|
+
};
|
|
96230
|
+
/** Links to related resources. */
|
|
96231
|
+
_links?: {
|
|
96232
|
+
/** URL of the link. */
|
|
96233
|
+
href?: string;
|
|
96234
|
+
/** Relationship type of the link. */
|
|
96235
|
+
rel?: "paymentCard";
|
|
96236
|
+
}[];
|
|
96237
|
+
};
|
|
96238
|
+
};
|
|
96239
|
+
};
|
|
96059
96240
|
/** Payload of payment instrument-related webhook event. */
|
|
96060
96241
|
PaymentInstrumentWebhook: {
|
|
96061
96242
|
content: {
|
|
@@ -99571,6 +99752,10 @@ declare module "rebilly-js-sdk" {
|
|
|
99571
99752
|
export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
|
|
99572
99753
|
export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
|
|
99573
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;
|
|
99574
99759
|
export type GetPayoutRequestBatchCollectionRequest = rebilly.GetPayoutRequestBatchCollectionRequest;
|
|
99575
99760
|
export type GetPayoutRequestBatchCollectionResponse = rebilly.GetPayoutRequestBatchCollectionResponse;
|
|
99576
99761
|
export type GetPayoutRequestBatchCollectionResponsePromise = rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|
|
@@ -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
|
};
|
|
@@ -17540,6 +17559,9 @@ export interface coreComponents {
|
|
|
17540
17559
|
| "order-completed"
|
|
17541
17560
|
| "payment-card-created"
|
|
17542
17561
|
| "payment-card-expiration-reminder"
|
|
17562
|
+
| "payment-card-expiration-reminder-1-day"
|
|
17563
|
+
| "payment-card-expiration-reminder-14-days"
|
|
17564
|
+
| "payment-card-expiration-reminder-7-days"
|
|
17543
17565
|
| "payment-card-expired"
|
|
17544
17566
|
| "payment-instrument-modified"
|
|
17545
17567
|
| "payout-request-created"
|
|
@@ -23180,6 +23202,9 @@ export interface coreComponents {
|
|
|
23180
23202
|
| "organization-tax-number-validated"
|
|
23181
23203
|
| "payment-card-created"
|
|
23182
23204
|
| "payment-card-expiration-reminder"
|
|
23205
|
+
| "payment-card-expiration-reminder-1-day"
|
|
23206
|
+
| "payment-card-expiration-reminder-14-days"
|
|
23207
|
+
| "payment-card-expiration-reminder-7-days"
|
|
23183
23208
|
| "payment-card-expired"
|
|
23184
23209
|
| "payment-instrument-modified"
|
|
23185
23210
|
| "payout-request-canceled"
|
|
@@ -30081,6 +30106,31 @@ export interface coreComponents {
|
|
|
30081
30106
|
};
|
|
30082
30107
|
};
|
|
30083
30108
|
};
|
|
30109
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
30110
|
+
PaymentCardExpirationReminderWebhook: {
|
|
30111
|
+
content: {
|
|
30112
|
+
"application/json": {
|
|
30113
|
+
/** ID of the payment card. */
|
|
30114
|
+
paymentCardId?: string;
|
|
30115
|
+
/** Type of event that triggered the webhook. */
|
|
30116
|
+
eventType?:
|
|
30117
|
+
| "payment-card-expiration-reminder-14-days"
|
|
30118
|
+
| "payment-card-expiration-reminder-7-days"
|
|
30119
|
+
| "payment-card-expiration-reminder-1-day";
|
|
30120
|
+
/** Embedded objects related to the payment card event. */
|
|
30121
|
+
_embedded?: {
|
|
30122
|
+
paymentCard?: coreComponents["schemas"]["PaymentCard"];
|
|
30123
|
+
};
|
|
30124
|
+
/** Links to related resources. */
|
|
30125
|
+
_links?: {
|
|
30126
|
+
/** URL of the link. */
|
|
30127
|
+
href?: string;
|
|
30128
|
+
/** Relationship type of the link. */
|
|
30129
|
+
rel?: "paymentCard";
|
|
30130
|
+
}[];
|
|
30131
|
+
};
|
|
30132
|
+
};
|
|
30133
|
+
};
|
|
30084
30134
|
/** Payload of payment instrument-related webhook event. */
|
|
30085
30135
|
PaymentInstrumentWebhook: {
|
|
30086
30136
|
content: {
|
|
@@ -42900,6 +42950,72 @@ export interface operations {
|
|
|
42900
42950
|
};
|
|
42901
42951
|
};
|
|
42902
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
|
+
};
|
|
42903
43019
|
/** Retrieves a list of payout request batches. */
|
|
42904
43020
|
GetPayoutRequestBatchCollection: {
|
|
42905
43021
|
parameters: {
|
|
@@ -42956,7 +43072,7 @@ export interface operations {
|
|
|
42956
43072
|
* - **Filter-based**: Provide a `filter` string to select payout requests that match the specified criteria at execution time.
|
|
42957
43073
|
* Payout requests that are already included in a batch are automatically excluded from the filter results.
|
|
42958
43074
|
* If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
|
|
42959
|
-
* 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.
|
|
42960
43076
|
*/
|
|
42961
43077
|
PostPayoutRequestBatch: {
|
|
42962
43078
|
responses: {
|
|
@@ -43332,6 +43448,9 @@ export interface operations {
|
|
|
43332
43448
|
* Retrieves aggregate information for the payout requests that match a specified filter.
|
|
43333
43449
|
*
|
|
43334
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.
|
|
43335
43454
|
*/
|
|
43336
43455
|
GetPayoutRequestBatchPreview: {
|
|
43337
43456
|
parameters: {
|
|
@@ -56945,6 +57064,9 @@ export interface storefrontComponents {
|
|
|
56945
57064
|
| "order-completed"
|
|
56946
57065
|
| "payment-card-created"
|
|
56947
57066
|
| "payment-card-expiration-reminder"
|
|
57067
|
+
| "payment-card-expiration-reminder-1-day"
|
|
57068
|
+
| "payment-card-expiration-reminder-14-days"
|
|
57069
|
+
| "payment-card-expiration-reminder-7-days"
|
|
56948
57070
|
| "payment-card-expired"
|
|
56949
57071
|
| "payment-instrument-modified"
|
|
56950
57072
|
| "payout-request-created"
|
|
@@ -62585,6 +62707,9 @@ export interface storefrontComponents {
|
|
|
62585
62707
|
| "organization-tax-number-validated"
|
|
62586
62708
|
| "payment-card-created"
|
|
62587
62709
|
| "payment-card-expiration-reminder"
|
|
62710
|
+
| "payment-card-expiration-reminder-1-day"
|
|
62711
|
+
| "payment-card-expiration-reminder-14-days"
|
|
62712
|
+
| "payment-card-expiration-reminder-7-days"
|
|
62588
62713
|
| "payment-card-expired"
|
|
62589
62714
|
| "payment-instrument-modified"
|
|
62590
62715
|
| "payout-request-canceled"
|
|
@@ -69486,6 +69611,31 @@ export interface storefrontComponents {
|
|
|
69486
69611
|
};
|
|
69487
69612
|
};
|
|
69488
69613
|
};
|
|
69614
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
69615
|
+
PaymentCardExpirationReminderWebhook: {
|
|
69616
|
+
content: {
|
|
69617
|
+
"application/json": {
|
|
69618
|
+
/** ID of the payment card. */
|
|
69619
|
+
paymentCardId?: string;
|
|
69620
|
+
/** Type of event that triggered the webhook. */
|
|
69621
|
+
eventType?:
|
|
69622
|
+
| "payment-card-expiration-reminder-14-days"
|
|
69623
|
+
| "payment-card-expiration-reminder-7-days"
|
|
69624
|
+
| "payment-card-expiration-reminder-1-day";
|
|
69625
|
+
/** Embedded objects related to the payment card event. */
|
|
69626
|
+
_embedded?: {
|
|
69627
|
+
paymentCard?: storefrontComponents["schemas"]["PaymentCard"];
|
|
69628
|
+
};
|
|
69629
|
+
/** Links to related resources. */
|
|
69630
|
+
_links?: {
|
|
69631
|
+
/** URL of the link. */
|
|
69632
|
+
href?: string;
|
|
69633
|
+
/** Relationship type of the link. */
|
|
69634
|
+
rel?: "paymentCard";
|
|
69635
|
+
}[];
|
|
69636
|
+
};
|
|
69637
|
+
};
|
|
69638
|
+
};
|
|
69489
69639
|
/** Payload of payment instrument-related webhook event. */
|
|
69490
69640
|
PaymentInstrumentWebhook: {
|
|
69491
69641
|
content: {
|
|
@@ -83515,6 +83665,9 @@ export interface reportsComponents {
|
|
|
83515
83665
|
| "order-completed"
|
|
83516
83666
|
| "payment-card-created"
|
|
83517
83667
|
| "payment-card-expiration-reminder"
|
|
83668
|
+
| "payment-card-expiration-reminder-1-day"
|
|
83669
|
+
| "payment-card-expiration-reminder-14-days"
|
|
83670
|
+
| "payment-card-expiration-reminder-7-days"
|
|
83518
83671
|
| "payment-card-expired"
|
|
83519
83672
|
| "payment-instrument-modified"
|
|
83520
83673
|
| "payout-request-created"
|
|
@@ -89155,6 +89308,9 @@ export interface reportsComponents {
|
|
|
89155
89308
|
| "organization-tax-number-validated"
|
|
89156
89309
|
| "payment-card-created"
|
|
89157
89310
|
| "payment-card-expiration-reminder"
|
|
89311
|
+
| "payment-card-expiration-reminder-1-day"
|
|
89312
|
+
| "payment-card-expiration-reminder-14-days"
|
|
89313
|
+
| "payment-card-expiration-reminder-7-days"
|
|
89158
89314
|
| "payment-card-expired"
|
|
89159
89315
|
| "payment-instrument-modified"
|
|
89160
89316
|
| "payout-request-canceled"
|
|
@@ -96056,6 +96212,31 @@ export interface reportsComponents {
|
|
|
96056
96212
|
};
|
|
96057
96213
|
};
|
|
96058
96214
|
};
|
|
96215
|
+
/** Payload of the payment card expiration reminder webhook event. */
|
|
96216
|
+
PaymentCardExpirationReminderWebhook: {
|
|
96217
|
+
content: {
|
|
96218
|
+
"application/json": {
|
|
96219
|
+
/** ID of the payment card. */
|
|
96220
|
+
paymentCardId?: string;
|
|
96221
|
+
/** Type of event that triggered the webhook. */
|
|
96222
|
+
eventType?:
|
|
96223
|
+
| "payment-card-expiration-reminder-14-days"
|
|
96224
|
+
| "payment-card-expiration-reminder-7-days"
|
|
96225
|
+
| "payment-card-expiration-reminder-1-day";
|
|
96226
|
+
/** Embedded objects related to the payment card event. */
|
|
96227
|
+
_embedded?: {
|
|
96228
|
+
paymentCard?: reportsComponents["schemas"]["PaymentCard"];
|
|
96229
|
+
};
|
|
96230
|
+
/** Links to related resources. */
|
|
96231
|
+
_links?: {
|
|
96232
|
+
/** URL of the link. */
|
|
96233
|
+
href?: string;
|
|
96234
|
+
/** Relationship type of the link. */
|
|
96235
|
+
rel?: "paymentCard";
|
|
96236
|
+
}[];
|
|
96237
|
+
};
|
|
96238
|
+
};
|
|
96239
|
+
};
|
|
96059
96240
|
/** Payload of payment instrument-related webhook event. */
|
|
96060
96241
|
PaymentInstrumentWebhook: {
|
|
96061
96242
|
content: {
|
|
@@ -99571,6 +99752,10 @@ declare module "rebilly-js-sdk" {
|
|
|
99571
99752
|
export type CreatePayoutRequestAllocationsProcessRequest = rebilly.CreatePayoutRequestAllocationsProcessRequest;
|
|
99572
99753
|
export type PostPayoutRequestAllocationsProcessResponse = rebilly.PostPayoutRequestAllocationsProcessResponse;
|
|
99573
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;
|
|
99574
99759
|
export type GetPayoutRequestBatchCollectionRequest = rebilly.GetPayoutRequestBatchCollectionRequest;
|
|
99575
99760
|
export type GetPayoutRequestBatchCollectionResponse = rebilly.GetPayoutRequestBatchCollectionResponse;
|
|
99576
99761
|
export type GetPayoutRequestBatchCollectionResponsePromise = rebilly.GetPayoutRequestBatchCollectionResponsePromise;
|