@sp-api-sdk/finances-transfers-api-2024-06-01 4.0.1 → 4.0.2

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 (26) hide show
  1. package/dist/cjs/api-model/api/finances-transfers-api.js +0 -11
  2. package/dist/cjs/api-model/base.js +0 -19
  3. package/dist/cjs/api-model/common.js +0 -37
  4. package/dist/cjs/api-model/configuration.js +0 -17
  5. package/dist/cjs/api-model/models/assignment-type.js +0 -2
  6. package/dist/cjs/api-model/models/payment-method-type.js +0 -2
  7. package/dist/es/api-model/api/finances-transfers-api.js +0 -11
  8. package/dist/es/api-model/base.js +0 -19
  9. package/dist/es/api-model/common.js +0 -37
  10. package/dist/es/api-model/configuration.js +0 -17
  11. package/dist/es/api-model/models/assignment-type.js +0 -2
  12. package/dist/es/api-model/models/payment-method-type.js +0 -2
  13. package/dist/types/api-model/api/finances-transfers-api.d.ts +0 -21
  14. package/dist/types/api-model/base.d.ts +0 -24
  15. package/dist/types/api-model/common.d.ts +0 -37
  16. package/dist/types/api-model/configuration.d.ts +0 -17
  17. package/dist/types/api-model/models/assignment-type.d.ts +0 -2
  18. package/dist/types/api-model/models/error-list.d.ts +0 -4
  19. package/dist/types/api-model/models/expiry-date.d.ts +0 -6
  20. package/dist/types/api-model/models/get-payment-methods-response.d.ts +0 -4
  21. package/dist/types/api-model/models/initiate-payout-request.d.ts +0 -6
  22. package/dist/types/api-model/models/initiate-payout-response.d.ts +0 -4
  23. package/dist/types/api-model/models/model-error.d.ts +0 -8
  24. package/dist/types/api-model/models/payment-method-details.d.ts +0 -25
  25. package/dist/types/api-model/models/payment-method-type.d.ts +0 -2
  26. package/package.json +25 -4
@@ -25,7 +25,6 @@ const common_1 = require("../common");
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * FinancesTransfersApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const FinancesTransfersApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -97,7 +96,6 @@ const FinancesTransfersApiAxiosParamCreator = function (configuration) {
97
96
  exports.FinancesTransfersApiAxiosParamCreator = FinancesTransfersApiAxiosParamCreator;
98
97
  /**
99
98
  * FinancesTransfersApi - functional programming interface
100
- * @export
101
99
  */
102
100
  const FinancesTransfersApiFp = function (configuration) {
103
101
  const localVarAxiosParamCreator = (0, exports.FinancesTransfersApiAxiosParamCreator)(configuration);
@@ -132,7 +130,6 @@ const FinancesTransfersApiFp = function (configuration) {
132
130
  exports.FinancesTransfersApiFp = FinancesTransfersApiFp;
133
131
  /**
134
132
  * FinancesTransfersApi - factory interface
135
- * @export
136
133
  */
137
134
  const FinancesTransfersApiFactory = function (configuration, basePath, axios) {
138
135
  const localVarFp = (0, exports.FinancesTransfersApiFp)(configuration);
@@ -160,9 +157,6 @@ const FinancesTransfersApiFactory = function (configuration, basePath, axios) {
160
157
  exports.FinancesTransfersApiFactory = FinancesTransfersApiFactory;
161
158
  /**
162
159
  * FinancesTransfersApi - object-oriented interface
163
- * @export
164
- * @class FinancesTransfersApi
165
- * @extends {BaseAPI}
166
160
  */
167
161
  class FinancesTransfersApi extends base_1.BaseAPI {
168
162
  /**
@@ -170,7 +164,6 @@ class FinancesTransfersApi extends base_1.BaseAPI {
170
164
  * @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
171
165
  * @param {*} [options] Override http request option.
172
166
  * @throws {RequiredError}
173
- * @memberof FinancesTransfersApi
174
167
  */
175
168
  getPaymentMethods(requestParameters, options) {
176
169
  return (0, exports.FinancesTransfersApiFp)(this.configuration).getPaymentMethods(requestParameters.marketplaceId, requestParameters.paymentMethodTypes, options).then((request) => request(this.axios, this.basePath));
@@ -180,16 +173,12 @@ class FinancesTransfersApi extends base_1.BaseAPI {
180
173
  * @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
181
174
  * @param {*} [options] Override http request option.
182
175
  * @throws {RequiredError}
183
- * @memberof FinancesTransfersApi
184
176
  */
185
177
  initiatePayout(requestParameters, options) {
186
178
  return (0, exports.FinancesTransfersApiFp)(this.configuration).initiatePayout(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
187
179
  }
188
180
  }
189
181
  exports.FinancesTransfersApi = FinancesTransfersApi;
190
- /**
191
- * @export
192
- */
193
182
  exports.GetPaymentMethodsPaymentMethodTypesEnum = {
194
183
  BankAccount: 'BANK_ACCOUNT',
195
184
  Card: 'CARD',
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
22
- /**
23
- *
24
- * @export
25
- */
26
22
  exports.COLLECTION_FORMATS = {
27
23
  csv: ",",
28
24
  ssv: " ",
29
25
  tsv: "\t",
30
26
  pipes: "|",
31
27
  };
32
- /**
33
- *
34
- * @export
35
- * @class BaseAPI
36
- */
37
28
  class BaseAPI {
38
29
  basePath;
39
30
  axios;
@@ -49,12 +40,6 @@ class BaseAPI {
49
40
  }
50
41
  exports.BaseAPI = BaseAPI;
51
42
  ;
52
- /**
53
- *
54
- * @export
55
- * @class RequiredError
56
- * @extends {Error}
57
- */
58
43
  class RequiredError extends Error {
59
44
  field;
60
45
  constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
64
49
  }
65
50
  }
66
51
  exports.RequiredError = RequiredError;
67
- /**
68
- *
69
- * @export
70
- */
71
52
  exports.operationServerMap = {};
@@ -15,15 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
17
17
  const base_1 = require("./base");
18
- /**
19
- *
20
- * @export
21
- */
22
18
  exports.DUMMY_BASE_URL = 'https://example.com';
23
19
  /**
24
20
  *
25
21
  * @throws {RequiredError}
26
- * @export
27
22
  */
28
23
  const assertParamExists = function (functionName, paramName, paramValue) {
29
24
  if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
31
26
  }
32
27
  };
33
28
  exports.assertParamExists = assertParamExists;
34
- /**
35
- *
36
- * @export
37
- */
38
29
  const setApiKeyToObject = async function (object, keyParamName, configuration) {
39
30
  if (configuration && configuration.apiKey) {
40
31
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
44
35
  }
45
36
  };
46
37
  exports.setApiKeyToObject = setApiKeyToObject;
47
- /**
48
- *
49
- * @export
50
- */
51
38
  const setBasicAuthToObject = function (object, configuration) {
52
39
  if (configuration && (configuration.username || configuration.password)) {
53
40
  object["auth"] = { username: configuration.username, password: configuration.password };
54
41
  }
55
42
  };
56
43
  exports.setBasicAuthToObject = setBasicAuthToObject;
57
- /**
58
- *
59
- * @export
60
- */
61
44
  const setBearerAuthToObject = async function (object, configuration) {
62
45
  if (configuration && configuration.accessToken) {
63
46
  const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
67
50
  }
68
51
  };
69
52
  exports.setBearerAuthToObject = setBearerAuthToObject;
70
- /**
71
- *
72
- * @export
73
- */
74
53
  const setOAuthToObject = async function (object, name, scopes, configuration) {
75
54
  if (configuration && configuration.accessToken) {
76
55
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
100
79
  }
101
80
  }
102
81
  }
103
- /**
104
- *
105
- * @export
106
- */
107
82
  const setSearchParams = function (url, ...objects) {
108
83
  const searchParams = new URLSearchParams(url.search);
109
84
  setFlattenedQueryParams(searchParams, objects);
110
85
  url.search = searchParams.toString();
111
86
  };
112
87
  exports.setSearchParams = setSearchParams;
113
- /**
114
- *
115
- * @export
116
- */
117
88
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
118
89
  const nonString = typeof value !== 'string';
119
90
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
124
95
  : (value || "");
125
96
  };
126
97
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
127
- /**
128
- *
129
- * @export
130
- */
131
98
  const toPathString = function (url) {
132
99
  return url.pathname + url.search + url.hash;
133
100
  };
134
101
  exports.toPathString = toPathString;
135
- /**
136
- *
137
- * @export
138
- */
139
102
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
140
103
  return (axios = globalAxios, basePath = BASE_PATH) => {
141
104
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -18,49 +18,32 @@ class Configuration {
18
18
  /**
19
19
  * parameter for apiKey security
20
20
  * @param name security name
21
- * @memberof Configuration
22
21
  */
23
22
  apiKey;
24
23
  /**
25
24
  * parameter for basic security
26
- *
27
- * @type {string}
28
- * @memberof Configuration
29
25
  */
30
26
  username;
31
27
  /**
32
28
  * parameter for basic security
33
- *
34
- * @type {string}
35
- * @memberof Configuration
36
29
  */
37
30
  password;
38
31
  /**
39
32
  * parameter for oauth2 security
40
33
  * @param name security name
41
34
  * @param scopes oauth2 scope
42
- * @memberof Configuration
43
35
  */
44
36
  accessToken;
45
37
  /**
46
38
  * override base path
47
- *
48
- * @type {string}
49
- * @memberof Configuration
50
39
  */
51
40
  basePath;
52
41
  /**
53
42
  * override server index
54
- *
55
- * @type {number}
56
- * @memberof Configuration
57
43
  */
58
44
  serverIndex;
59
45
  /**
60
46
  * base options for axios calls
61
- *
62
- * @type {any}
63
- * @memberof Configuration
64
47
  */
65
48
  baseOptions;
66
49
  /**
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.AssignmentType = void 0;
17
17
  /**
18
18
  * The default payment method type.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
  exports.AssignmentType = {
23
21
  DefaultDepositMethod: 'DEFAULT_DEPOSIT_METHOD'
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.PaymentMethodType = void 0;
17
17
  /**
18
18
  * The type of payment method.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
  exports.PaymentMethodType = {
23
21
  BankAccount: 'BANK_ACCOUNT',
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
19
19
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * FinancesTransfersApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const FinancesTransfersApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -90,7 +89,6 @@ export const FinancesTransfersApiAxiosParamCreator = function (configuration) {
90
89
  };
91
90
  /**
92
91
  * FinancesTransfersApi - functional programming interface
93
- * @export
94
92
  */
95
93
  export const FinancesTransfersApiFp = function (configuration) {
96
94
  const localVarAxiosParamCreator = FinancesTransfersApiAxiosParamCreator(configuration);
@@ -124,7 +122,6 @@ export const FinancesTransfersApiFp = function (configuration) {
124
122
  };
125
123
  /**
126
124
  * FinancesTransfersApi - factory interface
127
- * @export
128
125
  */
129
126
  export const FinancesTransfersApiFactory = function (configuration, basePath, axios) {
130
127
  const localVarFp = FinancesTransfersApiFp(configuration);
@@ -151,9 +148,6 @@ export const FinancesTransfersApiFactory = function (configuration, basePath, ax
151
148
  };
152
149
  /**
153
150
  * FinancesTransfersApi - object-oriented interface
154
- * @export
155
- * @class FinancesTransfersApi
156
- * @extends {BaseAPI}
157
151
  */
158
152
  export class FinancesTransfersApi extends BaseAPI {
159
153
  /**
@@ -161,7 +155,6 @@ export class FinancesTransfersApi extends BaseAPI {
161
155
  * @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
162
156
  * @param {*} [options] Override http request option.
163
157
  * @throws {RequiredError}
164
- * @memberof FinancesTransfersApi
165
158
  */
166
159
  getPaymentMethods(requestParameters, options) {
167
160
  return FinancesTransfersApiFp(this.configuration).getPaymentMethods(requestParameters.marketplaceId, requestParameters.paymentMethodTypes, options).then((request) => request(this.axios, this.basePath));
@@ -171,15 +164,11 @@ export class FinancesTransfersApi extends BaseAPI {
171
164
  * @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
172
165
  * @param {*} [options] Override http request option.
173
166
  * @throws {RequiredError}
174
- * @memberof FinancesTransfersApi
175
167
  */
176
168
  initiatePayout(requestParameters, options) {
177
169
  return FinancesTransfersApiFp(this.configuration).initiatePayout(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
178
170
  }
179
171
  }
180
- /**
181
- * @export
182
- */
183
172
  export const GetPaymentMethodsPaymentMethodTypesEnum = {
184
173
  BankAccount: 'BANK_ACCOUNT',
185
174
  Card: 'CARD',
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  basePath;
33
24
  axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
42
33
  }
43
34
  }
44
35
  ;
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
36
  export class RequiredError extends Error {
52
37
  field;
53
38
  constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
56
41
  this.name = "RequiredError";
57
42
  }
58
43
  }
59
- /**
60
- *
61
- * @export
62
- */
63
44
  export const operationServerMap = {};
@@ -12,25 +12,16 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { RequiredError } from "./base";
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export const DUMMY_BASE_URL = 'https://example.com';
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export const assertParamExists = function (functionName, paramName, paramValue) {
26
21
  if (paramValue === null || paramValue === undefined) {
27
22
  throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
28
23
  }
29
24
  };
30
- /**
31
- *
32
- * @export
33
- */
34
25
  export const setApiKeyToObject = async function (object, keyParamName, configuration) {
35
26
  if (configuration && configuration.apiKey) {
36
27
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
39
30
  object[keyParamName] = localVarApiKeyValue;
40
31
  }
41
32
  };
42
- /**
43
- *
44
- * @export
45
- */
46
33
  export const setBasicAuthToObject = function (object, configuration) {
47
34
  if (configuration && (configuration.username || configuration.password)) {
48
35
  object["auth"] = { username: configuration.username, password: configuration.password };
49
36
  }
50
37
  };
51
- /**
52
- *
53
- * @export
54
- */
55
38
  export const setBearerAuthToObject = async function (object, configuration) {
56
39
  if (configuration && configuration.accessToken) {
57
40
  const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
60
43
  object["Authorization"] = "Bearer " + accessToken;
61
44
  }
62
45
  };
63
- /**
64
- *
65
- * @export
66
- */
67
46
  export const setOAuthToObject = async function (object, name, scopes, configuration) {
68
47
  if (configuration && configuration.accessToken) {
69
48
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
92
71
  }
93
72
  }
94
73
  }
95
- /**
96
- *
97
- * @export
98
- */
99
74
  export const setSearchParams = function (url, ...objects) {
100
75
  const searchParams = new URLSearchParams(url.search);
101
76
  setFlattenedQueryParams(searchParams, objects);
102
77
  url.search = searchParams.toString();
103
78
  };
104
- /**
105
- *
106
- * @export
107
- */
108
79
  export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
109
80
  const nonString = typeof value !== 'string';
110
81
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
114
85
  ? JSON.stringify(value !== undefined ? value : {})
115
86
  : (value || "");
116
87
  };
117
- /**
118
- *
119
- * @export
120
- */
121
88
  export const toPathString = function (url) {
122
89
  return url.pathname + url.search + url.hash;
123
90
  };
124
- /**
125
- *
126
- * @export
127
- */
128
91
  export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
129
92
  return (axios = globalAxios, basePath = BASE_PATH) => {
130
93
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -15,49 +15,32 @@ export class Configuration {
15
15
  /**
16
16
  * parameter for apiKey security
17
17
  * @param name security name
18
- * @memberof Configuration
19
18
  */
20
19
  apiKey;
21
20
  /**
22
21
  * parameter for basic security
23
- *
24
- * @type {string}
25
- * @memberof Configuration
26
22
  */
27
23
  username;
28
24
  /**
29
25
  * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
26
  */
34
27
  password;
35
28
  /**
36
29
  * parameter for oauth2 security
37
30
  * @param name security name
38
31
  * @param scopes oauth2 scope
39
- * @memberof Configuration
40
32
  */
41
33
  accessToken;
42
34
  /**
43
35
  * override base path
44
- *
45
- * @type {string}
46
- * @memberof Configuration
47
36
  */
48
37
  basePath;
49
38
  /**
50
39
  * override server index
51
- *
52
- * @type {number}
53
- * @memberof Configuration
54
40
  */
55
41
  serverIndex;
56
42
  /**
57
43
  * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
44
  */
62
45
  baseOptions;
63
46
  /**
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The default payment method type.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const AssignmentType = {
20
18
  DefaultDepositMethod: 'DEFAULT_DEPOSIT_METHOD'
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The type of payment method.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const PaymentMethodType = {
20
18
  BankAccount: 'BANK_ACCOUNT',
@@ -18,7 +18,6 @@ import type { InitiatePayoutRequest } from '../models';
18
18
  import type { InitiatePayoutResponse } from '../models';
19
19
  /**
20
20
  * FinancesTransfersApi - axios parameter creator
21
- * @export
22
21
  */
23
22
  export declare const FinancesTransfersApiAxiosParamCreator: (configuration?: Configuration) => {
24
23
  /**
@@ -39,7 +38,6 @@ export declare const FinancesTransfersApiAxiosParamCreator: (configuration?: Con
39
38
  };
40
39
  /**
41
40
  * FinancesTransfersApi - functional programming interface
42
- * @export
43
41
  */
44
42
  export declare const FinancesTransfersApiFp: (configuration?: Configuration) => {
45
43
  /**
@@ -60,7 +58,6 @@ export declare const FinancesTransfersApiFp: (configuration?: Configuration) =>
60
58
  };
61
59
  /**
62
60
  * FinancesTransfersApi - factory interface
63
- * @export
64
61
  */
65
62
  export declare const FinancesTransfersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
66
63
  /**
@@ -80,41 +77,28 @@ export declare const FinancesTransfersApiFactory: (configuration?: Configuration
80
77
  };
81
78
  /**
82
79
  * Request parameters for getPaymentMethods operation in FinancesTransfersApi.
83
- * @export
84
- * @interface FinancesTransfersApiGetPaymentMethodsRequest
85
80
  */
86
81
  export interface FinancesTransfersApiGetPaymentMethodsRequest {
87
82
  /**
88
83
  * 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 FinancesTransfersApiGetPaymentMethods
91
84
  */
92
85
  readonly marketplaceId: string;
93
86
  /**
94
87
  * 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 FinancesTransfersApiGetPaymentMethods
97
88
  */
98
89
  readonly paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>;
99
90
  }
100
91
  /**
101
92
  * Request parameters for initiatePayout operation in FinancesTransfersApi.
102
- * @export
103
- * @interface FinancesTransfersApiInitiatePayoutRequest
104
93
  */
105
94
  export interface FinancesTransfersApiInitiatePayoutRequest {
106
95
  /**
107
96
  * The request body for the &#x60;initiatePayout&#x60; operation.
108
- * @type {InitiatePayoutRequest}
109
- * @memberof FinancesTransfersApiInitiatePayout
110
97
  */
111
98
  readonly body: InitiatePayoutRequest;
112
99
  }
113
100
  /**
114
101
  * FinancesTransfersApi - object-oriented interface
115
- * @export
116
- * @class FinancesTransfersApi
117
- * @extends {BaseAPI}
118
102
  */
119
103
  export declare class FinancesTransfersApi extends BaseAPI {
120
104
  /**
@@ -122,7 +106,6 @@ export declare class FinancesTransfersApi extends BaseAPI {
122
106
  * @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
123
107
  * @param {*} [options] Override http request option.
124
108
  * @throws {RequiredError}
125
- * @memberof FinancesTransfersApi
126
109
  */
127
110
  getPaymentMethods(requestParameters: FinancesTransfersApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPaymentMethodsResponse, any>>;
128
111
  /**
@@ -130,13 +113,9 @@ export declare class FinancesTransfersApi extends BaseAPI {
130
113
  * @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
131
114
  * @param {*} [options] Override http request option.
132
115
  * @throws {RequiredError}
133
- * @memberof FinancesTransfersApi
134
116
  */
135
117
  initiatePayout(requestParameters: FinancesTransfersApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InitiatePayoutResponse, any>>;
136
118
  }
137
- /**
138
- * @export
139
- */
140
119
  export declare const GetPaymentMethodsPaymentMethodTypesEnum: {
141
120
  readonly BankAccount: "BANK_ACCOUNT";
142
121
  readonly Card: "CARD";
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
@@ -11,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * The default payment method type.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const AssignmentType: {
18
16
  readonly DefaultDepositMethod: "DEFAULT_DEPOSIT_METHOD";
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * A list of error responses returned when a request is unsuccessful.
14
- * @export
15
- * @interface ErrorList
16
14
  */
17
15
  export interface ErrorList {
18
16
  /**
19
17
  * array of errors
20
- * @type {Array<Error>}
21
- * @memberof ErrorList
22
18
  */
23
19
  'errors': Array<Error>;
24
20
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * The expiration date of the card used for payment. If the payment method is not `card`, the expiration date is `null`.
14
- * @export
15
- * @interface ExpiryDate
16
14
  */
17
15
  export interface ExpiryDate {
18
16
  /**
19
17
  * The month the card expires expressed as a number from `1` to `12`.
20
- * @type {string}
21
- * @memberof ExpiryDate
22
18
  */
23
19
  'month'?: string;
24
20
  /**
25
21
  * Year
26
- * @type {string}
27
- * @memberof ExpiryDate
28
22
  */
29
23
  'year'?: string;
30
24
  }
@@ -12,14 +12,10 @@
12
12
  import type { PaymentMethodDetails } from './payment-method-details';
13
13
  /**
14
14
  * The response schema for the `getPaymentMethods` operation.
15
- * @export
16
- * @interface GetPaymentMethodsResponse
17
15
  */
18
16
  export interface GetPaymentMethodsResponse {
19
17
  /**
20
18
  * The list of payment methods with payment method details.
21
- * @type {Array<PaymentMethodDetails>}
22
- * @memberof GetPaymentMethodsResponse
23
19
  */
24
20
  'paymentMethods'?: Array<PaymentMethodDetails>;
25
21
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * The request schema for the `initiatePayout` operation.
14
- * @export
15
- * @interface InitiatePayoutRequest
16
14
  */
17
15
  export interface InitiatePayoutRequest {
18
16
  /**
19
17
  * 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).
20
- * @type {string}
21
- * @memberof InitiatePayoutRequest
22
18
  */
23
19
  'marketplaceId': string;
24
20
  /**
25
21
  * 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`.
26
- * @type {string}
27
- * @memberof InitiatePayoutRequest
28
22
  */
29
23
  'accountType': string;
30
24
  }
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * The response schema for the `initiatePayout` operation.
14
- * @export
15
- * @interface InitiatePayoutResponse
16
14
  */
17
15
  export interface InitiatePayoutResponse {
18
16
  /**
19
17
  * The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.
20
- * @type {string}
21
- * @memberof InitiatePayoutResponse
22
18
  */
23
19
  'payoutReferenceId': string;
24
20
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * Error response returned when the request is unsuccessful.
14
- * @export
15
- * @interface ModelError
16
14
  */
17
15
  export interface ModelError {
18
16
  /**
19
17
  * An error code that identifies the type of error that occurred.
20
- * @type {string}
21
- * @memberof ModelError
22
18
  */
23
19
  'code': string;
24
20
  /**
25
21
  * A message that describes the error condition.
26
- * @type {string}
27
- * @memberof ModelError
28
22
  */
29
23
  'message': string;
30
24
  /**
31
25
  * Additional details that can help the caller understand or fix the issue.
32
- * @type {string}
33
- * @memberof ModelError
34
26
  */
35
27
  'details'?: string;
36
28
  }
@@ -14,50 +14,25 @@ import type { ExpiryDate } from './expiry-date';
14
14
  import type { PaymentMethodType } from './payment-method-type';
15
15
  /**
16
16
  * The details of a payment method.
17
- * @export
18
- * @interface PaymentMethodDetails
19
17
  */
20
18
  export interface PaymentMethodDetails {
21
19
  /**
22
20
  * The name of the account holder who is registered for the payment method.
23
- * @type {string}
24
- * @memberof PaymentMethodDetails
25
21
  */
26
22
  'accountHolderName'?: string;
27
23
  /**
28
24
  * The payment method identifier.
29
- * @type {string}
30
- * @memberof PaymentMethodDetails
31
25
  */
32
26
  'paymentMethodId'?: string;
33
27
  /**
34
28
  * The last three or four digits of the payment method.
35
- * @type {string}
36
- * @memberof PaymentMethodDetails
37
29
  */
38
30
  'tail'?: string;
39
- /**
40
- *
41
- * @type {ExpiryDate}
42
- * @memberof PaymentMethodDetails
43
- */
44
31
  'expiryDate'?: ExpiryDate;
45
32
  /**
46
33
  * 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.
47
- * @type {string}
48
- * @memberof PaymentMethodDetails
49
34
  */
50
35
  'countryCode'?: string;
51
- /**
52
- *
53
- * @type {PaymentMethodType}
54
- * @memberof PaymentMethodDetails
55
- */
56
36
  'paymentMethodType'?: PaymentMethodType;
57
- /**
58
- *
59
- * @type {AssignmentType}
60
- * @memberof PaymentMethodDetails
61
- */
62
37
  'assignmentType'?: AssignmentType;
63
38
  }
@@ -11,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * The type of payment method.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const PaymentMethodType: {
18
16
  readonly BankAccount: "BANK_ACCOUNT";
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/finances-transfers-api-2024-06-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "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.",
5
- "version": "4.0.1",
5
+ "version": "4.0.2",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.15",
22
- "axios": "^1.10.0"
21
+ "@sp-api-sdk/common": "2.1.16",
22
+ "axios": "^1.11.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,26 @@
40
40
  "sp sdk",
41
41
  "finances transfers api"
42
42
  ],
43
- "gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
43
+ "xo": {
44
+ "extends": [
45
+ "xo-bizon"
46
+ ],
47
+ "settings": {
48
+ "import/internal-regex": "^@sp-api-sdk/"
49
+ },
50
+ "semicolon": false,
51
+ "space": 2,
52
+ "prettier": true,
53
+ "ignores": [
54
+ "src/api-model/**"
55
+ ],
56
+ "rules": {
57
+ "unicorn/prevent-abbreviations": "off"
58
+ }
59
+ },
60
+ "prettier": {
61
+ "printWidth": 100,
62
+ "jsxSingleQuote": true
63
+ },
64
+ "gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
44
65
  }