@sp-api-sdk/vendor-transaction-status-api-v1 4.0.17 → 5.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/README.md +4 -4
- package/dist/index.cjs +306 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +295 -0
- package/dist/index.d.ts +295 -0
- package/dist/index.js +263 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -12
- package/dist/cjs/api-model/api/vendor-transaction-status-api.js +0 -116
- package/dist/cjs/api-model/api.js +0 -30
- package/dist/cjs/api-model/base.js +0 -52
- package/dist/cjs/api-model/common.js +0 -123
- package/dist/cjs/api-model/configuration.js +0 -98
- package/dist/cjs/api-model/index.js +0 -32
- package/dist/cjs/api-model/models/get-transaction-response.js +0 -15
- package/dist/cjs/api-model/models/index.js +0 -20
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/transaction-status.js +0 -15
- package/dist/cjs/api-model/models/transaction.js +0 -21
- package/dist/cjs/client.js +0 -21
- package/dist/cjs/index.js +0 -19
- package/dist/es/api-model/api/vendor-transaction-status-api.js +0 -106
- package/dist/es/api-model/api.js +0 -14
- package/dist/es/api-model/base.js +0 -44
- package/dist/es/api-model/common.js +0 -110
- package/dist/es/api-model/configuration.js +0 -94
- package/dist/es/api-model/index.js +0 -16
- package/dist/es/api-model/models/get-transaction-response.js +0 -14
- package/dist/es/api-model/models/index.js +0 -4
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/transaction-status.js +0 -14
- package/dist/es/api-model/models/transaction.js +0 -18
- package/dist/es/client.js +0 -17
- package/dist/es/index.js +0 -3
- package/dist/types/api-model/api/vendor-transaction-status-api.d.ts +0 -73
- package/dist/types/api-model/api.d.ts +0 -12
- package/dist/types/api-model/base.d.ts +0 -42
- package/dist/types/api-model/common.d.ts +0 -34
- package/dist/types/api-model/configuration.d.ts +0 -98
- package/dist/types/api-model/index.d.ts +0 -14
- package/dist/types/api-model/models/get-transaction-response.d.ts +0 -22
- package/dist/types/api-model/models/index.d.ts +0 -4
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/transaction-status.d.ts +0 -18
- package/dist/types/api-model/models/transaction.d.ts +0 -34
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
2
|
+
import * as axios from 'axios';
|
|
3
|
+
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
7
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
8
|
+
*
|
|
9
|
+
* The version of the OpenAPI document: v1
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
13
|
+
* https://openapi-generator.tech
|
|
14
|
+
* Do not edit the class manually.
|
|
15
|
+
*/
|
|
16
|
+
interface AWSv4Configuration {
|
|
17
|
+
options?: {
|
|
18
|
+
region?: string;
|
|
19
|
+
service?: string;
|
|
20
|
+
};
|
|
21
|
+
credentials?: {
|
|
22
|
+
accessKeyId?: string;
|
|
23
|
+
secretAccessKey?: string;
|
|
24
|
+
sessionToken?: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface ConfigurationParameters {
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
username?: string;
|
|
30
|
+
password?: string;
|
|
31
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
32
|
+
awsv4?: AWSv4Configuration;
|
|
33
|
+
basePath?: string;
|
|
34
|
+
serverIndex?: number;
|
|
35
|
+
baseOptions?: any;
|
|
36
|
+
formDataCtor?: new () => any;
|
|
37
|
+
}
|
|
38
|
+
declare class Configuration {
|
|
39
|
+
/**
|
|
40
|
+
* parameter for apiKey security
|
|
41
|
+
* @param name security name
|
|
42
|
+
*/
|
|
43
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
44
|
+
/**
|
|
45
|
+
* parameter for basic security
|
|
46
|
+
*/
|
|
47
|
+
username?: string;
|
|
48
|
+
/**
|
|
49
|
+
* parameter for basic security
|
|
50
|
+
*/
|
|
51
|
+
password?: string;
|
|
52
|
+
/**
|
|
53
|
+
* parameter for oauth2 security
|
|
54
|
+
* @param name security name
|
|
55
|
+
* @param scopes oauth2 scope
|
|
56
|
+
*/
|
|
57
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
+
/**
|
|
59
|
+
* parameter for aws4 signature security
|
|
60
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
+
* @param {string} options.region - aws region
|
|
62
|
+
* @param {string} options.service - name of the service.
|
|
63
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
+
* @memberof Configuration
|
|
67
|
+
*/
|
|
68
|
+
awsv4?: AWSv4Configuration;
|
|
69
|
+
/**
|
|
70
|
+
* override base path
|
|
71
|
+
*/
|
|
72
|
+
basePath?: string;
|
|
73
|
+
/**
|
|
74
|
+
* override server index
|
|
75
|
+
*/
|
|
76
|
+
serverIndex?: number;
|
|
77
|
+
/**
|
|
78
|
+
* base options for axios calls
|
|
79
|
+
*/
|
|
80
|
+
baseOptions?: any;
|
|
81
|
+
/**
|
|
82
|
+
* The FormData constructor that will be used to create multipart form data
|
|
83
|
+
* requests. You can inject this here so that execution environments that
|
|
84
|
+
* do not support the FormData class can still run the generated client.
|
|
85
|
+
*
|
|
86
|
+
* @type {new () => FormData}
|
|
87
|
+
*/
|
|
88
|
+
formDataCtor?: new () => any;
|
|
89
|
+
constructor(param?: ConfigurationParameters);
|
|
90
|
+
/**
|
|
91
|
+
* Check if the given MIME is a JSON MIME.
|
|
92
|
+
* JSON MIME examples:
|
|
93
|
+
* application/json
|
|
94
|
+
* application/json; charset=UTF8
|
|
95
|
+
* APPLICATION/JSON
|
|
96
|
+
* application/vnd.company+json
|
|
97
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
98
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
99
|
+
*/
|
|
100
|
+
isJsonMime(mime: string): boolean;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
105
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
106
|
+
*
|
|
107
|
+
* The version of the OpenAPI document: v1
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
+
* https://openapi-generator.tech
|
|
112
|
+
* Do not edit the class manually.
|
|
113
|
+
*/
|
|
114
|
+
|
|
115
|
+
interface RequestArgs {
|
|
116
|
+
url: string;
|
|
117
|
+
options: RawAxiosRequestConfig;
|
|
118
|
+
}
|
|
119
|
+
declare class BaseAPI {
|
|
120
|
+
protected basePath: string;
|
|
121
|
+
protected axios: AxiosInstance;
|
|
122
|
+
protected configuration: Configuration | undefined;
|
|
123
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
128
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
129
|
+
*
|
|
130
|
+
* The version of the OpenAPI document: v1
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
134
|
+
* https://openapi-generator.tech
|
|
135
|
+
* Do not edit the class manually.
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* The transaction status.
|
|
139
|
+
*/
|
|
140
|
+
interface Transaction {
|
|
141
|
+
/**
|
|
142
|
+
* The unique identifier returned in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
143
|
+
*/
|
|
144
|
+
'transactionId': string;
|
|
145
|
+
/**
|
|
146
|
+
* Current processing status of the transaction.
|
|
147
|
+
*/
|
|
148
|
+
'status': TransactionStatusEnum;
|
|
149
|
+
/**
|
|
150
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
151
|
+
*/
|
|
152
|
+
'errors'?: Array<Error>;
|
|
153
|
+
}
|
|
154
|
+
declare const TransactionStatusEnum: {
|
|
155
|
+
readonly Failure: "Failure";
|
|
156
|
+
readonly Processing: "Processing";
|
|
157
|
+
readonly Success: "Success";
|
|
158
|
+
};
|
|
159
|
+
type TransactionStatusEnum = typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum];
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
163
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
164
|
+
*
|
|
165
|
+
* The version of the OpenAPI document: v1
|
|
166
|
+
*
|
|
167
|
+
*
|
|
168
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
169
|
+
* https://openapi-generator.tech
|
|
170
|
+
* Do not edit the class manually.
|
|
171
|
+
*/
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Represents the status of a transaction.
|
|
175
|
+
*/
|
|
176
|
+
interface TransactionStatus {
|
|
177
|
+
'transactionStatus'?: Transaction;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
182
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
183
|
+
*
|
|
184
|
+
* The version of the OpenAPI document: v1
|
|
185
|
+
*
|
|
186
|
+
*
|
|
187
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
188
|
+
* https://openapi-generator.tech
|
|
189
|
+
* Do not edit the class manually.
|
|
190
|
+
*/
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The response schema for the getTransaction operation.
|
|
194
|
+
*/
|
|
195
|
+
interface GetTransactionResponse {
|
|
196
|
+
'payload'?: TransactionStatus;
|
|
197
|
+
/**
|
|
198
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
199
|
+
*/
|
|
200
|
+
'errors'?: Array<Error>;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
205
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
206
|
+
*
|
|
207
|
+
* The version of the OpenAPI document: v1
|
|
208
|
+
*
|
|
209
|
+
*
|
|
210
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
211
|
+
* https://openapi-generator.tech
|
|
212
|
+
* Do not edit the class manually.
|
|
213
|
+
*/
|
|
214
|
+
/**
|
|
215
|
+
* Error response returned when the request is unsuccessful.
|
|
216
|
+
*/
|
|
217
|
+
interface ModelError {
|
|
218
|
+
/**
|
|
219
|
+
* An error code that identifies the type of error that occurred.
|
|
220
|
+
*/
|
|
221
|
+
'code': string;
|
|
222
|
+
/**
|
|
223
|
+
* A message that describes the error condition.
|
|
224
|
+
*/
|
|
225
|
+
'message': string;
|
|
226
|
+
/**
|
|
227
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
228
|
+
*/
|
|
229
|
+
'details'?: string;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* VendorTransactionStatusApi - axios parameter creator
|
|
234
|
+
*/
|
|
235
|
+
declare const VendorTransactionStatusApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
236
|
+
/**
|
|
237
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
238
|
+
* @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
getTransaction: (transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
243
|
+
};
|
|
244
|
+
/**
|
|
245
|
+
* VendorTransactionStatusApi - functional programming interface
|
|
246
|
+
*/
|
|
247
|
+
declare const VendorTransactionStatusApiFp: (configuration?: Configuration) => {
|
|
248
|
+
/**
|
|
249
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
250
|
+
* @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
251
|
+
* @param {*} [options] Override http request option.
|
|
252
|
+
* @throws {RequiredError}
|
|
253
|
+
*/
|
|
254
|
+
getTransaction(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTransactionResponse>>;
|
|
255
|
+
};
|
|
256
|
+
/**
|
|
257
|
+
* VendorTransactionStatusApi - factory interface
|
|
258
|
+
*/
|
|
259
|
+
declare const VendorTransactionStatusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
260
|
+
/**
|
|
261
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
262
|
+
* @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
getTransaction(requestParameters: VendorTransactionStatusApiGetTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetTransactionResponse>;
|
|
267
|
+
};
|
|
268
|
+
/**
|
|
269
|
+
* Request parameters for getTransaction operation in VendorTransactionStatusApi.
|
|
270
|
+
*/
|
|
271
|
+
interface VendorTransactionStatusApiGetTransactionRequest {
|
|
272
|
+
/**
|
|
273
|
+
* The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
274
|
+
*/
|
|
275
|
+
readonly transactionId: string;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* VendorTransactionStatusApi - object-oriented interface
|
|
279
|
+
*/
|
|
280
|
+
declare class VendorTransactionStatusApi extends BaseAPI {
|
|
281
|
+
/**
|
|
282
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
283
|
+
* @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
getTransaction(requestParameters: VendorTransactionStatusApiGetTransactionRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetTransactionResponse, any, {}>>;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
declare const clientRateLimits: RateLimit[];
|
|
291
|
+
declare class VendorTransactionStatusApiClient extends VendorTransactionStatusApi {
|
|
292
|
+
constructor(configuration: ClientConfiguration);
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
export { type GetTransactionResponse, type ModelError, type Transaction, type TransactionStatus, TransactionStatusEnum, VendorTransactionStatusApi, VendorTransactionStatusApiAxiosParamCreator, VendorTransactionStatusApiClient, VendorTransactionStatusApiFactory, VendorTransactionStatusApiFp, type VendorTransactionStatusApiGetTransactionRequest, clientRateLimits };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
2
|
+
import * as axios from 'axios';
|
|
3
|
+
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
7
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
8
|
+
*
|
|
9
|
+
* The version of the OpenAPI document: v1
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
13
|
+
* https://openapi-generator.tech
|
|
14
|
+
* Do not edit the class manually.
|
|
15
|
+
*/
|
|
16
|
+
interface AWSv4Configuration {
|
|
17
|
+
options?: {
|
|
18
|
+
region?: string;
|
|
19
|
+
service?: string;
|
|
20
|
+
};
|
|
21
|
+
credentials?: {
|
|
22
|
+
accessKeyId?: string;
|
|
23
|
+
secretAccessKey?: string;
|
|
24
|
+
sessionToken?: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface ConfigurationParameters {
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
username?: string;
|
|
30
|
+
password?: string;
|
|
31
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
32
|
+
awsv4?: AWSv4Configuration;
|
|
33
|
+
basePath?: string;
|
|
34
|
+
serverIndex?: number;
|
|
35
|
+
baseOptions?: any;
|
|
36
|
+
formDataCtor?: new () => any;
|
|
37
|
+
}
|
|
38
|
+
declare class Configuration {
|
|
39
|
+
/**
|
|
40
|
+
* parameter for apiKey security
|
|
41
|
+
* @param name security name
|
|
42
|
+
*/
|
|
43
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
44
|
+
/**
|
|
45
|
+
* parameter for basic security
|
|
46
|
+
*/
|
|
47
|
+
username?: string;
|
|
48
|
+
/**
|
|
49
|
+
* parameter for basic security
|
|
50
|
+
*/
|
|
51
|
+
password?: string;
|
|
52
|
+
/**
|
|
53
|
+
* parameter for oauth2 security
|
|
54
|
+
* @param name security name
|
|
55
|
+
* @param scopes oauth2 scope
|
|
56
|
+
*/
|
|
57
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
+
/**
|
|
59
|
+
* parameter for aws4 signature security
|
|
60
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
+
* @param {string} options.region - aws region
|
|
62
|
+
* @param {string} options.service - name of the service.
|
|
63
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
+
* @memberof Configuration
|
|
67
|
+
*/
|
|
68
|
+
awsv4?: AWSv4Configuration;
|
|
69
|
+
/**
|
|
70
|
+
* override base path
|
|
71
|
+
*/
|
|
72
|
+
basePath?: string;
|
|
73
|
+
/**
|
|
74
|
+
* override server index
|
|
75
|
+
*/
|
|
76
|
+
serverIndex?: number;
|
|
77
|
+
/**
|
|
78
|
+
* base options for axios calls
|
|
79
|
+
*/
|
|
80
|
+
baseOptions?: any;
|
|
81
|
+
/**
|
|
82
|
+
* The FormData constructor that will be used to create multipart form data
|
|
83
|
+
* requests. You can inject this here so that execution environments that
|
|
84
|
+
* do not support the FormData class can still run the generated client.
|
|
85
|
+
*
|
|
86
|
+
* @type {new () => FormData}
|
|
87
|
+
*/
|
|
88
|
+
formDataCtor?: new () => any;
|
|
89
|
+
constructor(param?: ConfigurationParameters);
|
|
90
|
+
/**
|
|
91
|
+
* Check if the given MIME is a JSON MIME.
|
|
92
|
+
* JSON MIME examples:
|
|
93
|
+
* application/json
|
|
94
|
+
* application/json; charset=UTF8
|
|
95
|
+
* APPLICATION/JSON
|
|
96
|
+
* application/vnd.company+json
|
|
97
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
98
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
99
|
+
*/
|
|
100
|
+
isJsonMime(mime: string): boolean;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
105
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
106
|
+
*
|
|
107
|
+
* The version of the OpenAPI document: v1
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
+
* https://openapi-generator.tech
|
|
112
|
+
* Do not edit the class manually.
|
|
113
|
+
*/
|
|
114
|
+
|
|
115
|
+
interface RequestArgs {
|
|
116
|
+
url: string;
|
|
117
|
+
options: RawAxiosRequestConfig;
|
|
118
|
+
}
|
|
119
|
+
declare class BaseAPI {
|
|
120
|
+
protected basePath: string;
|
|
121
|
+
protected axios: AxiosInstance;
|
|
122
|
+
protected configuration: Configuration | undefined;
|
|
123
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
128
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
129
|
+
*
|
|
130
|
+
* The version of the OpenAPI document: v1
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
134
|
+
* https://openapi-generator.tech
|
|
135
|
+
* Do not edit the class manually.
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* The transaction status.
|
|
139
|
+
*/
|
|
140
|
+
interface Transaction {
|
|
141
|
+
/**
|
|
142
|
+
* The unique identifier returned in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
143
|
+
*/
|
|
144
|
+
'transactionId': string;
|
|
145
|
+
/**
|
|
146
|
+
* Current processing status of the transaction.
|
|
147
|
+
*/
|
|
148
|
+
'status': TransactionStatusEnum;
|
|
149
|
+
/**
|
|
150
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
151
|
+
*/
|
|
152
|
+
'errors'?: Array<Error>;
|
|
153
|
+
}
|
|
154
|
+
declare const TransactionStatusEnum: {
|
|
155
|
+
readonly Failure: "Failure";
|
|
156
|
+
readonly Processing: "Processing";
|
|
157
|
+
readonly Success: "Success";
|
|
158
|
+
};
|
|
159
|
+
type TransactionStatusEnum = typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum];
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
163
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
164
|
+
*
|
|
165
|
+
* The version of the OpenAPI document: v1
|
|
166
|
+
*
|
|
167
|
+
*
|
|
168
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
169
|
+
* https://openapi-generator.tech
|
|
170
|
+
* Do not edit the class manually.
|
|
171
|
+
*/
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Represents the status of a transaction.
|
|
175
|
+
*/
|
|
176
|
+
interface TransactionStatus {
|
|
177
|
+
'transactionStatus'?: Transaction;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
182
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
183
|
+
*
|
|
184
|
+
* The version of the OpenAPI document: v1
|
|
185
|
+
*
|
|
186
|
+
*
|
|
187
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
188
|
+
* https://openapi-generator.tech
|
|
189
|
+
* Do not edit the class manually.
|
|
190
|
+
*/
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* The response schema for the getTransaction operation.
|
|
194
|
+
*/
|
|
195
|
+
interface GetTransactionResponse {
|
|
196
|
+
'payload'?: TransactionStatus;
|
|
197
|
+
/**
|
|
198
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
199
|
+
*/
|
|
200
|
+
'errors'?: Array<Error>;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Selling Partner API for Retail Procurement Transaction Status
|
|
205
|
+
* The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.
|
|
206
|
+
*
|
|
207
|
+
* The version of the OpenAPI document: v1
|
|
208
|
+
*
|
|
209
|
+
*
|
|
210
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
211
|
+
* https://openapi-generator.tech
|
|
212
|
+
* Do not edit the class manually.
|
|
213
|
+
*/
|
|
214
|
+
/**
|
|
215
|
+
* Error response returned when the request is unsuccessful.
|
|
216
|
+
*/
|
|
217
|
+
interface ModelError {
|
|
218
|
+
/**
|
|
219
|
+
* An error code that identifies the type of error that occurred.
|
|
220
|
+
*/
|
|
221
|
+
'code': string;
|
|
222
|
+
/**
|
|
223
|
+
* A message that describes the error condition.
|
|
224
|
+
*/
|
|
225
|
+
'message': string;
|
|
226
|
+
/**
|
|
227
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
228
|
+
*/
|
|
229
|
+
'details'?: string;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* VendorTransactionStatusApi - axios parameter creator
|
|
234
|
+
*/
|
|
235
|
+
declare const VendorTransactionStatusApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
236
|
+
/**
|
|
237
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
238
|
+
* @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
getTransaction: (transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
243
|
+
};
|
|
244
|
+
/**
|
|
245
|
+
* VendorTransactionStatusApi - functional programming interface
|
|
246
|
+
*/
|
|
247
|
+
declare const VendorTransactionStatusApiFp: (configuration?: Configuration) => {
|
|
248
|
+
/**
|
|
249
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
250
|
+
* @param {string} transactionId The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
251
|
+
* @param {*} [options] Override http request option.
|
|
252
|
+
* @throws {RequiredError}
|
|
253
|
+
*/
|
|
254
|
+
getTransaction(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTransactionResponse>>;
|
|
255
|
+
};
|
|
256
|
+
/**
|
|
257
|
+
* VendorTransactionStatusApi - factory interface
|
|
258
|
+
*/
|
|
259
|
+
declare const VendorTransactionStatusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
260
|
+
/**
|
|
261
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
262
|
+
* @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
getTransaction(requestParameters: VendorTransactionStatusApiGetTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetTransactionResponse>;
|
|
267
|
+
};
|
|
268
|
+
/**
|
|
269
|
+
* Request parameters for getTransaction operation in VendorTransactionStatusApi.
|
|
270
|
+
*/
|
|
271
|
+
interface VendorTransactionStatusApiGetTransactionRequest {
|
|
272
|
+
/**
|
|
273
|
+
* The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
|
|
274
|
+
*/
|
|
275
|
+
readonly transactionId: string;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* VendorTransactionStatusApi - object-oriented interface
|
|
279
|
+
*/
|
|
280
|
+
declare class VendorTransactionStatusApi extends BaseAPI {
|
|
281
|
+
/**
|
|
282
|
+
* Returns the status of the transaction that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 20 | 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).
|
|
283
|
+
* @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
getTransaction(requestParameters: VendorTransactionStatusApiGetTransactionRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetTransactionResponse, any, {}>>;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
declare const clientRateLimits: RateLimit[];
|
|
291
|
+
declare class VendorTransactionStatusApiClient extends VendorTransactionStatusApi {
|
|
292
|
+
constructor(configuration: ClientConfiguration);
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
export { type GetTransactionResponse, type ModelError, type Transaction, type TransactionStatus, TransactionStatusEnum, VendorTransactionStatusApi, VendorTransactionStatusApiAxiosParamCreator, VendorTransactionStatusApiClient, VendorTransactionStatusApiFactory, VendorTransactionStatusApiFp, type VendorTransactionStatusApiGetTransactionRequest, clientRateLimits };
|