@sp-api-sdk/finances-transfers-api-2024-06-01 5.0.0 → 5.1.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/README.md +3 -4
- package/dist/index.cjs +383 -378
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +253 -277
- package/dist/index.d.ts +253 -277
- package/dist/index.js +357 -339
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* The Selling Partner API for Transfers.
|
|
7
6
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
101
100
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* The Selling Partner API for Transfers.
|
|
105
|
-
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2024-06-01
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/assignment-type.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* The Selling Partner API for Transfers.
|
|
128
117
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -138,10 +127,11 @@ declare class BaseAPI {
|
|
|
138
127
|
* The default payment method type.
|
|
139
128
|
*/
|
|
140
129
|
declare const AssignmentType: {
|
|
141
|
-
|
|
130
|
+
readonly DefaultDepositMethod: "DEFAULT_DEPOSIT_METHOD";
|
|
142
131
|
};
|
|
143
132
|
type AssignmentType = typeof AssignmentType[keyof typeof AssignmentType];
|
|
144
|
-
|
|
133
|
+
//#endregion
|
|
134
|
+
//#region src/api-model/models/error-list.d.ts
|
|
145
135
|
/**
|
|
146
136
|
* The Selling Partner API for Transfers.
|
|
147
137
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -157,12 +147,13 @@ type AssignmentType = typeof AssignmentType[keyof typeof AssignmentType];
|
|
|
157
147
|
* A list of error responses returned when a request is unsuccessful.
|
|
158
148
|
*/
|
|
159
149
|
interface ErrorList {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
150
|
+
/**
|
|
151
|
+
* array of errors
|
|
152
|
+
*/
|
|
153
|
+
'errors': Array<Error>;
|
|
164
154
|
}
|
|
165
|
-
|
|
155
|
+
//#endregion
|
|
156
|
+
//#region src/api-model/models/expiry-date.d.ts
|
|
166
157
|
/**
|
|
167
158
|
* The Selling Partner API for Transfers.
|
|
168
159
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -178,16 +169,17 @@ interface ErrorList {
|
|
|
178
169
|
* The expiration date of the card used for payment. If the payment method is not `card`, the expiration date is `null`.
|
|
179
170
|
*/
|
|
180
171
|
interface ExpiryDate {
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
172
|
+
/**
|
|
173
|
+
* The month the card expires expressed as a number from `1` to `12`.
|
|
174
|
+
*/
|
|
175
|
+
'month'?: string;
|
|
176
|
+
/**
|
|
177
|
+
* Year
|
|
178
|
+
*/
|
|
179
|
+
'year'?: string;
|
|
189
180
|
}
|
|
190
|
-
|
|
181
|
+
//#endregion
|
|
182
|
+
//#region src/api-model/models/payment-method-type.d.ts
|
|
191
183
|
/**
|
|
192
184
|
* The Selling Partner API for Transfers.
|
|
193
185
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -203,71 +195,50 @@ interface ExpiryDate {
|
|
|
203
195
|
* The type of payment method.
|
|
204
196
|
*/
|
|
205
197
|
declare const PaymentMethodType: {
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
198
|
+
readonly BankAccount: "BANK_ACCOUNT";
|
|
199
|
+
readonly Card: "CARD";
|
|
200
|
+
readonly SellerWallet: "SELLER_WALLET";
|
|
209
201
|
};
|
|
210
202
|
type PaymentMethodType = typeof PaymentMethodType[keyof typeof PaymentMethodType];
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
* The Selling Partner API for Transfers.
|
|
214
|
-
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
215
|
-
*
|
|
216
|
-
* The version of the OpenAPI document: 2024-06-01
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
220
|
-
* https://openapi-generator.tech
|
|
221
|
-
* Do not edit the class manually.
|
|
222
|
-
*/
|
|
223
|
-
|
|
203
|
+
//#endregion
|
|
204
|
+
//#region src/api-model/models/payment-method-details.d.ts
|
|
224
205
|
/**
|
|
225
206
|
* The details of a payment method.
|
|
226
207
|
*/
|
|
227
208
|
interface PaymentMethodDetails {
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
209
|
+
/**
|
|
210
|
+
* The name of the account holder who is registered for the payment method.
|
|
211
|
+
*/
|
|
212
|
+
'accountHolderName'?: string;
|
|
213
|
+
/**
|
|
214
|
+
* The payment method identifier.
|
|
215
|
+
*/
|
|
216
|
+
'paymentMethodId'?: string;
|
|
217
|
+
/**
|
|
218
|
+
* The last three or four digits of the payment method.
|
|
219
|
+
*/
|
|
220
|
+
'tail'?: string;
|
|
221
|
+
'expiryDate'?: ExpiryDate;
|
|
222
|
+
/**
|
|
223
|
+
* The two-letter country code in ISO 3166-1 alpha-2 format. For payment methods in the `card` category, the code is for the country where the card was issued. For payment methods in the `bank account` category, the code is for the country where the account is located.
|
|
224
|
+
*/
|
|
225
|
+
'countryCode'?: string;
|
|
226
|
+
'paymentMethodType'?: PaymentMethodType;
|
|
227
|
+
'assignmentType'?: AssignmentType;
|
|
247
228
|
}
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
* The Selling Partner API for Transfers.
|
|
251
|
-
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
252
|
-
*
|
|
253
|
-
* The version of the OpenAPI document: 2024-06-01
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
257
|
-
* https://openapi-generator.tech
|
|
258
|
-
* Do not edit the class manually.
|
|
259
|
-
*/
|
|
260
|
-
|
|
229
|
+
//#endregion
|
|
230
|
+
//#region src/api-model/models/get-payment-methods-response.d.ts
|
|
261
231
|
/**
|
|
262
232
|
* The response schema for the `getPaymentMethods` operation.
|
|
263
233
|
*/
|
|
264
234
|
interface GetPaymentMethodsResponse {
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
235
|
+
/**
|
|
236
|
+
* The list of payment methods with payment method details.
|
|
237
|
+
*/
|
|
238
|
+
'paymentMethods'?: Array<PaymentMethodDetails>;
|
|
269
239
|
}
|
|
270
|
-
|
|
240
|
+
//#endregion
|
|
241
|
+
//#region src/api-model/models/initiate-payout-request.d.ts
|
|
271
242
|
/**
|
|
272
243
|
* The Selling Partner API for Transfers.
|
|
273
244
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -283,16 +254,17 @@ interface GetPaymentMethodsResponse {
|
|
|
283
254
|
* The request schema for the `initiatePayout` operation.
|
|
284
255
|
*/
|
|
285
256
|
interface InitiatePayoutRequest {
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
257
|
+
/**
|
|
258
|
+
* The identifier of the Amazon marketplace. For the list of all marketplace IDs, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
259
|
+
*/
|
|
260
|
+
'marketplaceId': string;
|
|
261
|
+
/**
|
|
262
|
+
* The account type in the selected marketplace for which a payout must be initiated. For supported EU marketplaces, the only account type is `Standard Orders`.
|
|
263
|
+
*/
|
|
264
|
+
'accountType': string;
|
|
294
265
|
}
|
|
295
|
-
|
|
266
|
+
//#endregion
|
|
267
|
+
//#region src/api-model/models/initiate-payout-response.d.ts
|
|
296
268
|
/**
|
|
297
269
|
* The Selling Partner API for Transfers.
|
|
298
270
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -308,12 +280,13 @@ interface InitiatePayoutRequest {
|
|
|
308
280
|
* The response schema for the `initiatePayout` operation.
|
|
309
281
|
*/
|
|
310
282
|
interface InitiatePayoutResponse {
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
283
|
+
/**
|
|
284
|
+
* The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.
|
|
285
|
+
*/
|
|
286
|
+
'payoutReferenceId': string;
|
|
315
287
|
}
|
|
316
|
-
|
|
288
|
+
//#endregion
|
|
289
|
+
//#region src/api-model/models/model-error.d.ts
|
|
317
290
|
/**
|
|
318
291
|
* The Selling Partner API for Transfers.
|
|
319
292
|
* The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
|
|
@@ -329,130 +302,133 @@ interface InitiatePayoutResponse {
|
|
|
329
302
|
* Error response returned when the request is unsuccessful.
|
|
330
303
|
*/
|
|
331
304
|
interface ModelError {
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
305
|
+
/**
|
|
306
|
+
* An error code that identifies the type of error that occurred.
|
|
307
|
+
*/
|
|
308
|
+
'code': string;
|
|
309
|
+
/**
|
|
310
|
+
* A message that describes the error condition.
|
|
311
|
+
*/
|
|
312
|
+
'message': string;
|
|
313
|
+
/**
|
|
314
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
315
|
+
*/
|
|
316
|
+
'details'?: string;
|
|
344
317
|
}
|
|
345
|
-
|
|
318
|
+
//#endregion
|
|
319
|
+
//#region src/api-model/api/finances-transfers-api.d.ts
|
|
346
320
|
/**
|
|
347
321
|
* FinancesTransfersApi - axios parameter creator
|
|
348
322
|
*/
|
|
349
323
|
declare const FinancesTransfersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
324
|
+
/**
|
|
325
|
+
* Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
326
|
+
* @param {string} marketplaceId The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
327
|
+
* @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
getPaymentMethods: (marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
332
|
+
/**
|
|
333
|
+
* Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
334
|
+
* @param {InitiatePayoutRequest} body The request body for the `initiatePayout` operation.
|
|
335
|
+
* @param {*} [options] Override http request option.
|
|
336
|
+
* @throws {RequiredError}
|
|
337
|
+
*/
|
|
338
|
+
initiatePayout: (body: InitiatePayoutRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
365
339
|
};
|
|
366
340
|
/**
|
|
367
341
|
* FinancesTransfersApi - functional programming interface
|
|
368
342
|
*/
|
|
369
343
|
declare const FinancesTransfersApiFp: (configuration?: Configuration) => {
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
344
|
+
/**
|
|
345
|
+
* Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
346
|
+
* @param {string} marketplaceId The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
347
|
+
* @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
getPaymentMethods(marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodsResponse>>;
|
|
352
|
+
/**
|
|
353
|
+
* Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
354
|
+
* @param {InitiatePayoutRequest} body The request body for the `initiatePayout` operation.
|
|
355
|
+
* @param {*} [options] Override http request option.
|
|
356
|
+
* @throws {RequiredError}
|
|
357
|
+
*/
|
|
358
|
+
initiatePayout(body: InitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePayoutResponse>>;
|
|
385
359
|
};
|
|
386
360
|
/**
|
|
387
361
|
* FinancesTransfersApi - factory interface
|
|
388
362
|
*/
|
|
389
363
|
declare const FinancesTransfersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
364
|
+
/**
|
|
365
|
+
* Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
366
|
+
* @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
|
|
367
|
+
* @param {*} [options] Override http request option.
|
|
368
|
+
* @throws {RequiredError}
|
|
369
|
+
*/
|
|
370
|
+
getPaymentMethods(requestParameters: FinancesTransfersApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPaymentMethodsResponse>;
|
|
371
|
+
/**
|
|
372
|
+
* Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
373
|
+
* @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
|
|
374
|
+
* @param {*} [options] Override http request option.
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
*/
|
|
377
|
+
initiatePayout(requestParameters: FinancesTransfersApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<InitiatePayoutResponse>;
|
|
404
378
|
};
|
|
405
379
|
/**
|
|
406
380
|
* Request parameters for getPaymentMethods operation in FinancesTransfersApi.
|
|
407
381
|
*/
|
|
408
382
|
interface FinancesTransfersApiGetPaymentMethodsRequest {
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
383
|
+
/**
|
|
384
|
+
* The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
385
|
+
*/
|
|
386
|
+
readonly marketplaceId: string;
|
|
387
|
+
/**
|
|
388
|
+
* A comma-separated list of the payment method types you want to include in the response.
|
|
389
|
+
*/
|
|
390
|
+
readonly paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>;
|
|
417
391
|
}
|
|
418
392
|
/**
|
|
419
393
|
* Request parameters for initiatePayout operation in FinancesTransfersApi.
|
|
420
394
|
*/
|
|
421
395
|
interface FinancesTransfersApiInitiatePayoutRequest {
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
396
|
+
/**
|
|
397
|
+
* The request body for the `initiatePayout` operation.
|
|
398
|
+
*/
|
|
399
|
+
readonly body: InitiatePayoutRequest;
|
|
426
400
|
}
|
|
427
401
|
/**
|
|
428
402
|
* FinancesTransfersApi - object-oriented interface
|
|
429
403
|
*/
|
|
430
404
|
declare class FinancesTransfersApi extends BaseAPI {
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
405
|
+
/**
|
|
406
|
+
* Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
407
|
+
* @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
getPaymentMethods(requestParameters: FinancesTransfersApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentMethodsResponse, any, {}>>;
|
|
412
|
+
/**
|
|
413
|
+
* Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
414
|
+
* @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
*/
|
|
418
|
+
initiatePayout(requestParameters: FinancesTransfersApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiatePayoutResponse, any, {}>>;
|
|
445
419
|
}
|
|
446
420
|
declare const GetPaymentMethodsPaymentMethodTypesEnum: {
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
421
|
+
readonly BankAccount: "BANK_ACCOUNT";
|
|
422
|
+
readonly Card: "CARD";
|
|
423
|
+
readonly SellerWallet: "SELLER_WALLET";
|
|
450
424
|
};
|
|
451
425
|
type GetPaymentMethodsPaymentMethodTypesEnum = typeof GetPaymentMethodsPaymentMethodTypesEnum[keyof typeof GetPaymentMethodsPaymentMethodTypesEnum];
|
|
452
|
-
|
|
426
|
+
//#endregion
|
|
427
|
+
//#region src/client.d.ts
|
|
453
428
|
declare const clientRateLimits: RateLimit[];
|
|
454
429
|
declare class FinancesTransfersApiClient extends FinancesTransfersApi {
|
|
455
|
-
|
|
430
|
+
constructor(configuration: ClientConfiguration);
|
|
456
431
|
}
|
|
457
|
-
|
|
458
|
-
export { AssignmentType,
|
|
432
|
+
//#endregion
|
|
433
|
+
export { AssignmentType, ErrorList, ExpiryDate, FinancesTransfersApi, FinancesTransfersApiAxiosParamCreator, FinancesTransfersApiClient, FinancesTransfersApiFactory, FinancesTransfersApiFp, FinancesTransfersApiGetPaymentMethodsRequest, FinancesTransfersApiInitiatePayoutRequest, GetPaymentMethodsPaymentMethodTypesEnum, GetPaymentMethodsResponse, InitiatePayoutRequest, InitiatePayoutResponse, ModelError, PaymentMethodDetails, PaymentMethodType, clientRateLimits };
|
|
434
|
+
//# sourceMappingURL=index.d.cts.map
|