@sp-api-sdk/application-integrations-api-2024-04-01 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/app-integrations-api.js +248 -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/create-notification-request.js +15 -0
- package/dist/cjs/src/api-model/models/create-notification-response.js +15 -0
- package/dist/cjs/src/api-model/models/delete-notifications-request.js +20 -0
- package/dist/cjs/src/api-model/models/error-list.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +22 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/record-action-feedback-request.js +19 -0
- package/dist/cjs/src/client.js +35 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/app-integrations-api.js +238 -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/create-notification-request.js +14 -0
- package/dist/es/src/api-model/models/create-notification-response.js +14 -0
- package/dist/es/src/api-model/models/delete-notifications-request.js +17 -0
- package/dist/es/src/api-model/models/error-list.js +14 -0
- package/dist/es/src/api-model/models/index.js +6 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/record-action-feedback-request.js +16 -0
- package/dist/es/src/client.js +31 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/app-integrations-api.d.ts +179 -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/create-notification-request.d.ts +38 -0
- package/dist/types/src/api-model/models/create-notification-response.d.ts +24 -0
- package/dist/types/src/api-model/models/delete-notifications-request.d.ts +35 -0
- package/dist/types/src/api-model/models/error-list.d.ts +24 -0
- package/dist/types/src/api-model/models/index.d.ts +6 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/record-action-feedback-request.d.ts +28 -0
- package/dist/types/src/client.d.ts +6 -0
- package/package.json +44 -0
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { RequiredError } from "./base";
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const DUMMY_BASE_URL = 'https://example.com';
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export const assertParamExists = function (functionName, paramName, paramValue) {
|
|
26
|
+
if (paramValue === null || paramValue === undefined) {
|
|
27
|
+
throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @export
|
|
33
|
+
*/
|
|
34
|
+
export const setApiKeyToObject = async function (object, keyParamName, configuration) {
|
|
35
|
+
if (configuration && configuration.apiKey) {
|
|
36
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
37
|
+
? await configuration.apiKey(keyParamName)
|
|
38
|
+
: await configuration.apiKey;
|
|
39
|
+
object[keyParamName] = localVarApiKeyValue;
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export const setBasicAuthToObject = function (object, configuration) {
|
|
47
|
+
if (configuration && (configuration.username || configuration.password)) {
|
|
48
|
+
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
49
|
+
}
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export const setBearerAuthToObject = async function (object, configuration) {
|
|
56
|
+
if (configuration && configuration.accessToken) {
|
|
57
|
+
const accessToken = typeof configuration.accessToken === 'function'
|
|
58
|
+
? await configuration.accessToken()
|
|
59
|
+
: await configuration.accessToken;
|
|
60
|
+
object["Authorization"] = "Bearer " + accessToken;
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @export
|
|
66
|
+
*/
|
|
67
|
+
export const setOAuthToObject = async function (object, name, scopes, configuration) {
|
|
68
|
+
if (configuration && configuration.accessToken) {
|
|
69
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
70
|
+
? await configuration.accessToken(name, scopes)
|
|
71
|
+
: await configuration.accessToken;
|
|
72
|
+
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
76
|
+
if (parameter == null)
|
|
77
|
+
return;
|
|
78
|
+
if (typeof parameter === "object") {
|
|
79
|
+
if (Array.isArray(parameter)) {
|
|
80
|
+
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
81
|
+
}
|
|
82
|
+
else {
|
|
83
|
+
Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
else {
|
|
87
|
+
if (urlSearchParams.has(key)) {
|
|
88
|
+
urlSearchParams.append(key, parameter);
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
urlSearchParams.set(key, parameter);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @export
|
|
98
|
+
*/
|
|
99
|
+
export const setSearchParams = function (url, ...objects) {
|
|
100
|
+
const searchParams = new URLSearchParams(url.search);
|
|
101
|
+
setFlattenedQueryParams(searchParams, objects);
|
|
102
|
+
url.search = searchParams.toString();
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @export
|
|
107
|
+
*/
|
|
108
|
+
export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
109
|
+
const nonString = typeof value !== 'string';
|
|
110
|
+
const needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
111
|
+
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
112
|
+
: nonString;
|
|
113
|
+
return needsSerialization
|
|
114
|
+
? JSON.stringify(value !== undefined ? value : {})
|
|
115
|
+
: (value || "");
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @export
|
|
120
|
+
*/
|
|
121
|
+
export const toPathString = function (url) {
|
|
122
|
+
return url.pathname + url.search + url.hash;
|
|
123
|
+
};
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @export
|
|
127
|
+
*/
|
|
128
|
+
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
129
|
+
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
130
|
+
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
131
|
+
return axios.request(axiosRequestArgs);
|
|
132
|
+
};
|
|
133
|
+
};
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export class Configuration {
|
|
15
|
+
/**
|
|
16
|
+
* parameter for apiKey security
|
|
17
|
+
* @param name security name
|
|
18
|
+
* @memberof Configuration
|
|
19
|
+
*/
|
|
20
|
+
apiKey;
|
|
21
|
+
/**
|
|
22
|
+
* parameter for basic security
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof Configuration
|
|
26
|
+
*/
|
|
27
|
+
username;
|
|
28
|
+
/**
|
|
29
|
+
* parameter for basic security
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof Configuration
|
|
33
|
+
*/
|
|
34
|
+
password;
|
|
35
|
+
/**
|
|
36
|
+
* parameter for oauth2 security
|
|
37
|
+
* @param name security name
|
|
38
|
+
* @param scopes oauth2 scope
|
|
39
|
+
* @memberof Configuration
|
|
40
|
+
*/
|
|
41
|
+
accessToken;
|
|
42
|
+
/**
|
|
43
|
+
* override base path
|
|
44
|
+
*
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof Configuration
|
|
47
|
+
*/
|
|
48
|
+
basePath;
|
|
49
|
+
/**
|
|
50
|
+
* override server index
|
|
51
|
+
*
|
|
52
|
+
* @type {number}
|
|
53
|
+
* @memberof Configuration
|
|
54
|
+
*/
|
|
55
|
+
serverIndex;
|
|
56
|
+
/**
|
|
57
|
+
* base options for axios calls
|
|
58
|
+
*
|
|
59
|
+
* @type {any}
|
|
60
|
+
* @memberof Configuration
|
|
61
|
+
*/
|
|
62
|
+
baseOptions;
|
|
63
|
+
/**
|
|
64
|
+
* The FormData constructor that will be used to create multipart form data
|
|
65
|
+
* requests. You can inject this here so that execution environments that
|
|
66
|
+
* do not support the FormData class can still run the generated client.
|
|
67
|
+
*
|
|
68
|
+
* @type {new () => FormData}
|
|
69
|
+
*/
|
|
70
|
+
formDataCtor;
|
|
71
|
+
constructor(param = {}) {
|
|
72
|
+
this.apiKey = param.apiKey;
|
|
73
|
+
this.username = param.username;
|
|
74
|
+
this.password = param.password;
|
|
75
|
+
this.accessToken = param.accessToken;
|
|
76
|
+
this.basePath = param.basePath;
|
|
77
|
+
this.serverIndex = param.serverIndex;
|
|
78
|
+
this.baseOptions = param.baseOptions;
|
|
79
|
+
this.formDataCtor = param.formDataCtor;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Check if the given MIME is a JSON MIME.
|
|
83
|
+
* JSON MIME examples:
|
|
84
|
+
* application/json
|
|
85
|
+
* application/json; charset=UTF8
|
|
86
|
+
* APPLICATION/JSON
|
|
87
|
+
* application/vnd.company+json
|
|
88
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
89
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
90
|
+
*/
|
|
91
|
+
isJsonMime(mime) {
|
|
92
|
+
const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
93
|
+
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
94
|
+
}
|
|
95
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export * from "./api";
|
|
15
|
+
export * from "./configuration";
|
|
16
|
+
export * from "./models";
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export const DeleteNotificationsRequestDeletionReasonEnum = {
|
|
15
|
+
Content: 'INCORRECT_CONTENT',
|
|
16
|
+
Recipient: 'INCORRECT_RECIPIENT'
|
|
17
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for third party application integrations.
|
|
5
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export const RecordActionFeedbackRequestFeedbackActionCodeEnum = {
|
|
15
|
+
SellerActionCompleted: 'SELLER_ACTION_COMPLETED'
|
|
16
|
+
};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
+
import { AppIntegrationsApi, Configuration } from './api-model';
|
|
3
|
+
export const clientRateLimits = [
|
|
4
|
+
{
|
|
5
|
+
method: 'post',
|
|
6
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
7
|
+
urlRegex: new RegExp('^/appIntegrations/2024-04-01/notifications$'),
|
|
8
|
+
rate: 1,
|
|
9
|
+
burst: 5,
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
method: 'post',
|
|
13
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
14
|
+
urlRegex: new RegExp('^/appIntegrations/2024-04-01/notifications/deletion$'),
|
|
15
|
+
rate: 1,
|
|
16
|
+
burst: 5,
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
method: 'post',
|
|
20
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
21
|
+
urlRegex: new RegExp('^/appIntegrations/2024-04-01/notifications/[^/]*/feedback$'),
|
|
22
|
+
rate: 1,
|
|
23
|
+
burst: 5,
|
|
24
|
+
},
|
|
25
|
+
];
|
|
26
|
+
export class ApplicationIntegrationsApiClient extends AppIntegrationsApi {
|
|
27
|
+
constructor(configuration) {
|
|
28
|
+
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
29
|
+
super(new Configuration(), endpoint, axios);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for third party application integrations.
|
|
3
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { CreateNotificationRequest } from '../models';
|
|
17
|
+
import type { CreateNotificationResponse } from '../models';
|
|
18
|
+
import type { DeleteNotificationsRequest } from '../models';
|
|
19
|
+
import type { RecordActionFeedbackRequest } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* AppIntegrationsApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const AppIntegrationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* Create a notification for sellers in Seller Central. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
27
|
+
* @param {CreateNotificationRequest} body The request body for the `createNotification` operation.
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
createNotification: (body: CreateNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
|
+
* @param {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation.
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
deleteNotifications: (body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
|
+
/**
|
|
40
|
+
* Records the seller\'s response to a notification. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
41
|
+
* @param {string} notificationId A `notificationId` uniquely identifies a notification.
|
|
42
|
+
* @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation.
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
recordActionFeedback: (notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* AppIntegrationsApi - functional programming interface
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export declare const AppIntegrationsApiFp: (configuration?: Configuration) => {
|
|
53
|
+
/**
|
|
54
|
+
* Create a notification for sellers in Seller Central. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
55
|
+
* @param {CreateNotificationRequest} body The request body for the `createNotification` operation.
|
|
56
|
+
* @param {*} [options] Override http request option.
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
createNotification(body: CreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationResponse>>;
|
|
60
|
+
/**
|
|
61
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
|
+
* @param {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
deleteNotifications(body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
67
|
+
/**
|
|
68
|
+
* Records the seller\'s response to a notification. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
69
|
+
* @param {string} notificationId A `notificationId` uniquely identifies a notification.
|
|
70
|
+
* @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation.
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
recordActionFeedback(notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* AppIntegrationsApi - factory interface
|
|
78
|
+
* @export
|
|
79
|
+
*/
|
|
80
|
+
export declare const AppIntegrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
81
|
+
/**
|
|
82
|
+
* Create a notification for sellers in Seller Central. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
83
|
+
* @param {AppIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
createNotification(requestParameters: AppIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateNotificationResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
90
|
+
* @param {AppIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
deleteNotifications(requestParameters: AppIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
95
|
+
/**
|
|
96
|
+
* Records the seller\'s response to a notification. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
97
|
+
* @param {AppIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
recordActionFeedback(requestParameters: AppIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* Request parameters for createNotification operation in AppIntegrationsApi.
|
|
105
|
+
* @export
|
|
106
|
+
* @interface AppIntegrationsApiCreateNotificationRequest
|
|
107
|
+
*/
|
|
108
|
+
export interface AppIntegrationsApiCreateNotificationRequest {
|
|
109
|
+
/**
|
|
110
|
+
* The request body for the `createNotification` operation.
|
|
111
|
+
* @type {CreateNotificationRequest}
|
|
112
|
+
* @memberof AppIntegrationsApiCreateNotification
|
|
113
|
+
*/
|
|
114
|
+
readonly body: CreateNotificationRequest;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Request parameters for deleteNotifications operation in AppIntegrationsApi.
|
|
118
|
+
* @export
|
|
119
|
+
* @interface AppIntegrationsApiDeleteNotificationsRequest
|
|
120
|
+
*/
|
|
121
|
+
export interface AppIntegrationsApiDeleteNotificationsRequest {
|
|
122
|
+
/**
|
|
123
|
+
* The request body for the `deleteNotifications` operation.
|
|
124
|
+
* @type {DeleteNotificationsRequest}
|
|
125
|
+
* @memberof AppIntegrationsApiDeleteNotifications
|
|
126
|
+
*/
|
|
127
|
+
readonly body: DeleteNotificationsRequest;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Request parameters for recordActionFeedback operation in AppIntegrationsApi.
|
|
131
|
+
* @export
|
|
132
|
+
* @interface AppIntegrationsApiRecordActionFeedbackRequest
|
|
133
|
+
*/
|
|
134
|
+
export interface AppIntegrationsApiRecordActionFeedbackRequest {
|
|
135
|
+
/**
|
|
136
|
+
* A `notificationId` uniquely identifies a notification.
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof AppIntegrationsApiRecordActionFeedback
|
|
139
|
+
*/
|
|
140
|
+
readonly notificationId: string;
|
|
141
|
+
/**
|
|
142
|
+
* The request body for the `recordActionFeedback` operation.
|
|
143
|
+
* @type {RecordActionFeedbackRequest}
|
|
144
|
+
* @memberof AppIntegrationsApiRecordActionFeedback
|
|
145
|
+
*/
|
|
146
|
+
readonly body: RecordActionFeedbackRequest;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* AppIntegrationsApi - object-oriented interface
|
|
150
|
+
* @export
|
|
151
|
+
* @class AppIntegrationsApi
|
|
152
|
+
* @extends {BaseAPI}
|
|
153
|
+
*/
|
|
154
|
+
export declare class AppIntegrationsApi extends BaseAPI {
|
|
155
|
+
/**
|
|
156
|
+
* Create a notification for sellers in Seller Central. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
157
|
+
* @param {AppIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
* @memberof AppIntegrationsApi
|
|
161
|
+
*/
|
|
162
|
+
createNotification(requestParameters: AppIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateNotificationResponse, any>>;
|
|
163
|
+
/**
|
|
164
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
165
|
+
* @param {AppIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
* @memberof AppIntegrationsApi
|
|
169
|
+
*/
|
|
170
|
+
deleteNotifications(requestParameters: AppIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
171
|
+
/**
|
|
172
|
+
* Records the seller\'s response to a notification. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 indicates the default rate and burst values for this operation. Sellers 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 in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
173
|
+
* @param {AppIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
* @memberof AppIntegrationsApi
|
|
177
|
+
*/
|
|
178
|
+
recordActionFeedback(requestParameters: AppIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
179
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for third party application integrations.
|
|
3
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from './api/app-integrations-api';
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for third party application integrations.
|
|
3
|
+
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-04-01
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { 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 {};
|