@sp-api-sdk/finances-transfers-api-2024-06-01 2.0.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.
Files changed (57) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +97 -0
  3. package/dist/cjs/api-model/api/default-api.js +197 -0
  4. package/dist/cjs/api-model/api.js +30 -0
  5. package/dist/cjs/api-model/base.js +71 -0
  6. package/dist/cjs/api-model/common.js +145 -0
  7. package/dist/cjs/api-model/configuration.js +99 -0
  8. package/dist/cjs/api-model/index.js +32 -0
  9. package/dist/cjs/api-model/models/assignment-type.js +24 -0
  10. package/dist/cjs/api-model/models/error-list.js +15 -0
  11. package/dist/cjs/api-model/models/expiry-date.js +15 -0
  12. package/dist/cjs/api-model/models/get-payment-methods-response.js +15 -0
  13. package/dist/cjs/api-model/models/index.js +25 -0
  14. package/dist/cjs/api-model/models/initiate-payout-request.js +15 -0
  15. package/dist/cjs/api-model/models/initiate-payout-response.js +15 -0
  16. package/dist/cjs/api-model/models/model-error.js +15 -0
  17. package/dist/cjs/api-model/models/payment-method-details.js +15 -0
  18. package/dist/cjs/api-model/models/payment-method-type.js +26 -0
  19. package/dist/cjs/client.js +28 -0
  20. package/dist/cjs/index.js +19 -0
  21. package/dist/es/api-model/api/default-api.js +187 -0
  22. package/dist/es/api-model/api.js +14 -0
  23. package/dist/es/api-model/base.js +63 -0
  24. package/dist/es/api-model/common.js +133 -0
  25. package/dist/es/api-model/configuration.js +95 -0
  26. package/dist/es/api-model/index.js +16 -0
  27. package/dist/es/api-model/models/assignment-type.js +21 -0
  28. package/dist/es/api-model/models/error-list.js +14 -0
  29. package/dist/es/api-model/models/expiry-date.js +14 -0
  30. package/dist/es/api-model/models/get-payment-methods-response.js +14 -0
  31. package/dist/es/api-model/models/index.js +9 -0
  32. package/dist/es/api-model/models/initiate-payout-request.js +14 -0
  33. package/dist/es/api-model/models/initiate-payout-response.js +14 -0
  34. package/dist/es/api-model/models/model-error.js +14 -0
  35. package/dist/es/api-model/models/payment-method-details.js +14 -0
  36. package/dist/es/api-model/models/payment-method-type.js +23 -0
  37. package/dist/es/client.js +24 -0
  38. package/dist/es/index.js +3 -0
  39. package/dist/types/api-model/api/default-api.d.ts +145 -0
  40. package/dist/types/api-model/api.d.ts +12 -0
  41. package/dist/types/api-model/base.d.ts +66 -0
  42. package/dist/types/api-model/common.d.ts +65 -0
  43. package/dist/types/api-model/configuration.d.ts +91 -0
  44. package/dist/types/api-model/index.d.ts +14 -0
  45. package/dist/types/api-model/models/assignment-type.d.ts +20 -0
  46. package/dist/types/api-model/models/error-list.d.ts +24 -0
  47. package/dist/types/api-model/models/expiry-date.d.ts +30 -0
  48. package/dist/types/api-model/models/get-payment-methods-response.d.ts +25 -0
  49. package/dist/types/api-model/models/index.d.ts +9 -0
  50. package/dist/types/api-model/models/initiate-payout-request.d.ts +30 -0
  51. package/dist/types/api-model/models/initiate-payout-response.d.ts +24 -0
  52. package/dist/types/api-model/models/model-error.d.ts +36 -0
  53. package/dist/types/api-model/models/payment-method-details.d.ts +63 -0
  54. package/dist/types/api-model/models/payment-method-type.d.ts +22 -0
  55. package/dist/types/client.d.ts +6 -0
  56. package/dist/types/index.d.ts +3 -0
  57. package/package.json +44 -0
@@ -0,0 +1,133 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { RequiredError } from "./base";
15
+ /**
16
+ *
17
+ * @export
18
+ */
19
+ export const DUMMY_BASE_URL = 'https://example.com';
20
+ /**
21
+ *
22
+ * @throws {RequiredError}
23
+ * @export
24
+ */
25
+ export const assertParamExists = function (functionName, paramName, paramValue) {
26
+ if (paramValue === null || paramValue === undefined) {
27
+ throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
28
+ }
29
+ };
30
+ /**
31
+ *
32
+ * @export
33
+ */
34
+ export const setApiKeyToObject = async function (object, keyParamName, configuration) {
35
+ if (configuration && configuration.apiKey) {
36
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
37
+ ? await configuration.apiKey(keyParamName)
38
+ : await configuration.apiKey;
39
+ object[keyParamName] = localVarApiKeyValue;
40
+ }
41
+ };
42
+ /**
43
+ *
44
+ * @export
45
+ */
46
+ export const setBasicAuthToObject = function (object, configuration) {
47
+ if (configuration && (configuration.username || configuration.password)) {
48
+ object["auth"] = { username: configuration.username, password: configuration.password };
49
+ }
50
+ };
51
+ /**
52
+ *
53
+ * @export
54
+ */
55
+ export const setBearerAuthToObject = async function (object, configuration) {
56
+ if (configuration && configuration.accessToken) {
57
+ const accessToken = typeof configuration.accessToken === 'function'
58
+ ? await configuration.accessToken()
59
+ : await configuration.accessToken;
60
+ object["Authorization"] = "Bearer " + accessToken;
61
+ }
62
+ };
63
+ /**
64
+ *
65
+ * @export
66
+ */
67
+ export const setOAuthToObject = async function (object, name, scopes, configuration) {
68
+ if (configuration && configuration.accessToken) {
69
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
70
+ ? await configuration.accessToken(name, scopes)
71
+ : await configuration.accessToken;
72
+ object["Authorization"] = "Bearer " + localVarAccessTokenValue;
73
+ }
74
+ };
75
+ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
76
+ if (parameter == null)
77
+ return;
78
+ if (typeof parameter === "object") {
79
+ if (Array.isArray(parameter)) {
80
+ parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
81
+ }
82
+ else {
83
+ Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
84
+ }
85
+ }
86
+ else {
87
+ if (urlSearchParams.has(key)) {
88
+ urlSearchParams.append(key, parameter);
89
+ }
90
+ else {
91
+ urlSearchParams.set(key, parameter);
92
+ }
93
+ }
94
+ }
95
+ /**
96
+ *
97
+ * @export
98
+ */
99
+ export const setSearchParams = function (url, ...objects) {
100
+ const searchParams = new URLSearchParams(url.search);
101
+ setFlattenedQueryParams(searchParams, objects);
102
+ url.search = searchParams.toString();
103
+ };
104
+ /**
105
+ *
106
+ * @export
107
+ */
108
+ export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
109
+ const nonString = typeof value !== 'string';
110
+ const needsSerialization = nonString && configuration && configuration.isJsonMime
111
+ ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
112
+ : nonString;
113
+ return needsSerialization
114
+ ? JSON.stringify(value !== undefined ? value : {})
115
+ : (value || "");
116
+ };
117
+ /**
118
+ *
119
+ * @export
120
+ */
121
+ export const toPathString = function (url) {
122
+ return url.pathname + url.search + url.hash;
123
+ };
124
+ /**
125
+ *
126
+ * @export
127
+ */
128
+ export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
129
+ return (axios = globalAxios, basePath = BASE_PATH) => {
130
+ const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
131
+ return axios.request(axiosRequestArgs);
132
+ };
133
+ };
@@ -0,0 +1,95 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export class Configuration {
15
+ /**
16
+ * parameter for apiKey security
17
+ * @param name security name
18
+ * @memberof Configuration
19
+ */
20
+ apiKey;
21
+ /**
22
+ * parameter for basic security
23
+ *
24
+ * @type {string}
25
+ * @memberof Configuration
26
+ */
27
+ username;
28
+ /**
29
+ * parameter for basic security
30
+ *
31
+ * @type {string}
32
+ * @memberof Configuration
33
+ */
34
+ password;
35
+ /**
36
+ * parameter for oauth2 security
37
+ * @param name security name
38
+ * @param scopes oauth2 scope
39
+ * @memberof Configuration
40
+ */
41
+ accessToken;
42
+ /**
43
+ * override base path
44
+ *
45
+ * @type {string}
46
+ * @memberof Configuration
47
+ */
48
+ basePath;
49
+ /**
50
+ * override server index
51
+ *
52
+ * @type {number}
53
+ * @memberof Configuration
54
+ */
55
+ serverIndex;
56
+ /**
57
+ * base options for axios calls
58
+ *
59
+ * @type {any}
60
+ * @memberof Configuration
61
+ */
62
+ baseOptions;
63
+ /**
64
+ * The FormData constructor that will be used to create multipart form data
65
+ * requests. You can inject this here so that execution environments that
66
+ * do not support the FormData class can still run the generated client.
67
+ *
68
+ * @type {new () => FormData}
69
+ */
70
+ formDataCtor;
71
+ constructor(param = {}) {
72
+ this.apiKey = param.apiKey;
73
+ this.username = param.username;
74
+ this.password = param.password;
75
+ this.accessToken = param.accessToken;
76
+ this.basePath = param.basePath;
77
+ this.serverIndex = param.serverIndex;
78
+ this.baseOptions = param.baseOptions;
79
+ this.formDataCtor = param.formDataCtor;
80
+ }
81
+ /**
82
+ * Check if the given MIME is a JSON MIME.
83
+ * JSON MIME examples:
84
+ * application/json
85
+ * application/json; charset=UTF8
86
+ * APPLICATION/JSON
87
+ * application/vnd.company+json
88
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
89
+ * @return True if the given MIME is JSON, false otherwise.
90
+ */
91
+ isJsonMime(mime) {
92
+ const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
93
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
94
+ }
95
+ }
@@ -0,0 +1,16 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export * from "./api";
15
+ export * from "./configuration";
16
+ export * from "./models";
@@ -0,0 +1,21 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * The default payment method type.
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const AssignmentType = {
20
+ DefaultDepositMethod: 'DEFAULT_DEPOSIT_METHOD'
21
+ };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,9 @@
1
+ export * from './assignment-type';
2
+ export * from './error-list';
3
+ export * from './expiry-date';
4
+ export * from './get-payment-methods-response';
5
+ export * from './initiate-payout-request';
6
+ export * from './initiate-payout-response';
7
+ export * from './model-error';
8
+ export * from './payment-method-details';
9
+ export * from './payment-method-type';
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,23 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for Transfers.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-06-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * The type of payment method.
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const PaymentMethodType = {
20
+ BankAccount: 'BANK_ACCOUNT',
21
+ Card: 'CARD',
22
+ SellerWallet: 'SELLER_WALLET'
23
+ };
@@ -0,0 +1,24 @@
1
+ import { createAxiosInstance } from '@sp-api-sdk/common';
2
+ import { Configuration, DefaultApi } from './api-model';
3
+ export const clientRateLimits = [
4
+ {
5
+ method: 'post',
6
+ // eslint-disable-next-line prefer-regex-literals
7
+ urlRegex: new RegExp('^/finances/transfers/2024-06-01/payouts$'),
8
+ rate: 0.017,
9
+ burst: 2,
10
+ },
11
+ {
12
+ method: 'get',
13
+ // eslint-disable-next-line prefer-regex-literals
14
+ urlRegex: new RegExp('^/finances/transfers/2024-06-01/paymentMethods$'),
15
+ rate: 0.5,
16
+ burst: 30,
17
+ },
18
+ ];
19
+ export class FinancesTransfersApiClient extends DefaultApi {
20
+ constructor(configuration) {
21
+ const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
22
+ super(new Configuration(), endpoint, axios);
23
+ }
24
+ }
@@ -0,0 +1,3 @@
1
+ export * from './client';
2
+ export * from './api-model/api';
3
+ export * from './api-model/models';
@@ -0,0 +1,145 @@
1
+ /**
2
+ * The Selling Partner API for Transfers.
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-01
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import globalAxios from 'axios';
15
+ import { type RequestArgs, BaseAPI } from '../base';
16
+ import type { GetPaymentMethodsResponse } from '../models';
17
+ import type { InitiatePayoutRequest } from '../models';
18
+ import type { InitiatePayoutResponse } from '../models';
19
+ /**
20
+ * DefaultApi - axios parameter creator
21
+ * @export
22
+ */
23
+ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
24
+ /**
25
+ * 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).
26
+ * @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).
27
+ * @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
28
+ * @param {*} [options] Override http request option.
29
+ * @throws {RequiredError}
30
+ */
31
+ getPaymentMethods: (marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * 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).
34
+ * @param {InitiatePayoutRequest} body The request body for the &#x60;initiatePayout&#x60; operation.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ initiatePayout: (body: InitiatePayoutRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
+ };
40
+ /**
41
+ * DefaultApi - functional programming interface
42
+ * @export
43
+ */
44
+ export declare const DefaultApiFp: (configuration?: Configuration) => {
45
+ /**
46
+ * 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).
47
+ * @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).
48
+ * @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getPaymentMethods(marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodsResponse>>;
53
+ /**
54
+ * 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).
55
+ * @param {InitiatePayoutRequest} body The request body for the &#x60;initiatePayout&#x60; operation.
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ initiatePayout(body: InitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePayoutResponse>>;
60
+ };
61
+ /**
62
+ * DefaultApi - factory interface
63
+ * @export
64
+ */
65
+ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
66
+ /**
67
+ * 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).
68
+ * @param {DefaultApiGetPaymentMethodsRequest} requestParameters Request parameters.
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ getPaymentMethods(requestParameters: DefaultApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPaymentMethodsResponse>;
73
+ /**
74
+ * 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).
75
+ * @param {DefaultApiInitiatePayoutRequest} requestParameters Request parameters.
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ initiatePayout(requestParameters: DefaultApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<InitiatePayoutResponse>;
80
+ };
81
+ /**
82
+ * Request parameters for getPaymentMethods operation in DefaultApi.
83
+ * @export
84
+ * @interface DefaultApiGetPaymentMethodsRequest
85
+ */
86
+ export interface DefaultApiGetPaymentMethodsRequest {
87
+ /**
88
+ * 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).
89
+ * @type {string}
90
+ * @memberof DefaultApiGetPaymentMethods
91
+ */
92
+ readonly marketplaceId: string;
93
+ /**
94
+ * A comma-separated list of the payment method types you want to include in the response.
95
+ * @type {Set<'BANK_ACCOUNT' | 'CARD' | 'SELLER_WALLET'>}
96
+ * @memberof DefaultApiGetPaymentMethods
97
+ */
98
+ readonly paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>;
99
+ }
100
+ /**
101
+ * Request parameters for initiatePayout operation in DefaultApi.
102
+ * @export
103
+ * @interface DefaultApiInitiatePayoutRequest
104
+ */
105
+ export interface DefaultApiInitiatePayoutRequest {
106
+ /**
107
+ * The request body for the &#x60;initiatePayout&#x60; operation.
108
+ * @type {InitiatePayoutRequest}
109
+ * @memberof DefaultApiInitiatePayout
110
+ */
111
+ readonly body: InitiatePayoutRequest;
112
+ }
113
+ /**
114
+ * DefaultApi - object-oriented interface
115
+ * @export
116
+ * @class DefaultApi
117
+ * @extends {BaseAPI}
118
+ */
119
+ export declare class DefaultApi extends BaseAPI {
120
+ /**
121
+ * 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).
122
+ * @param {DefaultApiGetPaymentMethodsRequest} requestParameters Request parameters.
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ * @memberof DefaultApi
126
+ */
127
+ getPaymentMethods(requestParameters: DefaultApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPaymentMethodsResponse, any>>;
128
+ /**
129
+ * 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).
130
+ * @param {DefaultApiInitiatePayoutRequest} requestParameters Request parameters.
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ * @memberof DefaultApi
134
+ */
135
+ initiatePayout(requestParameters: DefaultApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InitiatePayoutResponse, any>>;
136
+ }
137
+ /**
138
+ * @export
139
+ */
140
+ export declare const GetPaymentMethodsPaymentMethodTypesEnum: {
141
+ readonly BankAccount: "BANK_ACCOUNT";
142
+ readonly Card: "CARD";
143
+ readonly SellerWallet: "SELLER_WALLET";
144
+ };
145
+ export type GetPaymentMethodsPaymentMethodTypesEnum = typeof GetPaymentMethodsPaymentMethodTypesEnum[keyof typeof GetPaymentMethodsPaymentMethodTypesEnum];
@@ -0,0 +1,12 @@
1
+ /**
2
+ * The Selling Partner API for Transfers.
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2024-06-01
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export * from './api/default-api';