@sp-api-sdk/finances-api-2024-06-19 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +97 -0
- package/dist/cjs/index.js +19 -0
- package/dist/cjs/src/api-model/api/default-api.js +143 -0
- package/dist/cjs/src/api-model/api.js +30 -0
- package/dist/cjs/src/api-model/base.js +71 -0
- package/dist/cjs/src/api-model/common.js +145 -0
- package/dist/cjs/src/api-model/configuration.js +99 -0
- package/dist/cjs/src/api-model/index.js +32 -0
- package/dist/cjs/src/api-model/models/amazon-pay-context.js +15 -0
- package/dist/cjs/src/api-model/models/breakdown.js +15 -0
- package/dist/cjs/src/api-model/models/context-all-of.js +15 -0
- package/dist/cjs/src/api-model/models/context.js +15 -0
- package/dist/cjs/src/api-model/models/currency.js +15 -0
- package/dist/cjs/src/api-model/models/deferred-context.js +15 -0
- package/dist/cjs/src/api-model/models/error-list.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +34 -0
- package/dist/cjs/src/api-model/models/item-related-identifier.js +22 -0
- package/dist/cjs/src/api-model/models/item.js +15 -0
- package/dist/cjs/src/api-model/models/list-transactions-response.js +15 -0
- package/dist/cjs/src/api-model/models/marketplace-details.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/payments-context.js +15 -0
- package/dist/cjs/src/api-model/models/product-context.js +15 -0
- package/dist/cjs/src/api-model/models/related-identifier.js +26 -0
- package/dist/cjs/src/api-model/models/selling-partner-metadata.js +15 -0
- package/dist/cjs/src/api-model/models/time-range-context.js +15 -0
- package/dist/cjs/src/api-model/models/transaction.js +15 -0
- package/dist/cjs/src/client.js +21 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/default-api.js +133 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +63 -0
- package/dist/es/src/api-model/common.js +133 -0
- package/dist/es/src/api-model/configuration.js +95 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/amazon-pay-context.js +14 -0
- package/dist/es/src/api-model/models/breakdown.js +14 -0
- package/dist/es/src/api-model/models/context-all-of.js +14 -0
- package/dist/es/src/api-model/models/context.js +14 -0
- package/dist/es/src/api-model/models/currency.js +14 -0
- package/dist/es/src/api-model/models/deferred-context.js +14 -0
- package/dist/es/src/api-model/models/error-list.js +14 -0
- package/dist/es/src/api-model/models/index.js +18 -0
- package/dist/es/src/api-model/models/item-related-identifier.js +19 -0
- package/dist/es/src/api-model/models/item.js +14 -0
- package/dist/es/src/api-model/models/list-transactions-response.js +14 -0
- package/dist/es/src/api-model/models/marketplace-details.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/payments-context.js +14 -0
- package/dist/es/src/api-model/models/product-context.js +14 -0
- package/dist/es/src/api-model/models/related-identifier.js +23 -0
- package/dist/es/src/api-model/models/selling-partner-metadata.js +14 -0
- package/dist/es/src/api-model/models/time-range-context.js +14 -0
- package/dist/es/src/api-model/models/transaction.js +14 -0
- package/dist/es/src/client.js +17 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/default-api.d.ts +108 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +66 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +91 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/amazon-pay-context.d.ts +36 -0
- package/dist/types/src/api-model/models/breakdown.d.ts +37 -0
- package/dist/types/src/api-model/models/context-all-of.d.ts +24 -0
- package/dist/types/src/api-model/models/context.d.ts +23 -0
- package/dist/types/src/api-model/models/currency.d.ts +30 -0
- package/dist/types/src/api-model/models/deferred-context.d.ts +36 -0
- package/dist/types/src/api-model/models/error-list.d.ts +24 -0
- package/dist/types/src/api-model/models/index.d.ts +18 -0
- package/dist/types/src/api-model/models/item-related-identifier.d.ts +37 -0
- package/dist/types/src/api-model/models/item.d.ts +52 -0
- package/dist/types/src/api-model/models/list-transactions-response.d.ts +31 -0
- package/dist/types/src/api-model/models/marketplace-details.d.ts +30 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/payments-context.d.ts +42 -0
- package/dist/types/src/api-model/models/product-context.d.ts +42 -0
- package/dist/types/src/api-model/models/related-identifier.d.ts +41 -0
- package/dist/types/src/api-model/models/selling-partner-metadata.d.ts +36 -0
- package/dist/types/src/api-model/models/time-range-context.d.ts +30 -0
- package/dist/types/src/api-model/models/transaction.d.ts +97 -0
- package/dist/types/src/client.d.ts +6 -0
- package/package.json +44 -0
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { ListTransactionsResponse } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* DefaultApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
* Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
24
|
+
* @param {string} postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
25
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
26
|
+
* @param {string} [marketplaceId] The ID of the marketplace from which you want to retrieve transactions.
|
|
27
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
listTransactions: (postedAfter: string, postedBefore?: string, marketplaceId?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* DefaultApi - functional programming interface
|
|
35
|
+
* @export
|
|
36
|
+
*/
|
|
37
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
38
|
+
/**
|
|
39
|
+
* Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
40
|
+
* @param {string} postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
41
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
42
|
+
* @param {string} [marketplaceId] The ID of the marketplace from which you want to retrieve transactions.
|
|
43
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
listTransactions(postedAfter: string, postedBefore?: string, marketplaceId?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* DefaultApi - factory interface
|
|
51
|
+
* @export
|
|
52
|
+
*/
|
|
53
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
54
|
+
/**
|
|
55
|
+
* Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
56
|
+
* @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
listTransactions(requestParameters: DefaultApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Request parameters for listTransactions operation in DefaultApi.
|
|
64
|
+
* @export
|
|
65
|
+
* @interface DefaultApiListTransactionsRequest
|
|
66
|
+
*/
|
|
67
|
+
export interface DefaultApiListTransactionsRequest {
|
|
68
|
+
/**
|
|
69
|
+
* The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof DefaultApiListTransactions
|
|
72
|
+
*/
|
|
73
|
+
readonly postedAfter: string;
|
|
74
|
+
/**
|
|
75
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof DefaultApiListTransactions
|
|
78
|
+
*/
|
|
79
|
+
readonly postedBefore?: string;
|
|
80
|
+
/**
|
|
81
|
+
* The ID of the marketplace from which you want to retrieve transactions.
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof DefaultApiListTransactions
|
|
84
|
+
*/
|
|
85
|
+
readonly marketplaceId?: string;
|
|
86
|
+
/**
|
|
87
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof DefaultApiListTransactions
|
|
90
|
+
*/
|
|
91
|
+
readonly nextToken?: string;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* DefaultApi - object-oriented interface
|
|
95
|
+
* @export
|
|
96
|
+
* @class DefaultApi
|
|
97
|
+
* @extends {BaseAPI}
|
|
98
|
+
*/
|
|
99
|
+
export declare class DefaultApi extends BaseAPI {
|
|
100
|
+
/**
|
|
101
|
+
* Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
102
|
+
* @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
* @memberof DefaultApi
|
|
106
|
+
*/
|
|
107
|
+
listTransactions(requestParameters: DefaultApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTransactionsResponse, any>>;
|
|
108
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from './api/default-api';
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
constructor(field: string, msg?: string);
|
|
54
|
+
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface ConfigurationParameters {
|
|
13
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
|
+
username?: string;
|
|
15
|
+
password?: string;
|
|
16
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
|
+
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
19
|
+
baseOptions?: any;
|
|
20
|
+
formDataCtor?: new () => any;
|
|
21
|
+
}
|
|
22
|
+
export declare class Configuration {
|
|
23
|
+
/**
|
|
24
|
+
* parameter for apiKey security
|
|
25
|
+
* @param name security name
|
|
26
|
+
* @memberof Configuration
|
|
27
|
+
*/
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
/**
|
|
30
|
+
* parameter for basic security
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Configuration
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* parameter for basic security
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof Configuration
|
|
41
|
+
*/
|
|
42
|
+
password?: string;
|
|
43
|
+
/**
|
|
44
|
+
* parameter for oauth2 security
|
|
45
|
+
* @param name security name
|
|
46
|
+
* @param scopes oauth2 scope
|
|
47
|
+
* @memberof Configuration
|
|
48
|
+
*/
|
|
49
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
|
+
/**
|
|
51
|
+
* override base path
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Configuration
|
|
55
|
+
*/
|
|
56
|
+
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
64
|
+
/**
|
|
65
|
+
* base options for axios calls
|
|
66
|
+
*
|
|
67
|
+
* @type {any}
|
|
68
|
+
* @memberof Configuration
|
|
69
|
+
*/
|
|
70
|
+
baseOptions?: any;
|
|
71
|
+
/**
|
|
72
|
+
* The FormData constructor that will be used to create multipart form data
|
|
73
|
+
* requests. You can inject this here so that execution environments that
|
|
74
|
+
* do not support the FormData class can still run the generated client.
|
|
75
|
+
*
|
|
76
|
+
* @type {new () => FormData}
|
|
77
|
+
*/
|
|
78
|
+
formDataCtor?: new () => any;
|
|
79
|
+
constructor(param?: ConfigurationParameters);
|
|
80
|
+
/**
|
|
81
|
+
* Check if the given MIME is a JSON MIME.
|
|
82
|
+
* JSON MIME examples:
|
|
83
|
+
* application/json
|
|
84
|
+
* application/json; charset=UTF8
|
|
85
|
+
* APPLICATION/JSON
|
|
86
|
+
* application/vnd.company+json
|
|
87
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
88
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
isJsonMime(mime: string): boolean;
|
|
91
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from "./api";
|
|
13
|
+
export * from "./configuration";
|
|
14
|
+
export * from "./models";
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Additional information related to Amazon Pay.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AmazonPayContext
|
|
16
|
+
*/
|
|
17
|
+
export interface AmazonPayContext {
|
|
18
|
+
/**
|
|
19
|
+
* The name of the store that is related to the transaction.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AmazonPayContext
|
|
22
|
+
*/
|
|
23
|
+
'storeName'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* The transaction\'s order type.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AmazonPayContext
|
|
28
|
+
*/
|
|
29
|
+
'orderType'?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Channel details of related transaction.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof AmazonPayContext
|
|
34
|
+
*/
|
|
35
|
+
'channel'?: string;
|
|
36
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Currency } from './currency';
|
|
13
|
+
/**
|
|
14
|
+
* Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface Breakdown
|
|
17
|
+
*/
|
|
18
|
+
export interface Breakdown {
|
|
19
|
+
/**
|
|
20
|
+
* The type of charge.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof Breakdown
|
|
23
|
+
*/
|
|
24
|
+
'breakdownType'?: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {Currency}
|
|
28
|
+
* @memberof Breakdown
|
|
29
|
+
*/
|
|
30
|
+
'breakdownAmount'?: Currency;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {Breakdown}
|
|
34
|
+
* @memberof Breakdown
|
|
35
|
+
*/
|
|
36
|
+
'breakdowns'?: Breakdown;
|
|
37
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ContextAllOf
|
|
16
|
+
*/
|
|
17
|
+
export interface ContextAllOf {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ContextAllOf
|
|
22
|
+
*/
|
|
23
|
+
'contextType': string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { AmazonPayContext } from './amazon-pay-context';
|
|
13
|
+
import type { ContextAllOf } from './context-all-of';
|
|
14
|
+
import type { DeferredContext } from './deferred-context';
|
|
15
|
+
import type { PaymentsContext } from './payments-context';
|
|
16
|
+
import type { ProductContext } from './product-context';
|
|
17
|
+
import type { TimeRangeContext } from './time-range-context';
|
|
18
|
+
/**
|
|
19
|
+
* @type Context
|
|
20
|
+
* Additional Information about the item.
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export type Context = AmazonPayContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A currency type and amount.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface Currency
|
|
16
|
+
*/
|
|
17
|
+
export interface Currency {
|
|
18
|
+
/**
|
|
19
|
+
* The three-digit currency code in ISO 4217 format.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof Currency
|
|
22
|
+
*/
|
|
23
|
+
'currencyCode'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A signed decimal number.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof Currency
|
|
28
|
+
*/
|
|
29
|
+
'currencyAmount'?: number;
|
|
30
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Additional information related to deferred transactions.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface DeferredContext
|
|
16
|
+
*/
|
|
17
|
+
export interface DeferredContext {
|
|
18
|
+
/**
|
|
19
|
+
* Deferral policy applied on the transaction. **Examples:** `B2B`,`DD7`
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof DeferredContext
|
|
22
|
+
*/
|
|
23
|
+
'deferralReason'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof DeferredContext
|
|
28
|
+
*/
|
|
29
|
+
'maturityDate'?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The status of the transaction. For example, `HOLD`,`RELEASE`.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof DeferredContext
|
|
34
|
+
*/
|
|
35
|
+
'deferralStatus'?: string;
|
|
36
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ErrorList
|
|
16
|
+
*/
|
|
17
|
+
export interface ErrorList {
|
|
18
|
+
/**
|
|
19
|
+
* The error responses that are returned when the request is unsuccessful.
|
|
20
|
+
* @type {Array<Error>}
|
|
21
|
+
* @memberof ErrorList
|
|
22
|
+
*/
|
|
23
|
+
'errors': Array<Error>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export * from './amazon-pay-context';
|
|
2
|
+
export * from './breakdown';
|
|
3
|
+
export * from './context';
|
|
4
|
+
export * from './context-all-of';
|
|
5
|
+
export * from './currency';
|
|
6
|
+
export * from './deferred-context';
|
|
7
|
+
export * from './error-list';
|
|
8
|
+
export * from './item';
|
|
9
|
+
export * from './item-related-identifier';
|
|
10
|
+
export * from './list-transactions-response';
|
|
11
|
+
export * from './marketplace-details';
|
|
12
|
+
export * from './model-error';
|
|
13
|
+
export * from './payments-context';
|
|
14
|
+
export * from './product-context';
|
|
15
|
+
export * from './related-identifier';
|
|
16
|
+
export * from './selling-partner-metadata';
|
|
17
|
+
export * from './time-range-context';
|
|
18
|
+
export * from './transaction';
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Related business identifiers of the item.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ItemRelatedIdentifier
|
|
16
|
+
*/
|
|
17
|
+
export interface ItemRelatedIdentifier {
|
|
18
|
+
/**
|
|
19
|
+
* Enumerated set of related item identifier names for the item.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ItemRelatedIdentifier
|
|
22
|
+
*/
|
|
23
|
+
'itemRelatedIdentifierName'?: ItemRelatedIdentifierItemRelatedIdentifierNameEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Corresponding value to `ItemRelatedIdentifierName`.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ItemRelatedIdentifier
|
|
28
|
+
*/
|
|
29
|
+
'itemRelatedIdentifierValue'?: string;
|
|
30
|
+
}
|
|
31
|
+
export declare const ItemRelatedIdentifierItemRelatedIdentifierNameEnum: {
|
|
32
|
+
readonly OrderAdjustmentItemId: "ORDER_ADJUSTMENT_ITEM_ID";
|
|
33
|
+
readonly CouponId: "COUPON_ID";
|
|
34
|
+
readonly RemovalShipmentItemId: "REMOVAL_SHIPMENT_ITEM_ID";
|
|
35
|
+
readonly TransactionId: "TRANSACTION_ID";
|
|
36
|
+
};
|
|
37
|
+
export type ItemRelatedIdentifierItemRelatedIdentifierNameEnum = typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum[keyof typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum];
|