@sp-api-sdk/solicitations-api-v1 3.1.4 → 3.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist/cjs/api-model/api/solicitations-api.js +0 -8
  2. package/dist/cjs/api-model/base.js +0 -19
  3. package/dist/cjs/api-model/common.js +0 -37
  4. package/dist/cjs/api-model/configuration.js +0 -17
  5. package/dist/es/api-model/api/solicitations-api.js +0 -8
  6. package/dist/es/api-model/base.js +0 -19
  7. package/dist/es/api-model/common.js +0 -37
  8. package/dist/es/api-model/configuration.js +0 -17
  9. package/dist/types/api-model/api/solicitations-api.d.ts +0 -20
  10. package/dist/types/api-model/base.d.ts +0 -24
  11. package/dist/types/api-model/common.d.ts +0 -37
  12. package/dist/types/api-model/configuration.d.ts +0 -17
  13. package/dist/types/api-model/models/create-product-review-and-seller-feedback-solicitation-response.d.ts +0 -4
  14. package/dist/types/api-model/models/get-schema-response-links.d.ts +0 -10
  15. package/dist/types/api-model/models/get-schema-response.d.ts +0 -14
  16. package/dist/types/api-model/models/get-solicitation-action-response-embedded.d.ts +0 -10
  17. package/dist/types/api-model/models/get-solicitation-action-response-links.d.ts +0 -15
  18. package/dist/types/api-model/models/get-solicitation-action-response.d.ts +0 -19
  19. package/dist/types/api-model/models/get-solicitation-actions-for-order-response-embedded.d.ts +0 -10
  20. package/dist/types/api-model/models/get-solicitation-actions-for-order-response-links.d.ts +0 -12
  21. package/dist/types/api-model/models/get-solicitation-actions-for-order-response.d.ts +0 -14
  22. package/dist/types/api-model/models/link-object.d.ts +0 -6
  23. package/dist/types/api-model/models/model-error.d.ts +0 -8
  24. package/dist/types/api-model/models/solicitations-action.d.ts +0 -7
  25. package/package.json +25 -4
@@ -25,7 +25,6 @@ const common_1 = require("../common");
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * SolicitationsApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const SolicitationsApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -102,7 +101,6 @@ const SolicitationsApiAxiosParamCreator = function (configuration) {
102
101
  exports.SolicitationsApiAxiosParamCreator = SolicitationsApiAxiosParamCreator;
103
102
  /**
104
103
  * SolicitationsApi - functional programming interface
105
- * @export
106
104
  */
107
105
  const SolicitationsApiFp = function (configuration) {
108
106
  const localVarAxiosParamCreator = (0, exports.SolicitationsApiAxiosParamCreator)(configuration);
@@ -138,7 +136,6 @@ const SolicitationsApiFp = function (configuration) {
138
136
  exports.SolicitationsApiFp = SolicitationsApiFp;
139
137
  /**
140
138
  * SolicitationsApi - factory interface
141
- * @export
142
139
  */
143
140
  const SolicitationsApiFactory = function (configuration, basePath, axios) {
144
141
  const localVarFp = (0, exports.SolicitationsApiFp)(configuration);
@@ -166,9 +163,6 @@ const SolicitationsApiFactory = function (configuration, basePath, axios) {
166
163
  exports.SolicitationsApiFactory = SolicitationsApiFactory;
167
164
  /**
168
165
  * SolicitationsApi - object-oriented interface
169
- * @export
170
- * @class SolicitationsApi
171
- * @extends {BaseAPI}
172
166
  */
173
167
  class SolicitationsApi extends base_1.BaseAPI {
174
168
  /**
@@ -176,7 +170,6 @@ class SolicitationsApi extends base_1.BaseAPI {
176
170
  * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
177
171
  * @param {*} [options] Override http request option.
178
172
  * @throws {RequiredError}
179
- * @memberof SolicitationsApi
180
173
  */
181
174
  createProductReviewAndSellerFeedbackSolicitation(requestParameters, options) {
182
175
  return (0, exports.SolicitationsApiFp)(this.configuration).createProductReviewAndSellerFeedbackSolicitation(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
@@ -186,7 +179,6 @@ class SolicitationsApi extends base_1.BaseAPI {
186
179
  * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
187
180
  * @param {*} [options] Override http request option.
188
181
  * @throws {RequiredError}
189
- * @memberof SolicitationsApi
190
182
  */
191
183
  getSolicitationActionsForOrder(requestParameters, options) {
192
184
  return (0, exports.SolicitationsApiFp)(this.configuration).getSolicitationActionsForOrder(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
22
- /**
23
- *
24
- * @export
25
- */
26
22
  exports.COLLECTION_FORMATS = {
27
23
  csv: ",",
28
24
  ssv: " ",
29
25
  tsv: "\t",
30
26
  pipes: "|",
31
27
  };
32
- /**
33
- *
34
- * @export
35
- * @class BaseAPI
36
- */
37
28
  class BaseAPI {
38
29
  basePath;
39
30
  axios;
@@ -49,12 +40,6 @@ class BaseAPI {
49
40
  }
50
41
  exports.BaseAPI = BaseAPI;
51
42
  ;
52
- /**
53
- *
54
- * @export
55
- * @class RequiredError
56
- * @extends {Error}
57
- */
58
43
  class RequiredError extends Error {
59
44
  field;
60
45
  constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
64
49
  }
65
50
  }
66
51
  exports.RequiredError = RequiredError;
67
- /**
68
- *
69
- * @export
70
- */
71
52
  exports.operationServerMap = {};
@@ -15,15 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
17
17
  const base_1 = require("./base");
18
- /**
19
- *
20
- * @export
21
- */
22
18
  exports.DUMMY_BASE_URL = 'https://example.com';
23
19
  /**
24
20
  *
25
21
  * @throws {RequiredError}
26
- * @export
27
22
  */
28
23
  const assertParamExists = function (functionName, paramName, paramValue) {
29
24
  if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
31
26
  }
32
27
  };
33
28
  exports.assertParamExists = assertParamExists;
34
- /**
35
- *
36
- * @export
37
- */
38
29
  const setApiKeyToObject = async function (object, keyParamName, configuration) {
39
30
  if (configuration && configuration.apiKey) {
40
31
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
44
35
  }
45
36
  };
46
37
  exports.setApiKeyToObject = setApiKeyToObject;
47
- /**
48
- *
49
- * @export
50
- */
51
38
  const setBasicAuthToObject = function (object, configuration) {
52
39
  if (configuration && (configuration.username || configuration.password)) {
53
40
  object["auth"] = { username: configuration.username, password: configuration.password };
54
41
  }
55
42
  };
56
43
  exports.setBasicAuthToObject = setBasicAuthToObject;
57
- /**
58
- *
59
- * @export
60
- */
61
44
  const setBearerAuthToObject = async function (object, configuration) {
62
45
  if (configuration && configuration.accessToken) {
63
46
  const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
67
50
  }
68
51
  };
69
52
  exports.setBearerAuthToObject = setBearerAuthToObject;
70
- /**
71
- *
72
- * @export
73
- */
74
53
  const setOAuthToObject = async function (object, name, scopes, configuration) {
75
54
  if (configuration && configuration.accessToken) {
76
55
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
100
79
  }
101
80
  }
102
81
  }
103
- /**
104
- *
105
- * @export
106
- */
107
82
  const setSearchParams = function (url, ...objects) {
108
83
  const searchParams = new URLSearchParams(url.search);
109
84
  setFlattenedQueryParams(searchParams, objects);
110
85
  url.search = searchParams.toString();
111
86
  };
112
87
  exports.setSearchParams = setSearchParams;
113
- /**
114
- *
115
- * @export
116
- */
117
88
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
118
89
  const nonString = typeof value !== 'string';
119
90
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
124
95
  : (value || "");
125
96
  };
126
97
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
127
- /**
128
- *
129
- * @export
130
- */
131
98
  const toPathString = function (url) {
132
99
  return url.pathname + url.search + url.hash;
133
100
  };
134
101
  exports.toPathString = toPathString;
135
- /**
136
- *
137
- * @export
138
- */
139
102
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
140
103
  return (axios = globalAxios, basePath = BASE_PATH) => {
141
104
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -18,49 +18,32 @@ class Configuration {
18
18
  /**
19
19
  * parameter for apiKey security
20
20
  * @param name security name
21
- * @memberof Configuration
22
21
  */
23
22
  apiKey;
24
23
  /**
25
24
  * parameter for basic security
26
- *
27
- * @type {string}
28
- * @memberof Configuration
29
25
  */
30
26
  username;
31
27
  /**
32
28
  * parameter for basic security
33
- *
34
- * @type {string}
35
- * @memberof Configuration
36
29
  */
37
30
  password;
38
31
  /**
39
32
  * parameter for oauth2 security
40
33
  * @param name security name
41
34
  * @param scopes oauth2 scope
42
- * @memberof Configuration
43
35
  */
44
36
  accessToken;
45
37
  /**
46
38
  * override base path
47
- *
48
- * @type {string}
49
- * @memberof Configuration
50
39
  */
51
40
  basePath;
52
41
  /**
53
42
  * override server index
54
- *
55
- * @type {number}
56
- * @memberof Configuration
57
43
  */
58
44
  serverIndex;
59
45
  /**
60
46
  * base options for axios calls
61
- *
62
- * @type {any}
63
- * @memberof Configuration
64
47
  */
65
48
  baseOptions;
66
49
  /**
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
19
19
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * SolicitationsApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const SolicitationsApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -95,7 +94,6 @@ export const SolicitationsApiAxiosParamCreator = function (configuration) {
95
94
  };
96
95
  /**
97
96
  * SolicitationsApi - functional programming interface
98
- * @export
99
97
  */
100
98
  export const SolicitationsApiFp = function (configuration) {
101
99
  const localVarAxiosParamCreator = SolicitationsApiAxiosParamCreator(configuration);
@@ -130,7 +128,6 @@ export const SolicitationsApiFp = function (configuration) {
130
128
  };
131
129
  /**
132
130
  * SolicitationsApi - factory interface
133
- * @export
134
131
  */
135
132
  export const SolicitationsApiFactory = function (configuration, basePath, axios) {
136
133
  const localVarFp = SolicitationsApiFp(configuration);
@@ -157,9 +154,6 @@ export const SolicitationsApiFactory = function (configuration, basePath, axios)
157
154
  };
158
155
  /**
159
156
  * SolicitationsApi - object-oriented interface
160
- * @export
161
- * @class SolicitationsApi
162
- * @extends {BaseAPI}
163
157
  */
164
158
  export class SolicitationsApi extends BaseAPI {
165
159
  /**
@@ -167,7 +161,6 @@ export class SolicitationsApi extends BaseAPI {
167
161
  * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
168
162
  * @param {*} [options] Override http request option.
169
163
  * @throws {RequiredError}
170
- * @memberof SolicitationsApi
171
164
  */
172
165
  createProductReviewAndSellerFeedbackSolicitation(requestParameters, options) {
173
166
  return SolicitationsApiFp(this.configuration).createProductReviewAndSellerFeedbackSolicitation(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
@@ -177,7 +170,6 @@ export class SolicitationsApi extends BaseAPI {
177
170
  * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
178
171
  * @param {*} [options] Override http request option.
179
172
  * @throws {RequiredError}
180
- * @memberof SolicitationsApi
181
173
  */
182
174
  getSolicitationActionsForOrder(requestParameters, options) {
183
175
  return SolicitationsApiFp(this.configuration).getSolicitationActionsForOrder(requestParameters.amazonOrderId, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  basePath;
33
24
  axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
42
33
  }
43
34
  }
44
35
  ;
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
36
  export class RequiredError extends Error {
52
37
  field;
53
38
  constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
56
41
  this.name = "RequiredError";
57
42
  }
58
43
  }
59
- /**
60
- *
61
- * @export
62
- */
63
44
  export const operationServerMap = {};
@@ -12,25 +12,16 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { RequiredError } from "./base";
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export const DUMMY_BASE_URL = 'https://example.com';
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export const assertParamExists = function (functionName, paramName, paramValue) {
26
21
  if (paramValue === null || paramValue === undefined) {
27
22
  throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
28
23
  }
29
24
  };
30
- /**
31
- *
32
- * @export
33
- */
34
25
  export const setApiKeyToObject = async function (object, keyParamName, configuration) {
35
26
  if (configuration && configuration.apiKey) {
36
27
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
39
30
  object[keyParamName] = localVarApiKeyValue;
40
31
  }
41
32
  };
42
- /**
43
- *
44
- * @export
45
- */
46
33
  export const setBasicAuthToObject = function (object, configuration) {
47
34
  if (configuration && (configuration.username || configuration.password)) {
48
35
  object["auth"] = { username: configuration.username, password: configuration.password };
49
36
  }
50
37
  };
51
- /**
52
- *
53
- * @export
54
- */
55
38
  export const setBearerAuthToObject = async function (object, configuration) {
56
39
  if (configuration && configuration.accessToken) {
57
40
  const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
60
43
  object["Authorization"] = "Bearer " + accessToken;
61
44
  }
62
45
  };
63
- /**
64
- *
65
- * @export
66
- */
67
46
  export const setOAuthToObject = async function (object, name, scopes, configuration) {
68
47
  if (configuration && configuration.accessToken) {
69
48
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
92
71
  }
93
72
  }
94
73
  }
95
- /**
96
- *
97
- * @export
98
- */
99
74
  export const setSearchParams = function (url, ...objects) {
100
75
  const searchParams = new URLSearchParams(url.search);
101
76
  setFlattenedQueryParams(searchParams, objects);
102
77
  url.search = searchParams.toString();
103
78
  };
104
- /**
105
- *
106
- * @export
107
- */
108
79
  export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
109
80
  const nonString = typeof value !== 'string';
110
81
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
114
85
  ? JSON.stringify(value !== undefined ? value : {})
115
86
  : (value || "");
116
87
  };
117
- /**
118
- *
119
- * @export
120
- */
121
88
  export const toPathString = function (url) {
122
89
  return url.pathname + url.search + url.hash;
123
90
  };
124
- /**
125
- *
126
- * @export
127
- */
128
91
  export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
129
92
  return (axios = globalAxios, basePath = BASE_PATH) => {
130
93
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -15,49 +15,32 @@ export class Configuration {
15
15
  /**
16
16
  * parameter for apiKey security
17
17
  * @param name security name
18
- * @memberof Configuration
19
18
  */
20
19
  apiKey;
21
20
  /**
22
21
  * parameter for basic security
23
- *
24
- * @type {string}
25
- * @memberof Configuration
26
22
  */
27
23
  username;
28
24
  /**
29
25
  * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
26
  */
34
27
  password;
35
28
  /**
36
29
  * parameter for oauth2 security
37
30
  * @param name security name
38
31
  * @param scopes oauth2 scope
39
- * @memberof Configuration
40
32
  */
41
33
  accessToken;
42
34
  /**
43
35
  * override base path
44
- *
45
- * @type {string}
46
- * @memberof Configuration
47
36
  */
48
37
  basePath;
49
38
  /**
50
39
  * override server index
51
- *
52
- * @type {number}
53
- * @memberof Configuration
54
40
  */
55
41
  serverIndex;
56
42
  /**
57
43
  * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
44
  */
62
45
  baseOptions;
63
46
  /**
@@ -17,7 +17,6 @@ import type { CreateProductReviewAndSellerFeedbackSolicitationResponse } from '.
17
17
  import type { GetSolicitationActionsForOrderResponse } from '../models';
18
18
  /**
19
19
  * SolicitationsApi - axios parameter creator
20
- * @export
21
20
  */
22
21
  export declare const SolicitationsApiAxiosParamCreator: (configuration?: Configuration) => {
23
22
  /**
@@ -39,7 +38,6 @@ export declare const SolicitationsApiAxiosParamCreator: (configuration?: Configu
39
38
  };
40
39
  /**
41
40
  * SolicitationsApi - functional programming interface
42
- * @export
43
41
  */
44
42
  export declare const SolicitationsApiFp: (configuration?: Configuration) => {
45
43
  /**
@@ -61,7 +59,6 @@ export declare const SolicitationsApiFp: (configuration?: Configuration) => {
61
59
  };
62
60
  /**
63
61
  * SolicitationsApi - factory interface
64
- * @export
65
62
  */
66
63
  export declare const SolicitationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
67
64
  /**
@@ -81,47 +78,32 @@ export declare const SolicitationsApiFactory: (configuration?: Configuration, ba
81
78
  };
82
79
  /**
83
80
  * Request parameters for createProductReviewAndSellerFeedbackSolicitation operation in SolicitationsApi.
84
- * @export
85
- * @interface SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest
86
81
  */
87
82
  export interface SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest {
88
83
  /**
89
84
  * An Amazon order identifier. This specifies the order for which a solicitation is sent.
90
- * @type {string}
91
- * @memberof SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitation
92
85
  */
93
86
  readonly amazonOrderId: string;
94
87
  /**
95
88
  * A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
96
- * @type {Array<string>}
97
- * @memberof SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitation
98
89
  */
99
90
  readonly marketplaceIds: Array<string>;
100
91
  }
101
92
  /**
102
93
  * Request parameters for getSolicitationActionsForOrder operation in SolicitationsApi.
103
- * @export
104
- * @interface SolicitationsApiGetSolicitationActionsForOrderRequest
105
94
  */
106
95
  export interface SolicitationsApiGetSolicitationActionsForOrderRequest {
107
96
  /**
108
97
  * An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
109
- * @type {string}
110
- * @memberof SolicitationsApiGetSolicitationActionsForOrder
111
98
  */
112
99
  readonly amazonOrderId: string;
113
100
  /**
114
101
  * A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
115
- * @type {Array<string>}
116
- * @memberof SolicitationsApiGetSolicitationActionsForOrder
117
102
  */
118
103
  readonly marketplaceIds: Array<string>;
119
104
  }
120
105
  /**
121
106
  * SolicitationsApi - object-oriented interface
122
- * @export
123
- * @class SolicitationsApi
124
- * @extends {BaseAPI}
125
107
  */
126
108
  export declare class SolicitationsApi extends BaseAPI {
127
109
  /**
@@ -129,7 +111,6 @@ export declare class SolicitationsApi extends BaseAPI {
129
111
  * @param {SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest} requestParameters Request parameters.
130
112
  * @param {*} [options] Override http request option.
131
113
  * @throws {RequiredError}
132
- * @memberof SolicitationsApi
133
114
  */
134
115
  createProductReviewAndSellerFeedbackSolicitation(requestParameters: SolicitationsApiCreateProductReviewAndSellerFeedbackSolicitationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateProductReviewAndSellerFeedbackSolicitationResponse, any>>;
135
116
  /**
@@ -137,7 +118,6 @@ export declare class SolicitationsApi extends BaseAPI {
137
118
  * @param {SolicitationsApiGetSolicitationActionsForOrderRequest} requestParameters Request parameters.
138
119
  * @param {*} [options] Override http request option.
139
120
  * @throws {RequiredError}
140
- * @memberof SolicitationsApi
141
121
  */
142
122
  getSolicitationActionsForOrder(requestParameters: SolicitationsApiGetSolicitationActionsForOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSolicitationActionsForOrderResponse, any>>;
143
123
  }
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
@@ -11,14 +11,10 @@
11
11
  */
12
12
  /**
13
13
  * The response schema for the createProductReviewAndSellerFeedbackSolicitation operation.
14
- * @export
15
- * @interface CreateProductReviewAndSellerFeedbackSolicitationResponse
16
14
  */
17
15
  export interface CreateProductReviewAndSellerFeedbackSolicitationResponse {
18
16
  /**
19
17
  * A list of error responses returned when a request is unsuccessful.
20
- * @type {Array<Error>}
21
- * @memberof CreateProductReviewAndSellerFeedbackSolicitationResponse
22
18
  */
23
19
  'errors'?: Array<Error>;
24
20
  }
@@ -10,16 +10,6 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { LinkObject } from './link-object';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSchemaResponseLinks
17
- */
18
13
  export interface GetSchemaResponseLinks {
19
- /**
20
- *
21
- * @type {LinkObject}
22
- * @memberof GetSchemaResponseLinks
23
- */
24
14
  'self': LinkObject;
25
15
  }
@@ -10,30 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { GetSchemaResponseLinks } from './get-schema-response-links';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSchemaResponse
17
- */
18
13
  export interface GetSchemaResponse {
19
- /**
20
- *
21
- * @type {GetSchemaResponseLinks}
22
- * @memberof GetSchemaResponse
23
- */
24
14
  '_links'?: GetSchemaResponseLinks;
25
15
  /**
26
16
  * A JSON schema document describing the expected payload of the action. This object can be validated against <a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema</a>.
27
- * @type {{ [key: string]: object; }}
28
- * @memberof GetSchemaResponse
29
17
  */
30
18
  'payload'?: {
31
19
  [key: string]: object;
32
20
  };
33
21
  /**
34
22
  * A list of error responses returned when a request is unsuccessful.
35
- * @type {Array<Error>}
36
- * @memberof GetSchemaResponse
37
23
  */
38
24
  'errors'?: Array<Error>;
39
25
  }
@@ -10,16 +10,6 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { GetSchemaResponse } from './get-schema-response';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSolicitationActionResponseEmbedded
17
- */
18
13
  export interface GetSolicitationActionResponseEmbedded {
19
- /**
20
- *
21
- * @type {GetSchemaResponse}
22
- * @memberof GetSolicitationActionResponseEmbedded
23
- */
24
14
  'schema'?: GetSchemaResponse;
25
15
  }
@@ -10,22 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { LinkObject } from './link-object';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSolicitationActionResponseLinks
17
- */
18
13
  export interface GetSolicitationActionResponseLinks {
19
- /**
20
- *
21
- * @type {LinkObject}
22
- * @memberof GetSolicitationActionResponseLinks
23
- */
24
14
  'self': LinkObject;
25
- /**
26
- *
27
- * @type {LinkObject}
28
- * @memberof GetSolicitationActionResponseLinks
29
- */
30
15
  'schema': LinkObject;
31
16
  }
@@ -14,32 +14,13 @@ import type { GetSolicitationActionResponseLinks } from './get-solicitation-acti
14
14
  import type { SolicitationsAction } from './solicitations-action';
15
15
  /**
16
16
  * Describes a solicitation action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.
17
- * @export
18
- * @interface GetSolicitationActionResponse
19
17
  */
20
18
  export interface GetSolicitationActionResponse {
21
- /**
22
- *
23
- * @type {GetSolicitationActionResponseLinks}
24
- * @memberof GetSolicitationActionResponse
25
- */
26
19
  '_links'?: GetSolicitationActionResponseLinks;
27
- /**
28
- *
29
- * @type {GetSolicitationActionResponseEmbedded}
30
- * @memberof GetSolicitationActionResponse
31
- */
32
20
  '_embedded'?: GetSolicitationActionResponseEmbedded;
33
- /**
34
- *
35
- * @type {SolicitationsAction}
36
- * @memberof GetSolicitationActionResponse
37
- */
38
21
  'payload'?: SolicitationsAction;
39
22
  /**
40
23
  * A list of error responses returned when a request is unsuccessful.
41
- * @type {Array<Error>}
42
- * @memberof GetSolicitationActionResponse
43
24
  */
44
25
  'errors'?: Array<Error>;
45
26
  }
@@ -10,16 +10,6 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { GetSolicitationActionResponse } from './get-solicitation-action-response';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSolicitationActionsForOrderResponseEmbedded
17
- */
18
13
  export interface GetSolicitationActionsForOrderResponseEmbedded {
19
- /**
20
- *
21
- * @type {Array<GetSolicitationActionResponse>}
22
- * @memberof GetSolicitationActionsForOrderResponseEmbedded
23
- */
24
14
  'actions': Array<GetSolicitationActionResponse>;
25
15
  }
@@ -10,22 +10,10 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { LinkObject } from './link-object';
13
- /**
14
- *
15
- * @export
16
- * @interface GetSolicitationActionsForOrderResponseLinks
17
- */
18
13
  export interface GetSolicitationActionsForOrderResponseLinks {
19
- /**
20
- *
21
- * @type {LinkObject}
22
- * @memberof GetSolicitationActionsForOrderResponseLinks
23
- */
24
14
  'self': LinkObject;
25
15
  /**
26
16
  * Eligible actions for the specified amazonOrderId.
27
- * @type {Array<LinkObject>}
28
- * @memberof GetSolicitationActionsForOrderResponseLinks
29
17
  */
30
18
  'actions': Array<LinkObject>;
31
19
  }
@@ -13,26 +13,12 @@ import type { GetSolicitationActionsForOrderResponseEmbedded } from './get-solic
13
13
  import type { GetSolicitationActionsForOrderResponseLinks } from './get-solicitation-actions-for-order-response-links';
14
14
  /**
15
15
  * The response schema for the getSolicitationActionsForOrder operation.
16
- * @export
17
- * @interface GetSolicitationActionsForOrderResponse
18
16
  */
19
17
  export interface GetSolicitationActionsForOrderResponse {
20
- /**
21
- *
22
- * @type {GetSolicitationActionsForOrderResponseLinks}
23
- * @memberof GetSolicitationActionsForOrderResponse
24
- */
25
18
  '_links'?: GetSolicitationActionsForOrderResponseLinks;
26
- /**
27
- *
28
- * @type {GetSolicitationActionsForOrderResponseEmbedded}
29
- * @memberof GetSolicitationActionsForOrderResponse
30
- */
31
19
  '_embedded'?: GetSolicitationActionsForOrderResponseEmbedded;
32
20
  /**
33
21
  * A list of error responses returned when a request is unsuccessful.
34
- * @type {Array<Error>}
35
- * @memberof GetSolicitationActionsForOrderResponse
36
22
  */
37
23
  'errors'?: Array<Error>;
38
24
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * A Link object.
14
- * @export
15
- * @interface LinkObject
16
14
  */
17
15
  export interface LinkObject {
18
16
  /**
19
17
  * A URI for this object.
20
- * @type {string}
21
- * @memberof LinkObject
22
18
  */
23
19
  'href': string;
24
20
  /**
25
21
  * An identifier for this object.
26
- * @type {string}
27
- * @memberof LinkObject
28
22
  */
29
23
  'name'?: string;
30
24
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * Error response returned when the request is unsuccessful.
14
- * @export
15
- * @interface ModelError
16
14
  */
17
15
  export interface ModelError {
18
16
  /**
19
17
  * An error code that identifies the type of error that occurred.
20
- * @type {string}
21
- * @memberof ModelError
22
18
  */
23
19
  'code': string;
24
20
  /**
25
21
  * A message that describes the error condition.
26
- * @type {string}
27
- * @memberof ModelError
28
22
  */
29
23
  'message': string;
30
24
  /**
31
25
  * Additional details that can help the caller understand or fix the issue.
32
- * @type {string}
33
- * @memberof ModelError
34
26
  */
35
27
  'details'?: string;
36
28
  }
@@ -11,14 +11,7 @@
11
11
  */
12
12
  /**
13
13
  * A simple object containing the name of the template.
14
- * @export
15
- * @interface SolicitationsAction
16
14
  */
17
15
  export interface SolicitationsAction {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof SolicitationsAction
22
- */
23
16
  'name': string;
24
17
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/solicitations-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the \\<a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language (HAL) standard.",
5
- "version": "3.1.4",
5
+ "version": "3.1.5",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.15",
22
- "axios": "^1.10.0"
21
+ "@sp-api-sdk/common": "2.1.16",
22
+ "axios": "^1.11.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,26 @@
40
40
  "sp sdk",
41
41
  "solicitations api"
42
42
  ],
43
- "gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
43
+ "xo": {
44
+ "extends": [
45
+ "xo-bizon"
46
+ ],
47
+ "settings": {
48
+ "import/internal-regex": "^@sp-api-sdk/"
49
+ },
50
+ "semicolon": false,
51
+ "space": 2,
52
+ "prettier": true,
53
+ "ignores": [
54
+ "src/api-model/**"
55
+ ],
56
+ "rules": {
57
+ "unicorn/prevent-abbreviations": "off"
58
+ }
59
+ },
60
+ "prettier": {
61
+ "printWidth": 100,
62
+ "jsxSingleQuote": true
63
+ },
64
+ "gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
44
65
  }