rebilly-js-sdk 62.209.0 → 62.211.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 +275 -227
- package/dist/rebilly-js-sdk.d.mts +275 -227
- package/dist/rebilly-js-sdk.d.ts +275 -227
- package/dist/rebilly-js-sdk.es.mjs +66 -66
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/resources/digital-wallets-resource.js +11 -0
- package/src/resources/payout-request-batches-resource.js +0 -12
|
@@ -1552,11 +1552,17 @@ declare namespace rebilly {
|
|
|
1552
1552
|
type PutGatewayAccountFinancialSettingsResponse = operations['PutGatewayAccountFinancialSettings']['responses']['201']['content']['application/json']
|
|
1553
1553
|
type PutGatewayAccountFinancialSettingsResponsePromise = Promise<{fields: PutGatewayAccountFinancialSettingsResponse}>
|
|
1554
1554
|
|
|
1555
|
+
|
|
1556
|
+
type GetDigitalWalletOnboardingApplePayResponse = operations['GetDigitalWalletOnboardingApplePay']['responses']['200']['content']['application/json']
|
|
1557
|
+
type GetDigitalWalletOnboardingApplePayResponsePromise = Promise<{fields: GetDigitalWalletOnboardingApplePayResponse}>
|
|
1555
1558
|
type PostDigitalWalletOnboardingApplePayRequest = operations['PostDigitalWalletOnboardingApplePay']['requestBody']['content']['application/json']
|
|
1556
1559
|
type CreateDigitalWalletOnboardingApplePayRequest = { id?: string, data: PostDigitalWalletOnboardingApplePayRequest, expand?: string }
|
|
1557
1560
|
type PostDigitalWalletOnboardingApplePayResponse = operations['PostDigitalWalletOnboardingApplePay']['responses']['201']['content']['application/json']
|
|
1558
1561
|
type PostDigitalWalletOnboardingApplePayResponsePromise = Promise<{fields: PostDigitalWalletOnboardingApplePayResponse}>
|
|
1559
1562
|
|
|
1563
|
+
type DeleteDigitalWalletOnboardingApplePayDomainResponse = operations['DeleteDigitalWalletOnboardingApplePayDomain']['responses']['204']
|
|
1564
|
+
type DeleteDigitalWalletOnboardingApplePayDomainResponsePromise = Promise<{fields: DeleteDigitalWalletOnboardingApplePayDomainResponse}>
|
|
1565
|
+
|
|
1560
1566
|
type GetGridSegmentCollectionRequest = operations['GetGridSegmentCollection']['parameters']["query"] & (operations['GetGridSegmentCollection']['parameters'] extends {path: {}} ? operations['GetGridSegmentCollection']['parameters']["path"] : {})
|
|
1561
1567
|
|
|
1562
1568
|
type GetGridSegmentCollectionResponse = operations['GetGridSegmentCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -1756,16 +1762,6 @@ declare namespace rebilly {
|
|
|
1756
1762
|
type DeletePayoutRequestBatchResponse = operations['DeletePayoutRequestBatch']['responses']['204']
|
|
1757
1763
|
type DeletePayoutRequestBatchResponsePromise = Promise<{fields: DeletePayoutRequestBatchResponse}>
|
|
1758
1764
|
|
|
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
1765
|
type PostPermissionsEmulationRequest = operations['PostPermissionsEmulation']['requestBody']['content']['application/json']
|
|
1770
1766
|
type CreatePermissionsEmulationRequest = { id?: string, data: PostPermissionsEmulationRequest, expand?: string }
|
|
1771
1767
|
type PostPermissionsEmulationResponse = operations['PostPermissionsEmulation']['responses']['201']['content']['application/json']
|
|
@@ -5230,6 +5226,11 @@ export interface corePaths {
|
|
|
5230
5226
|
};
|
|
5231
5227
|
};
|
|
5232
5228
|
"/digital-wallets/onboarding/apple-pay": {
|
|
5229
|
+
/**
|
|
5230
|
+
* Retrieves the domains that Apple Pay has registered for the organization.
|
|
5231
|
+
* Apple Pay registers domains for the whole organization, not for one gateway account.
|
|
5232
|
+
*/
|
|
5233
|
+
get: operations["GetDigitalWalletOnboardingApplePay"];
|
|
5233
5234
|
/**
|
|
5234
5235
|
* Registers a domain for Apple Pay.
|
|
5235
5236
|
*
|
|
@@ -5241,6 +5242,19 @@ export interface corePaths {
|
|
|
5241
5242
|
*/
|
|
5242
5243
|
post: operations["PostDigitalWalletOnboardingApplePay"];
|
|
5243
5244
|
};
|
|
5245
|
+
"/digital-wallets/onboarding/apple-pay/{domain}": {
|
|
5246
|
+
/**
|
|
5247
|
+
* Removes a domain from Apple Pay for the organization.
|
|
5248
|
+
* Apple Pay stops working on the domain.
|
|
5249
|
+
*/
|
|
5250
|
+
delete: operations["DeleteDigitalWalletOnboardingApplePayDomain"];
|
|
5251
|
+
parameters: {
|
|
5252
|
+
path: {
|
|
5253
|
+
/** Domain to remove from Apple Pay. */
|
|
5254
|
+
domain: string;
|
|
5255
|
+
};
|
|
5256
|
+
};
|
|
5257
|
+
};
|
|
5244
5258
|
"/grid-segments": {
|
|
5245
5259
|
/** Retrieves a user's UI segments. */
|
|
5246
5260
|
get: operations["GetGridSegmentCollection"];
|
|
@@ -5529,8 +5543,8 @@ export interface corePaths {
|
|
|
5529
5543
|
};
|
|
5530
5544
|
"/payout-request-batch-operations": {
|
|
5531
5545
|
/**
|
|
5532
|
-
* Creates a payout request batch operation
|
|
5533
|
-
* A payout request batch
|
|
5546
|
+
* Creates a payout request batch operation that applies one action to a payout request batch.
|
|
5547
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
5534
5548
|
*
|
|
5535
5549
|
* The `type` field specifies the action:
|
|
5536
5550
|
* - `approve`: Approves payout requests in the `ready` status.
|
|
@@ -5538,8 +5552,14 @@ export interface corePaths {
|
|
|
5538
5552
|
* - `unblock`: Removes the block from blocked payout requests.
|
|
5539
5553
|
* - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
|
|
5540
5554
|
* - `process`: Queues pending allocations of the payout requests in the batch for processing.
|
|
5555
|
+
* - `add`: Adds the specified payout requests, or the payout requests that match a filter, to the batch.
|
|
5556
|
+
* - `remove`: Removes the specified payout requests from the batch.
|
|
5541
5557
|
*
|
|
5542
|
-
*
|
|
5558
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
5559
|
+
* For `add` and `remove`, the operation is atomic.
|
|
5560
|
+
* If the operation cannot add or remove a specified payout request,
|
|
5561
|
+
* the operation returns a `409` response and changes no batch membership.
|
|
5562
|
+
* For the other types, each payout request is checked independently.
|
|
5543
5563
|
* Payout requests that do not qualify for the action are skipped.
|
|
5544
5564
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
5545
5565
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
@@ -5601,54 +5621,6 @@ export interface corePaths {
|
|
|
5601
5621
|
};
|
|
5602
5622
|
};
|
|
5603
5623
|
};
|
|
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
5624
|
"/permissions-emulation": {
|
|
5653
5625
|
/**
|
|
5654
5626
|
* Starts permissions emulation.
|
|
@@ -22282,6 +22254,11 @@ export interface coreComponents {
|
|
|
22282
22254
|
period: coreComponents["schemas"]["SchedulingMethodDateInterval"];
|
|
22283
22255
|
}[];
|
|
22284
22256
|
};
|
|
22257
|
+
/** Apple Pay domains of the organization. */
|
|
22258
|
+
DigitalWalletOnboardingApplePayDomains: {
|
|
22259
|
+
/** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
|
|
22260
|
+
domains: string[];
|
|
22261
|
+
};
|
|
22285
22262
|
/** Register a domain with Apple Pay and associate it with Rebilly. */
|
|
22286
22263
|
DigitalWalletOnboardingApplePay: {
|
|
22287
22264
|
/** Domain to register. */
|
|
@@ -23030,20 +23007,68 @@ export interface coreComponents {
|
|
|
23030
23007
|
*/
|
|
23031
23008
|
batchId: string;
|
|
23032
23009
|
};
|
|
23010
|
+
AddPayoutRequestBatchOperation: (
|
|
23011
|
+
| { [key: string]: any }
|
|
23012
|
+
| { [key: string]: any }
|
|
23013
|
+
) & {
|
|
23014
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
23015
|
+
type: "add";
|
|
23016
|
+
/**
|
|
23017
|
+
* ID of the payout request batch.
|
|
23018
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
23019
|
+
*/
|
|
23020
|
+
batchId: string;
|
|
23021
|
+
/** IDs of the payout requests to add to the batch. */
|
|
23022
|
+
payoutRequestIds?: string[];
|
|
23023
|
+
/**
|
|
23024
|
+
* Filter string that selects payout requests to add to the batch.
|
|
23025
|
+
* This field uses the same format as filter parameters for collections.
|
|
23026
|
+
* Use semicolons to separate multiple filter conditions.
|
|
23027
|
+
*
|
|
23028
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
23029
|
+
*
|
|
23030
|
+
* The operation ignores a `batchId` filter.
|
|
23031
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
23032
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
23033
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
23034
|
+
* sorted by creation time.
|
|
23035
|
+
*/
|
|
23036
|
+
filter?: string;
|
|
23037
|
+
};
|
|
23038
|
+
RemovePayoutRequestBatchOperation: {
|
|
23039
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
23040
|
+
type: "remove";
|
|
23041
|
+
/**
|
|
23042
|
+
* ID of the payout request batch.
|
|
23043
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
23044
|
+
*/
|
|
23045
|
+
batchId: string;
|
|
23046
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
23047
|
+
payoutRequestIds: string[];
|
|
23048
|
+
};
|
|
23033
23049
|
/** Action to apply to a payout request batch. */
|
|
23034
23050
|
PayoutRequestBatchOperationRequest:
|
|
23035
23051
|
| coreComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
23036
23052
|
| coreComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
23037
23053
|
| coreComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
23038
23054
|
| coreComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
23039
|
-
| coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
23055
|
+
| coreComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
23056
|
+
| coreComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
23057
|
+
| coreComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
23040
23058
|
/**
|
|
23041
|
-
* Action applied to
|
|
23042
|
-
* A payout request batch
|
|
23059
|
+
* Action applied to a payout request batch.
|
|
23060
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
23043
23061
|
*/
|
|
23044
23062
|
PayoutRequestBatchOperation: {
|
|
23045
23063
|
/** Type of action applied to the batch. */
|
|
23046
|
-
type:
|
|
23064
|
+
type:
|
|
23065
|
+
| "approve"
|
|
23066
|
+
| "block"
|
|
23067
|
+
| "unblock"
|
|
23068
|
+
| "auto-allocate"
|
|
23069
|
+
| "process"
|
|
23070
|
+
| "add"
|
|
23071
|
+
| "remove";
|
|
23047
23072
|
/** ID of the payout request batch. */
|
|
23048
23073
|
batchId: string;
|
|
23049
23074
|
/**
|
|
@@ -42145,6 +42170,23 @@ export interface operations {
|
|
|
42145
42170
|
};
|
|
42146
42171
|
};
|
|
42147
42172
|
};
|
|
42173
|
+
/**
|
|
42174
|
+
* Retrieves the domains that Apple Pay has registered for the organization.
|
|
42175
|
+
* Apple Pay registers domains for the whole organization, not for one gateway account.
|
|
42176
|
+
*/
|
|
42177
|
+
GetDigitalWalletOnboardingApplePay: {
|
|
42178
|
+
responses: {
|
|
42179
|
+
/** Apple Pay domains retrieved. */
|
|
42180
|
+
200: {
|
|
42181
|
+
content: {
|
|
42182
|
+
"application/json": coreComponents["schemas"]["DigitalWalletOnboardingApplePayDomains"];
|
|
42183
|
+
};
|
|
42184
|
+
};
|
|
42185
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42186
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42187
|
+
409: coreComponents["responses"]["Conflict"];
|
|
42188
|
+
};
|
|
42189
|
+
};
|
|
42148
42190
|
/**
|
|
42149
42191
|
* Registers a domain for Apple Pay.
|
|
42150
42192
|
*
|
|
@@ -42182,6 +42224,27 @@ export interface operations {
|
|
|
42182
42224
|
};
|
|
42183
42225
|
};
|
|
42184
42226
|
};
|
|
42227
|
+
/**
|
|
42228
|
+
* Removes a domain from Apple Pay for the organization.
|
|
42229
|
+
* Apple Pay stops working on the domain.
|
|
42230
|
+
*/
|
|
42231
|
+
DeleteDigitalWalletOnboardingApplePayDomain: {
|
|
42232
|
+
parameters: {
|
|
42233
|
+
path: {
|
|
42234
|
+
/** Domain to remove from Apple Pay. */
|
|
42235
|
+
domain: string;
|
|
42236
|
+
};
|
|
42237
|
+
};
|
|
42238
|
+
responses: {
|
|
42239
|
+
/** Apple Pay domain removed. */
|
|
42240
|
+
204: never;
|
|
42241
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
42242
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
42243
|
+
404: coreComponents["responses"]["NotFound"];
|
|
42244
|
+
409: coreComponents["responses"]["Conflict"];
|
|
42245
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
42246
|
+
};
|
|
42247
|
+
};
|
|
42185
42248
|
/** Retrieves a user's UI segments. */
|
|
42186
42249
|
GetGridSegmentCollection: {
|
|
42187
42250
|
parameters: {
|
|
@@ -43326,8 +43389,8 @@ export interface operations {
|
|
|
43326
43389
|
};
|
|
43327
43390
|
};
|
|
43328
43391
|
/**
|
|
43329
|
-
* Creates a payout request batch operation
|
|
43330
|
-
* A payout request batch
|
|
43392
|
+
* Creates a payout request batch operation that applies one action to a payout request batch.
|
|
43393
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
43331
43394
|
*
|
|
43332
43395
|
* The `type` field specifies the action:
|
|
43333
43396
|
* - `approve`: Approves payout requests in the `ready` status.
|
|
@@ -43335,8 +43398,14 @@ export interface operations {
|
|
|
43335
43398
|
* - `unblock`: Removes the block from blocked payout requests.
|
|
43336
43399
|
* - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
|
|
43337
43400
|
* - `process`: Queues pending allocations of the payout requests in the batch for processing.
|
|
43401
|
+
* - `add`: Adds the specified payout requests, or the payout requests that match a filter, to the batch.
|
|
43402
|
+
* - `remove`: Removes the specified payout requests from the batch.
|
|
43338
43403
|
*
|
|
43339
|
-
*
|
|
43404
|
+
* A batch contains a maximum of 1000 payout requests.
|
|
43405
|
+
* For `add` and `remove`, the operation is atomic.
|
|
43406
|
+
* If the operation cannot add or remove a specified payout request,
|
|
43407
|
+
* the operation returns a `409` response and changes no batch membership.
|
|
43408
|
+
* For the other types, each payout request is checked independently.
|
|
43340
43409
|
* Payout requests that do not qualify for the action are skipped.
|
|
43341
43410
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
43342
43411
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
@@ -43352,8 +43421,20 @@ export interface operations {
|
|
|
43352
43421
|
"application/json": coreComponents["schemas"]["PayoutRequestBatchOperation"];
|
|
43353
43422
|
};
|
|
43354
43423
|
};
|
|
43424
|
+
/** Invalid filter provided or no payout requests match the filter. */
|
|
43425
|
+
400: {
|
|
43426
|
+
content: {
|
|
43427
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
43428
|
+
};
|
|
43429
|
+
};
|
|
43355
43430
|
401: coreComponents["responses"]["Unauthorized"];
|
|
43356
43431
|
403: coreComponents["responses"]["Forbidden"];
|
|
43432
|
+
/** 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. */
|
|
43433
|
+
409: {
|
|
43434
|
+
content: {
|
|
43435
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
43436
|
+
};
|
|
43437
|
+
};
|
|
43357
43438
|
422: coreComponents["responses"]["ValidationError"];
|
|
43358
43439
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
43359
43440
|
};
|
|
@@ -43610,133 +43691,6 @@ export interface operations {
|
|
|
43610
43691
|
};
|
|
43611
43692
|
requestBody: coreComponents["requestBodies"]["PatchPayoutRequestBatch"];
|
|
43612
43693
|
};
|
|
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
43694
|
/**
|
|
43741
43695
|
* Starts permissions emulation.
|
|
43742
43696
|
*
|
|
@@ -62087,6 +62041,11 @@ export interface storefrontComponents {
|
|
|
62087
62041
|
period: storefrontComponents["schemas"]["SchedulingMethodDateInterval"];
|
|
62088
62042
|
}[];
|
|
62089
62043
|
};
|
|
62044
|
+
/** Apple Pay domains of the organization. */
|
|
62045
|
+
DigitalWalletOnboardingApplePayDomains: {
|
|
62046
|
+
/** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
|
|
62047
|
+
domains: string[];
|
|
62048
|
+
};
|
|
62090
62049
|
/** Register a domain with Apple Pay and associate it with Rebilly. */
|
|
62091
62050
|
DigitalWalletOnboardingApplePay: {
|
|
62092
62051
|
/** Domain to register. */
|
|
@@ -62835,20 +62794,68 @@ export interface storefrontComponents {
|
|
|
62835
62794
|
*/
|
|
62836
62795
|
batchId: string;
|
|
62837
62796
|
};
|
|
62797
|
+
AddPayoutRequestBatchOperation: (
|
|
62798
|
+
| { [key: string]: any }
|
|
62799
|
+
| { [key: string]: any }
|
|
62800
|
+
) & {
|
|
62801
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
62802
|
+
type: "add";
|
|
62803
|
+
/**
|
|
62804
|
+
* ID of the payout request batch.
|
|
62805
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
62806
|
+
*/
|
|
62807
|
+
batchId: string;
|
|
62808
|
+
/** IDs of the payout requests to add to the batch. */
|
|
62809
|
+
payoutRequestIds?: string[];
|
|
62810
|
+
/**
|
|
62811
|
+
* Filter string that selects payout requests to add to the batch.
|
|
62812
|
+
* This field uses the same format as filter parameters for collections.
|
|
62813
|
+
* Use semicolons to separate multiple filter conditions.
|
|
62814
|
+
*
|
|
62815
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
62816
|
+
*
|
|
62817
|
+
* The operation ignores a `batchId` filter.
|
|
62818
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
62819
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
62820
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
62821
|
+
* sorted by creation time.
|
|
62822
|
+
*/
|
|
62823
|
+
filter?: string;
|
|
62824
|
+
};
|
|
62825
|
+
RemovePayoutRequestBatchOperation: {
|
|
62826
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
62827
|
+
type: "remove";
|
|
62828
|
+
/**
|
|
62829
|
+
* ID of the payout request batch.
|
|
62830
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
62831
|
+
*/
|
|
62832
|
+
batchId: string;
|
|
62833
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
62834
|
+
payoutRequestIds: string[];
|
|
62835
|
+
};
|
|
62838
62836
|
/** Action to apply to a payout request batch. */
|
|
62839
62837
|
PayoutRequestBatchOperationRequest:
|
|
62840
62838
|
| storefrontComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
62841
62839
|
| storefrontComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
62842
62840
|
| storefrontComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
62843
62841
|
| storefrontComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
62844
|
-
| storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
62842
|
+
| storefrontComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
62843
|
+
| storefrontComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
62844
|
+
| storefrontComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
62845
62845
|
/**
|
|
62846
|
-
* Action applied to
|
|
62847
|
-
* A payout request batch
|
|
62846
|
+
* Action applied to a payout request batch.
|
|
62847
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
62848
62848
|
*/
|
|
62849
62849
|
PayoutRequestBatchOperation: {
|
|
62850
62850
|
/** Type of action applied to the batch. */
|
|
62851
|
-
type:
|
|
62851
|
+
type:
|
|
62852
|
+
| "approve"
|
|
62853
|
+
| "block"
|
|
62854
|
+
| "unblock"
|
|
62855
|
+
| "auto-allocate"
|
|
62856
|
+
| "process"
|
|
62857
|
+
| "add"
|
|
62858
|
+
| "remove";
|
|
62852
62859
|
/** ID of the payout request batch. */
|
|
62853
62860
|
batchId: string;
|
|
62854
62861
|
/**
|
|
@@ -89177,6 +89184,11 @@ export interface reportsComponents {
|
|
|
89177
89184
|
period: reportsComponents["schemas"]["SchedulingMethodDateInterval"];
|
|
89178
89185
|
}[];
|
|
89179
89186
|
};
|
|
89187
|
+
/** Apple Pay domains of the organization. */
|
|
89188
|
+
DigitalWalletOnboardingApplePayDomains: {
|
|
89189
|
+
/** Domains that Apple Pay has registered for the organization, sorted alphabetically. */
|
|
89190
|
+
domains: string[];
|
|
89191
|
+
};
|
|
89180
89192
|
/** Register a domain with Apple Pay and associate it with Rebilly. */
|
|
89181
89193
|
DigitalWalletOnboardingApplePay: {
|
|
89182
89194
|
/** Domain to register. */
|
|
@@ -89925,20 +89937,68 @@ export interface reportsComponents {
|
|
|
89925
89937
|
*/
|
|
89926
89938
|
batchId: string;
|
|
89927
89939
|
};
|
|
89940
|
+
AddPayoutRequestBatchOperation: (
|
|
89941
|
+
| { [key: string]: any }
|
|
89942
|
+
| { [key: string]: any }
|
|
89943
|
+
) & {
|
|
89944
|
+
/** Type of operation that adds payout requests to the batch. */
|
|
89945
|
+
type: "add";
|
|
89946
|
+
/**
|
|
89947
|
+
* ID of the payout request batch.
|
|
89948
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
89949
|
+
*/
|
|
89950
|
+
batchId: string;
|
|
89951
|
+
/** IDs of the payout requests to add to the batch. */
|
|
89952
|
+
payoutRequestIds?: string[];
|
|
89953
|
+
/**
|
|
89954
|
+
* Filter string that selects payout requests to add to the batch.
|
|
89955
|
+
* This field uses the same format as filter parameters for collections.
|
|
89956
|
+
* Use semicolons to separate multiple filter conditions.
|
|
89957
|
+
*
|
|
89958
|
+
* Available fields for filtering: `id`, `status`, `websiteId`, `customerId`, `currency`, `amount`, `createdTime`, `updatedTime`.
|
|
89959
|
+
*
|
|
89960
|
+
* The operation ignores a `batchId` filter.
|
|
89961
|
+
* Filter results always exclude payout requests that are already associated with a batch.
|
|
89962
|
+
* If the filter matches more payout requests than the remaining batch capacity,
|
|
89963
|
+
* the operation adds only the oldest matching requests up to the batch limit,
|
|
89964
|
+
* sorted by creation time.
|
|
89965
|
+
*/
|
|
89966
|
+
filter?: string;
|
|
89967
|
+
};
|
|
89968
|
+
RemovePayoutRequestBatchOperation: {
|
|
89969
|
+
/** Type of operation that removes payout requests from the batch. */
|
|
89970
|
+
type: "remove";
|
|
89971
|
+
/**
|
|
89972
|
+
* ID of the payout request batch.
|
|
89973
|
+
* A payout request batch groups payout requests so one action applies to every request in the group.
|
|
89974
|
+
*/
|
|
89975
|
+
batchId: string;
|
|
89976
|
+
/** IDs of the payout requests to remove from the batch. */
|
|
89977
|
+
payoutRequestIds: string[];
|
|
89978
|
+
};
|
|
89928
89979
|
/** Action to apply to a payout request batch. */
|
|
89929
89980
|
PayoutRequestBatchOperationRequest:
|
|
89930
89981
|
| reportsComponents["schemas"]["ApprovePayoutRequestBatchOperation"]
|
|
89931
89982
|
| reportsComponents["schemas"]["BlockPayoutRequestBatchOperation"]
|
|
89932
89983
|
| reportsComponents["schemas"]["UnblockPayoutRequestBatchOperation"]
|
|
89933
89984
|
| reportsComponents["schemas"]["AutoAllocatePayoutRequestBatchOperation"]
|
|
89934
|
-
| reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
89985
|
+
| reportsComponents["schemas"]["ProcessPayoutRequestBatchOperation"]
|
|
89986
|
+
| reportsComponents["schemas"]["AddPayoutRequestBatchOperation"]
|
|
89987
|
+
| reportsComponents["schemas"]["RemovePayoutRequestBatchOperation"];
|
|
89935
89988
|
/**
|
|
89936
|
-
* Action applied to
|
|
89937
|
-
* A payout request batch
|
|
89989
|
+
* Action applied to a payout request batch.
|
|
89990
|
+
* A payout request batch is a group of payout requests that you manage together.
|
|
89938
89991
|
*/
|
|
89939
89992
|
PayoutRequestBatchOperation: {
|
|
89940
89993
|
/** Type of action applied to the batch. */
|
|
89941
|
-
type:
|
|
89994
|
+
type:
|
|
89995
|
+
| "approve"
|
|
89996
|
+
| "block"
|
|
89997
|
+
| "unblock"
|
|
89998
|
+
| "auto-allocate"
|
|
89999
|
+
| "process"
|
|
90000
|
+
| "add"
|
|
90001
|
+
| "remove";
|
|
89942
90002
|
/** ID of the payout request batch. */
|
|
89943
90003
|
batchId: string;
|
|
89944
90004
|
/**
|
|
@@ -100787,10 +100847,14 @@ declare module "rebilly-js-sdk" {
|
|
|
100787
100847
|
export type PutGatewayAccountFinancialSettingsRequest = rebilly.PutGatewayAccountFinancialSettingsRequest;
|
|
100788
100848
|
export type PutGatewayAccountFinancialSettingsResponse = rebilly.PutGatewayAccountFinancialSettingsResponse;
|
|
100789
100849
|
export type PutGatewayAccountFinancialSettingsResponsePromise = rebilly.PutGatewayAccountFinancialSettingsResponsePromise;
|
|
100850
|
+
export type GetDigitalWalletOnboardingApplePayResponse = rebilly.GetDigitalWalletOnboardingApplePayResponse;
|
|
100851
|
+
export type GetDigitalWalletOnboardingApplePayResponsePromise = rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
|
|
100790
100852
|
export type PostDigitalWalletOnboardingApplePayRequest = rebilly.PostDigitalWalletOnboardingApplePayRequest;
|
|
100791
100853
|
export type CreateDigitalWalletOnboardingApplePayRequest = rebilly.CreateDigitalWalletOnboardingApplePayRequest;
|
|
100792
100854
|
export type PostDigitalWalletOnboardingApplePayResponse = rebilly.PostDigitalWalletOnboardingApplePayResponse;
|
|
100793
100855
|
export type PostDigitalWalletOnboardingApplePayResponsePromise = rebilly.PostDigitalWalletOnboardingApplePayResponsePromise;
|
|
100856
|
+
export type DeleteDigitalWalletOnboardingApplePayDomainResponse = rebilly.DeleteDigitalWalletOnboardingApplePayDomainResponse;
|
|
100857
|
+
export type DeleteDigitalWalletOnboardingApplePayDomainResponsePromise = rebilly.DeleteDigitalWalletOnboardingApplePayDomainResponsePromise;
|
|
100794
100858
|
export type GetGridSegmentCollectionRequest = rebilly.GetGridSegmentCollectionRequest;
|
|
100795
100859
|
export type GetGridSegmentCollectionResponse = rebilly.GetGridSegmentCollectionResponse;
|
|
100796
100860
|
export type GetGridSegmentCollectionResponsePromise = rebilly.GetGridSegmentCollectionResponsePromise;
|
|
@@ -100938,14 +101002,6 @@ declare module "rebilly-js-sdk" {
|
|
|
100938
101002
|
export type PatchPayoutRequestBatchResponsePromise = rebilly.PatchPayoutRequestBatchResponsePromise;
|
|
100939
101003
|
export type DeletePayoutRequestBatchResponse = rebilly.DeletePayoutRequestBatchResponse;
|
|
100940
101004
|
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
101005
|
export type PostPermissionsEmulationRequest = rebilly.PostPermissionsEmulationRequest;
|
|
100950
101006
|
export type CreatePermissionsEmulationRequest = rebilly.CreatePermissionsEmulationRequest;
|
|
100951
101007
|
export type PostPermissionsEmulationResponse = rebilly.PostPermissionsEmulationResponse;
|
|
@@ -102117,9 +102173,13 @@ declare module "resources/digital-wallets-resource" {
|
|
|
102117
102173
|
validate({ data }: {
|
|
102118
102174
|
data: any;
|
|
102119
102175
|
}): any;
|
|
102176
|
+
getApplePayDomains(): rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
|
|
102120
102177
|
create({ data }: {
|
|
102121
102178
|
data: any;
|
|
102122
102179
|
}): any;
|
|
102180
|
+
deleteApplePayDomain({ domain }: {
|
|
102181
|
+
domain: any;
|
|
102182
|
+
}): any;
|
|
102123
102183
|
};
|
|
102124
102184
|
}
|
|
102125
102185
|
declare module "resources/disputes-resource" {
|
|
@@ -102968,14 +103028,6 @@ declare module "resources/payout-request-batches-resource" {
|
|
|
102968
103028
|
id: any;
|
|
102969
103029
|
data: any;
|
|
102970
103030
|
}): 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
103031
|
};
|
|
102980
103032
|
}
|
|
102981
103033
|
declare module "resources/payout-request-splits-resource" {
|
|
@@ -104035,9 +104087,13 @@ declare module "resources/api-instance" {
|
|
|
104035
104087
|
validate({ data }: {
|
|
104036
104088
|
data: any;
|
|
104037
104089
|
}): any;
|
|
104090
|
+
getApplePayDomains(): rebilly.GetDigitalWalletOnboardingApplePayResponsePromise;
|
|
104038
104091
|
create({ data }: {
|
|
104039
104092
|
data: any;
|
|
104040
104093
|
}): any;
|
|
104094
|
+
deleteApplePayDomain({ domain }: {
|
|
104095
|
+
domain: any;
|
|
104096
|
+
}): any;
|
|
104041
104097
|
};
|
|
104042
104098
|
disputes: {
|
|
104043
104099
|
getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetDisputeCollectionRequest): rebilly.GetDisputeCollectionResponsePromise;
|
|
@@ -104746,14 +104802,6 @@ declare module "resources/api-instance" {
|
|
|
104746
104802
|
id: any;
|
|
104747
104803
|
data: any;
|
|
104748
104804
|
}): 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
104805
|
};
|
|
104758
104806
|
payoutRequestSplits: {
|
|
104759
104807
|
create({ data }: {
|