@sp-api-sdk/finances-api-v0 3.1.3 → 4.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.
- package/dist/cjs/api-model/api/{default-api.js → finances-api.js} +36 -36
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{default-api.js → finances-api.js} +31 -31
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{default-api.d.ts → finances-api.d.ts} +57 -57
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
19
|
+
exports.FinancesApi = exports.FinancesApiFactory = exports.FinancesApiFp = exports.FinancesApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -24,10 +24,10 @@ const common_1 = require("../common");
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* FinancesApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
const
|
|
30
|
+
const FinancesApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
33
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -203,13 +203,13 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
203
203
|
},
|
|
204
204
|
};
|
|
205
205
|
};
|
|
206
|
-
exports.
|
|
206
|
+
exports.FinancesApiAxiosParamCreator = FinancesApiAxiosParamCreator;
|
|
207
207
|
/**
|
|
208
|
-
*
|
|
208
|
+
* FinancesApi - functional programming interface
|
|
209
209
|
* @export
|
|
210
210
|
*/
|
|
211
|
-
const
|
|
212
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
211
|
+
const FinancesApiFp = function (configuration) {
|
|
212
|
+
const localVarAxiosParamCreator = (0, exports.FinancesApiAxiosParamCreator)(configuration);
|
|
213
213
|
return {
|
|
214
214
|
/**
|
|
215
215
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -223,7 +223,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
223
223
|
async listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options) {
|
|
224
224
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options);
|
|
225
225
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
226
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
226
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FinancesApi.listFinancialEventGroups']?.[localVarOperationServerIndex]?.url;
|
|
227
227
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
228
228
|
},
|
|
229
229
|
/**
|
|
@@ -238,7 +238,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
238
238
|
async listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
|
|
239
239
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options);
|
|
240
240
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
241
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
241
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FinancesApi.listFinancialEvents']?.[localVarOperationServerIndex]?.url;
|
|
242
242
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
@@ -254,7 +254,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
254
254
|
async listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
|
|
255
255
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, postedAfter, postedBefore, nextToken, options);
|
|
256
256
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
257
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
257
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FinancesApi.listFinancialEventsByGroupId']?.[localVarOperationServerIndex]?.url;
|
|
258
258
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
259
259
|
},
|
|
260
260
|
/**
|
|
@@ -268,22 +268,22 @@ const DefaultApiFp = function (configuration) {
|
|
|
268
268
|
async listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options) {
|
|
269
269
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options);
|
|
270
270
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
271
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
271
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FinancesApi.listFinancialEventsByOrderId']?.[localVarOperationServerIndex]?.url;
|
|
272
272
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
273
273
|
},
|
|
274
274
|
};
|
|
275
275
|
};
|
|
276
|
-
exports.
|
|
276
|
+
exports.FinancesApiFp = FinancesApiFp;
|
|
277
277
|
/**
|
|
278
|
-
*
|
|
278
|
+
* FinancesApi - factory interface
|
|
279
279
|
* @export
|
|
280
280
|
*/
|
|
281
|
-
const
|
|
282
|
-
const localVarFp = (0, exports.
|
|
281
|
+
const FinancesApiFactory = function (configuration, basePath, axios) {
|
|
282
|
+
const localVarFp = (0, exports.FinancesApiFp)(configuration);
|
|
283
283
|
return {
|
|
284
284
|
/**
|
|
285
285
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
286
|
-
* @param {
|
|
286
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
287
287
|
* @param {*} [options] Override http request option.
|
|
288
288
|
* @throws {RequiredError}
|
|
289
289
|
*/
|
|
@@ -292,7 +292,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
292
292
|
},
|
|
293
293
|
/**
|
|
294
294
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
295
|
-
* @param {
|
|
295
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
296
296
|
* @param {*} [options] Override http request option.
|
|
297
297
|
* @throws {RequiredError}
|
|
298
298
|
*/
|
|
@@ -301,7 +301,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
301
301
|
},
|
|
302
302
|
/**
|
|
303
303
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
304
|
-
* @param {
|
|
304
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
305
305
|
* @param {*} [options] Override http request option.
|
|
306
306
|
* @throws {RequiredError}
|
|
307
307
|
*/
|
|
@@ -310,7 +310,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
310
310
|
},
|
|
311
311
|
/**
|
|
312
312
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
313
|
-
* @param {
|
|
313
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
316
316
|
*/
|
|
@@ -319,53 +319,53 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
319
319
|
},
|
|
320
320
|
};
|
|
321
321
|
};
|
|
322
|
-
exports.
|
|
322
|
+
exports.FinancesApiFactory = FinancesApiFactory;
|
|
323
323
|
/**
|
|
324
|
-
*
|
|
324
|
+
* FinancesApi - object-oriented interface
|
|
325
325
|
* @export
|
|
326
|
-
* @class
|
|
326
|
+
* @class FinancesApi
|
|
327
327
|
* @extends {BaseAPI}
|
|
328
328
|
*/
|
|
329
|
-
class
|
|
329
|
+
class FinancesApi extends base_1.BaseAPI {
|
|
330
330
|
/**
|
|
331
331
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
332
|
-
* @param {
|
|
332
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
333
333
|
* @param {*} [options] Override http request option.
|
|
334
334
|
* @throws {RequiredError}
|
|
335
|
-
* @memberof
|
|
335
|
+
* @memberof FinancesApi
|
|
336
336
|
*/
|
|
337
337
|
listFinancialEventGroups(requestParameters = {}, options) {
|
|
338
|
-
return (0, exports.
|
|
338
|
+
return (0, exports.FinancesApiFp)(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
341
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
342
|
-
* @param {
|
|
342
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
343
343
|
* @param {*} [options] Override http request option.
|
|
344
344
|
* @throws {RequiredError}
|
|
345
|
-
* @memberof
|
|
345
|
+
* @memberof FinancesApi
|
|
346
346
|
*/
|
|
347
347
|
listFinancialEvents(requestParameters = {}, options) {
|
|
348
|
-
return (0, exports.
|
|
348
|
+
return (0, exports.FinancesApiFp)(this.configuration).listFinancialEvents(requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
349
349
|
}
|
|
350
350
|
/**
|
|
351
351
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
352
|
-
* @param {
|
|
352
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
353
353
|
* @param {*} [options] Override http request option.
|
|
354
354
|
* @throws {RequiredError}
|
|
355
|
-
* @memberof
|
|
355
|
+
* @memberof FinancesApi
|
|
356
356
|
*/
|
|
357
357
|
listFinancialEventsByGroupId(requestParameters, options) {
|
|
358
|
-
return (0, exports.
|
|
358
|
+
return (0, exports.FinancesApiFp)(this.configuration).listFinancialEventsByGroupId(requestParameters.eventGroupId, requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
361
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
362
|
-
* @param {
|
|
362
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
363
363
|
* @param {*} [options] Override http request option.
|
|
364
364
|
* @throws {RequiredError}
|
|
365
|
-
* @memberof
|
|
365
|
+
* @memberof FinancesApi
|
|
366
366
|
*/
|
|
367
367
|
listFinancialEventsByOrderId(requestParameters, options) {
|
|
368
|
-
return (0, exports.
|
|
368
|
+
return (0, exports.FinancesApiFp)(this.configuration).listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
369
369
|
}
|
|
370
370
|
}
|
|
371
|
-
exports.
|
|
371
|
+
exports.FinancesApi = FinancesApi;
|
|
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
-
__exportStar(require("./api/
|
|
30
|
+
__exportStar(require("./api/finances-api"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -33,7 +33,7 @@ exports.clientRateLimits = [
|
|
|
33
33
|
burst: 30,
|
|
34
34
|
},
|
|
35
35
|
];
|
|
36
|
-
class FinancesApiClient extends api_model_1.
|
|
36
|
+
class FinancesApiClient extends api_model_1.FinancesApi {
|
|
37
37
|
constructor(configuration) {
|
|
38
38
|
const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
|
|
39
39
|
super(new api_model_1.Configuration(), endpoint, axios);
|
|
@@ -18,10 +18,10 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
|
|
|
18
18
|
// @ts-ignore
|
|
19
19
|
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* FinancesApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export const
|
|
24
|
+
export const FinancesApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
27
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -198,11 +198,11 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
};
|
|
199
199
|
};
|
|
200
200
|
/**
|
|
201
|
-
*
|
|
201
|
+
* FinancesApi - functional programming interface
|
|
202
202
|
* @export
|
|
203
203
|
*/
|
|
204
|
-
export const
|
|
205
|
-
const localVarAxiosParamCreator =
|
|
204
|
+
export const FinancesApiFp = function (configuration) {
|
|
205
|
+
const localVarAxiosParamCreator = FinancesApiAxiosParamCreator(configuration);
|
|
206
206
|
return {
|
|
207
207
|
/**
|
|
208
208
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
@@ -216,7 +216,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
216
216
|
async listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options) {
|
|
217
217
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options);
|
|
218
218
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
219
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
219
|
+
const localVarOperationServerBasePath = operationServerMap['FinancesApi.listFinancialEventGroups']?.[localVarOperationServerIndex]?.url;
|
|
220
220
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
221
221
|
},
|
|
222
222
|
/**
|
|
@@ -231,7 +231,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
231
231
|
async listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
|
|
232
232
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options);
|
|
233
233
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
234
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
234
|
+
const localVarOperationServerBasePath = operationServerMap['FinancesApi.listFinancialEvents']?.[localVarOperationServerIndex]?.url;
|
|
235
235
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
236
236
|
},
|
|
237
237
|
/**
|
|
@@ -247,7 +247,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
247
247
|
async listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
|
|
248
248
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, postedAfter, postedBefore, nextToken, options);
|
|
249
249
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
250
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
250
|
+
const localVarOperationServerBasePath = operationServerMap['FinancesApi.listFinancialEventsByGroupId']?.[localVarOperationServerIndex]?.url;
|
|
251
251
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
252
252
|
},
|
|
253
253
|
/**
|
|
@@ -261,21 +261,21 @@ export const DefaultApiFp = function (configuration) {
|
|
|
261
261
|
async listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options) {
|
|
262
262
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options);
|
|
263
263
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
264
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
264
|
+
const localVarOperationServerBasePath = operationServerMap['FinancesApi.listFinancialEventsByOrderId']?.[localVarOperationServerIndex]?.url;
|
|
265
265
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
266
266
|
},
|
|
267
267
|
};
|
|
268
268
|
};
|
|
269
269
|
/**
|
|
270
|
-
*
|
|
270
|
+
* FinancesApi - factory interface
|
|
271
271
|
* @export
|
|
272
272
|
*/
|
|
273
|
-
export const
|
|
274
|
-
const localVarFp =
|
|
273
|
+
export const FinancesApiFactory = function (configuration, basePath, axios) {
|
|
274
|
+
const localVarFp = FinancesApiFp(configuration);
|
|
275
275
|
return {
|
|
276
276
|
/**
|
|
277
277
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
278
|
-
* @param {
|
|
278
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
280
280
|
* @throws {RequiredError}
|
|
281
281
|
*/
|
|
@@ -284,7 +284,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
284
284
|
},
|
|
285
285
|
/**
|
|
286
286
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
287
|
-
* @param {
|
|
287
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
288
288
|
* @param {*} [options] Override http request option.
|
|
289
289
|
* @throws {RequiredError}
|
|
290
290
|
*/
|
|
@@ -293,7 +293,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
293
293
|
},
|
|
294
294
|
/**
|
|
295
295
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
296
|
-
* @param {
|
|
296
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
297
297
|
* @param {*} [options] Override http request option.
|
|
298
298
|
* @throws {RequiredError}
|
|
299
299
|
*/
|
|
@@ -302,7 +302,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
302
302
|
},
|
|
303
303
|
/**
|
|
304
304
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
305
|
-
* @param {
|
|
305
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
306
306
|
* @param {*} [options] Override http request option.
|
|
307
307
|
* @throws {RequiredError}
|
|
308
308
|
*/
|
|
@@ -312,50 +312,50 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
312
312
|
};
|
|
313
313
|
};
|
|
314
314
|
/**
|
|
315
|
-
*
|
|
315
|
+
* FinancesApi - object-oriented interface
|
|
316
316
|
* @export
|
|
317
|
-
* @class
|
|
317
|
+
* @class FinancesApi
|
|
318
318
|
* @extends {BaseAPI}
|
|
319
319
|
*/
|
|
320
|
-
export class
|
|
320
|
+
export class FinancesApi extends BaseAPI {
|
|
321
321
|
/**
|
|
322
322
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
323
|
-
* @param {
|
|
323
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
324
324
|
* @param {*} [options] Override http request option.
|
|
325
325
|
* @throws {RequiredError}
|
|
326
|
-
* @memberof
|
|
326
|
+
* @memberof FinancesApi
|
|
327
327
|
*/
|
|
328
328
|
listFinancialEventGroups(requestParameters = {}, options) {
|
|
329
|
-
return
|
|
329
|
+
return FinancesApiFp(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
330
330
|
}
|
|
331
331
|
/**
|
|
332
332
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
333
|
-
* @param {
|
|
333
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
335
335
|
* @throws {RequiredError}
|
|
336
|
-
* @memberof
|
|
336
|
+
* @memberof FinancesApi
|
|
337
337
|
*/
|
|
338
338
|
listFinancialEvents(requestParameters = {}, options) {
|
|
339
|
-
return
|
|
339
|
+
return FinancesApiFp(this.configuration).listFinancialEvents(requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
340
340
|
}
|
|
341
341
|
/**
|
|
342
342
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
343
|
-
* @param {
|
|
343
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
344
344
|
* @param {*} [options] Override http request option.
|
|
345
345
|
* @throws {RequiredError}
|
|
346
|
-
* @memberof
|
|
346
|
+
* @memberof FinancesApi
|
|
347
347
|
*/
|
|
348
348
|
listFinancialEventsByGroupId(requestParameters, options) {
|
|
349
|
-
return
|
|
349
|
+
return FinancesApiFp(this.configuration).listFinancialEventsByGroupId(requestParameters.eventGroupId, requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
350
350
|
}
|
|
351
351
|
/**
|
|
352
352
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
353
|
-
* @param {
|
|
353
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
354
354
|
* @param {*} [options] Override http request option.
|
|
355
355
|
* @throws {RequiredError}
|
|
356
|
-
* @memberof
|
|
356
|
+
* @memberof FinancesApi
|
|
357
357
|
*/
|
|
358
358
|
listFinancialEventsByOrderId(requestParameters, options) {
|
|
359
|
-
return
|
|
359
|
+
return FinancesApiFp(this.configuration).listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
360
360
|
}
|
|
361
361
|
}
|
package/dist/es/api-model/api.js
CHANGED
package/dist/es/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
-
import { Configuration,
|
|
2
|
+
import { Configuration, FinancesApi } from './api-model';
|
|
3
3
|
export const clientRateLimits = [
|
|
4
4
|
{
|
|
5
5
|
method: 'get',
|
|
@@ -30,7 +30,7 @@ export const clientRateLimits = [
|
|
|
30
30
|
burst: 30,
|
|
31
31
|
},
|
|
32
32
|
];
|
|
33
|
-
export class FinancesApiClient extends
|
|
33
|
+
export class FinancesApiClient extends FinancesApi {
|
|
34
34
|
constructor(configuration) {
|
|
35
35
|
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
36
36
|
super(new Configuration(), endpoint, axios);
|
|
@@ -16,10 +16,10 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
16
16
|
import type { ListFinancialEventGroupsResponse } from '../models';
|
|
17
17
|
import type { ListFinancialEventsResponse } from '../models';
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* FinancesApi - axios parameter creator
|
|
20
20
|
* @export
|
|
21
21
|
*/
|
|
22
|
-
export declare const
|
|
22
|
+
export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
23
|
/**
|
|
24
24
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
25
25
|
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
@@ -62,10 +62,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
62
62
|
listFinancialEventsByOrderId: (orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
63
|
};
|
|
64
64
|
/**
|
|
65
|
-
*
|
|
65
|
+
* FinancesApi - functional programming interface
|
|
66
66
|
* @export
|
|
67
67
|
*/
|
|
68
|
-
export declare const
|
|
68
|
+
export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
69
69
|
/**
|
|
70
70
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
71
71
|
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
@@ -108,200 +108,200 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
108
108
|
listFinancialEventsByOrderId(orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
109
109
|
};
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* FinancesApi - factory interface
|
|
112
112
|
* @export
|
|
113
113
|
*/
|
|
114
|
-
export declare const
|
|
114
|
+
export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
115
115
|
/**
|
|
116
116
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
117
|
-
* @param {
|
|
117
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
118
118
|
* @param {*} [options] Override http request option.
|
|
119
119
|
* @throws {RequiredError}
|
|
120
120
|
*/
|
|
121
|
-
listFinancialEventGroups(requestParameters?:
|
|
121
|
+
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
|
|
122
122
|
/**
|
|
123
123
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
124
|
-
* @param {
|
|
124
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
125
125
|
* @param {*} [options] Override http request option.
|
|
126
126
|
* @throws {RequiredError}
|
|
127
127
|
*/
|
|
128
|
-
listFinancialEvents(requestParameters?:
|
|
128
|
+
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
129
129
|
/**
|
|
130
130
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
131
|
-
* @param {
|
|
131
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
133
133
|
* @throws {RequiredError}
|
|
134
134
|
*/
|
|
135
|
-
listFinancialEventsByGroupId(requestParameters:
|
|
135
|
+
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
136
136
|
/**
|
|
137
137
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
138
|
-
* @param {
|
|
138
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
139
139
|
* @param {*} [options] Override http request option.
|
|
140
140
|
* @throws {RequiredError}
|
|
141
141
|
*/
|
|
142
|
-
listFinancialEventsByOrderId(requestParameters:
|
|
142
|
+
listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
143
143
|
};
|
|
144
144
|
/**
|
|
145
|
-
* Request parameters for listFinancialEventGroups operation in
|
|
145
|
+
* Request parameters for listFinancialEventGroups operation in FinancesApi.
|
|
146
146
|
* @export
|
|
147
|
-
* @interface
|
|
147
|
+
* @interface FinancesApiListFinancialEventGroupsRequest
|
|
148
148
|
*/
|
|
149
|
-
export interface
|
|
149
|
+
export interface FinancesApiListFinancialEventGroupsRequest {
|
|
150
150
|
/**
|
|
151
151
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
152
152
|
* @type {number}
|
|
153
|
-
* @memberof
|
|
153
|
+
* @memberof FinancesApiListFinancialEventGroups
|
|
154
154
|
*/
|
|
155
155
|
readonly maxResultsPerPage?: number;
|
|
156
156
|
/**
|
|
157
157
|
* A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.
|
|
158
158
|
* @type {string}
|
|
159
|
-
* @memberof
|
|
159
|
+
* @memberof FinancesApiListFinancialEventGroups
|
|
160
160
|
*/
|
|
161
161
|
readonly financialEventGroupStartedBefore?: string;
|
|
162
162
|
/**
|
|
163
163
|
* A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted.
|
|
164
164
|
* @type {string}
|
|
165
|
-
* @memberof
|
|
165
|
+
* @memberof FinancesApiListFinancialEventGroups
|
|
166
166
|
*/
|
|
167
167
|
readonly financialEventGroupStartedAfter?: string;
|
|
168
168
|
/**
|
|
169
169
|
* A string token returned in the response of your previous request.
|
|
170
170
|
* @type {string}
|
|
171
|
-
* @memberof
|
|
171
|
+
* @memberof FinancesApiListFinancialEventGroups
|
|
172
172
|
*/
|
|
173
173
|
readonly nextToken?: string;
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* Request parameters for listFinancialEvents operation in
|
|
176
|
+
* Request parameters for listFinancialEvents operation in FinancesApi.
|
|
177
177
|
* @export
|
|
178
|
-
* @interface
|
|
178
|
+
* @interface FinancesApiListFinancialEventsRequest
|
|
179
179
|
*/
|
|
180
|
-
export interface
|
|
180
|
+
export interface FinancesApiListFinancialEventsRequest {
|
|
181
181
|
/**
|
|
182
182
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
183
183
|
* @type {number}
|
|
184
|
-
* @memberof
|
|
184
|
+
* @memberof FinancesApiListFinancialEvents
|
|
185
185
|
*/
|
|
186
186
|
readonly maxResultsPerPage?: number;
|
|
187
187
|
/**
|
|
188
188
|
* A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
|
|
189
189
|
* @type {string}
|
|
190
|
-
* @memberof
|
|
190
|
+
* @memberof FinancesApiListFinancialEvents
|
|
191
191
|
*/
|
|
192
192
|
readonly postedAfter?: string;
|
|
193
193
|
/**
|
|
194
194
|
* A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
195
195
|
* @type {string}
|
|
196
|
-
* @memberof
|
|
196
|
+
* @memberof FinancesApiListFinancialEvents
|
|
197
197
|
*/
|
|
198
198
|
readonly postedBefore?: string;
|
|
199
199
|
/**
|
|
200
200
|
* A string token returned in the response of your previous request.
|
|
201
201
|
* @type {string}
|
|
202
|
-
* @memberof
|
|
202
|
+
* @memberof FinancesApiListFinancialEvents
|
|
203
203
|
*/
|
|
204
204
|
readonly nextToken?: string;
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* Request parameters for listFinancialEventsByGroupId operation in
|
|
207
|
+
* Request parameters for listFinancialEventsByGroupId operation in FinancesApi.
|
|
208
208
|
* @export
|
|
209
|
-
* @interface
|
|
209
|
+
* @interface FinancesApiListFinancialEventsByGroupIdRequest
|
|
210
210
|
*/
|
|
211
|
-
export interface
|
|
211
|
+
export interface FinancesApiListFinancialEventsByGroupIdRequest {
|
|
212
212
|
/**
|
|
213
213
|
* The identifier of the financial event group to which the events belong.
|
|
214
214
|
* @type {string}
|
|
215
|
-
* @memberof
|
|
215
|
+
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
216
216
|
*/
|
|
217
217
|
readonly eventGroupId: string;
|
|
218
218
|
/**
|
|
219
219
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
220
220
|
* @type {number}
|
|
221
|
-
* @memberof
|
|
221
|
+
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
222
222
|
*/
|
|
223
223
|
readonly maxResultsPerPage?: number;
|
|
224
224
|
/**
|
|
225
225
|
* A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
|
|
226
226
|
* @type {string}
|
|
227
|
-
* @memberof
|
|
227
|
+
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
228
228
|
*/
|
|
229
229
|
readonly postedAfter?: string;
|
|
230
230
|
/**
|
|
231
231
|
* A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes.
|
|
232
232
|
* @type {string}
|
|
233
|
-
* @memberof
|
|
233
|
+
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
234
234
|
*/
|
|
235
235
|
readonly postedBefore?: string;
|
|
236
236
|
/**
|
|
237
237
|
* A string token returned in the response of your previous request.
|
|
238
238
|
* @type {string}
|
|
239
|
-
* @memberof
|
|
239
|
+
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
240
240
|
*/
|
|
241
241
|
readonly nextToken?: string;
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
244
|
-
* Request parameters for listFinancialEventsByOrderId operation in
|
|
244
|
+
* Request parameters for listFinancialEventsByOrderId operation in FinancesApi.
|
|
245
245
|
* @export
|
|
246
|
-
* @interface
|
|
246
|
+
* @interface FinancesApiListFinancialEventsByOrderIdRequest
|
|
247
247
|
*/
|
|
248
|
-
export interface
|
|
248
|
+
export interface FinancesApiListFinancialEventsByOrderIdRequest {
|
|
249
249
|
/**
|
|
250
250
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
251
251
|
* @type {string}
|
|
252
|
-
* @memberof
|
|
252
|
+
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
253
253
|
*/
|
|
254
254
|
readonly orderId: string;
|
|
255
255
|
/**
|
|
256
256
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
257
257
|
* @type {number}
|
|
258
|
-
* @memberof
|
|
258
|
+
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
259
259
|
*/
|
|
260
260
|
readonly maxResultsPerPage?: number;
|
|
261
261
|
/**
|
|
262
262
|
* A string token returned in the response of your previous request.
|
|
263
263
|
* @type {string}
|
|
264
|
-
* @memberof
|
|
264
|
+
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
265
265
|
*/
|
|
266
266
|
readonly nextToken?: string;
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* FinancesApi - object-oriented interface
|
|
270
270
|
* @export
|
|
271
|
-
* @class
|
|
271
|
+
* @class FinancesApi
|
|
272
272
|
* @extends {BaseAPI}
|
|
273
273
|
*/
|
|
274
|
-
export declare class
|
|
274
|
+
export declare class FinancesApi extends BaseAPI {
|
|
275
275
|
/**
|
|
276
276
|
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
277
|
-
* @param {
|
|
277
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
278
278
|
* @param {*} [options] Override http request option.
|
|
279
279
|
* @throws {RequiredError}
|
|
280
|
-
* @memberof
|
|
280
|
+
* @memberof FinancesApi
|
|
281
281
|
*/
|
|
282
|
-
listFinancialEventGroups(requestParameters?:
|
|
282
|
+
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventGroupsResponse, any>>;
|
|
283
283
|
/**
|
|
284
284
|
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
285
|
-
* @param {
|
|
285
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
287
287
|
* @throws {RequiredError}
|
|
288
|
-
* @memberof
|
|
288
|
+
* @memberof FinancesApi
|
|
289
289
|
*/
|
|
290
|
-
listFinancialEvents(requestParameters?:
|
|
290
|
+
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
291
291
|
/**
|
|
292
292
|
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
293
|
-
* @param {
|
|
293
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
296
|
-
* @memberof
|
|
296
|
+
* @memberof FinancesApi
|
|
297
297
|
*/
|
|
298
|
-
listFinancialEventsByGroupId(requestParameters:
|
|
298
|
+
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
299
299
|
/**
|
|
300
300
|
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
301
|
-
* @param {
|
|
301
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
304
|
-
* @memberof
|
|
304
|
+
* @memberof FinancesApi
|
|
305
305
|
*/
|
|
306
|
-
listFinancialEventsByOrderId(requestParameters:
|
|
306
|
+
listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
307
307
|
}
|
package/dist/types/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
|
|
2
|
-
import {
|
|
2
|
+
import { FinancesApi } from './api-model';
|
|
3
3
|
export declare const clientRateLimits: RateLimit[];
|
|
4
|
-
export declare class FinancesApiClient extends
|
|
4
|
+
export declare class FinancesApiClient extends FinancesApi {
|
|
5
5
|
constructor(configuration: ClientConfiguration);
|
|
6
6
|
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/finances-api-v0",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "4.0.0",
|
|
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.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.14",
|
|
22
|
+
"axios": "^1.9.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"finances api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
|
|
44
44
|
}
|