@sp-api-sdk/product-type-definitions-api-2020-09-01 4.0.0 → 4.0.2

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.
@@ -25,7 +25,6 @@ const common_1 = require("../common");
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * ProductTypeDefinitionsApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const ProductTypeDefinitionsApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -134,7 +133,6 @@ const ProductTypeDefinitionsApiAxiosParamCreator = function (configuration) {
134
133
  exports.ProductTypeDefinitionsApiAxiosParamCreator = ProductTypeDefinitionsApiAxiosParamCreator;
135
134
  /**
136
135
  * ProductTypeDefinitionsApi - functional programming interface
137
- * @export
138
136
  */
139
137
  const ProductTypeDefinitionsApiFp = function (configuration) {
140
138
  const localVarAxiosParamCreator = (0, exports.ProductTypeDefinitionsApiAxiosParamCreator)(configuration);
@@ -178,7 +176,6 @@ const ProductTypeDefinitionsApiFp = function (configuration) {
178
176
  exports.ProductTypeDefinitionsApiFp = ProductTypeDefinitionsApiFp;
179
177
  /**
180
178
  * ProductTypeDefinitionsApi - factory interface
181
- * @export
182
179
  */
183
180
  const ProductTypeDefinitionsApiFactory = function (configuration, basePath, axios) {
184
181
  const localVarFp = (0, exports.ProductTypeDefinitionsApiFp)(configuration);
@@ -206,9 +203,6 @@ const ProductTypeDefinitionsApiFactory = function (configuration, basePath, axio
206
203
  exports.ProductTypeDefinitionsApiFactory = ProductTypeDefinitionsApiFactory;
207
204
  /**
208
205
  * ProductTypeDefinitionsApi - object-oriented interface
209
- * @export
210
- * @class ProductTypeDefinitionsApi
211
- * @extends {BaseAPI}
212
206
  */
213
207
  class ProductTypeDefinitionsApi extends base_1.BaseAPI {
214
208
  /**
@@ -216,7 +210,6 @@ class ProductTypeDefinitionsApi extends base_1.BaseAPI {
216
210
  * @param {ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest} requestParameters Request parameters.
217
211
  * @param {*} [options] Override http request option.
218
212
  * @throws {RequiredError}
219
- * @memberof ProductTypeDefinitionsApi
220
213
  */
221
214
  getDefinitionsProductType(requestParameters, options) {
222
215
  return (0, exports.ProductTypeDefinitionsApiFp)(this.configuration).getDefinitionsProductType(requestParameters.productType, requestParameters.marketplaceIds, requestParameters.sellerId, requestParameters.productTypeVersion, requestParameters.requirements, requestParameters.requirementsEnforced, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
@@ -226,31 +219,21 @@ class ProductTypeDefinitionsApi extends base_1.BaseAPI {
226
219
  * @param {ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest} requestParameters Request parameters.
227
220
  * @param {*} [options] Override http request option.
228
221
  * @throws {RequiredError}
229
- * @memberof ProductTypeDefinitionsApi
230
222
  */
231
223
  searchDefinitionsProductTypes(requestParameters, options) {
232
224
  return (0, exports.ProductTypeDefinitionsApiFp)(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(this.axios, this.basePath));
233
225
  }
234
226
  }
235
227
  exports.ProductTypeDefinitionsApi = ProductTypeDefinitionsApi;
236
- /**
237
- * @export
238
- */
239
228
  exports.GetDefinitionsProductTypeRequirementsEnum = {
240
229
  Listing: 'LISTING',
241
230
  ListingProductOnly: 'LISTING_PRODUCT_ONLY',
242
231
  ListingOfferOnly: 'LISTING_OFFER_ONLY'
243
232
  };
244
- /**
245
- * @export
246
- */
247
233
  exports.GetDefinitionsProductTypeRequirementsEnforcedEnum = {
248
234
  Enforced: 'ENFORCED',
249
235
  NotEnforced: 'NOT_ENFORCED'
250
236
  };
251
- /**
252
- * @export
253
- */
254
237
  exports.GetDefinitionsProductTypeLocaleEnum = {
255
238
  Default: 'DEFAULT',
256
239
  Ar: 'ar',
@@ -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
  * ProductTypeDefinitionsApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const ProductTypeDefinitionsApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -127,7 +126,6 @@ export const ProductTypeDefinitionsApiAxiosParamCreator = function (configuratio
127
126
  };
128
127
  /**
129
128
  * ProductTypeDefinitionsApi - functional programming interface
130
- * @export
131
129
  */
132
130
  export const ProductTypeDefinitionsApiFp = function (configuration) {
133
131
  const localVarAxiosParamCreator = ProductTypeDefinitionsApiAxiosParamCreator(configuration);
@@ -170,7 +168,6 @@ export const ProductTypeDefinitionsApiFp = function (configuration) {
170
168
  };
171
169
  /**
172
170
  * ProductTypeDefinitionsApi - factory interface
173
- * @export
174
171
  */
175
172
  export const ProductTypeDefinitionsApiFactory = function (configuration, basePath, axios) {
176
173
  const localVarFp = ProductTypeDefinitionsApiFp(configuration);
@@ -197,9 +194,6 @@ export const ProductTypeDefinitionsApiFactory = function (configuration, basePat
197
194
  };
198
195
  /**
199
196
  * ProductTypeDefinitionsApi - object-oriented interface
200
- * @export
201
- * @class ProductTypeDefinitionsApi
202
- * @extends {BaseAPI}
203
197
  */
204
198
  export class ProductTypeDefinitionsApi extends BaseAPI {
205
199
  /**
@@ -207,7 +201,6 @@ export class ProductTypeDefinitionsApi extends BaseAPI {
207
201
  * @param {ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest} requestParameters Request parameters.
208
202
  * @param {*} [options] Override http request option.
209
203
  * @throws {RequiredError}
210
- * @memberof ProductTypeDefinitionsApi
211
204
  */
212
205
  getDefinitionsProductType(requestParameters, options) {
213
206
  return ProductTypeDefinitionsApiFp(this.configuration).getDefinitionsProductType(requestParameters.productType, requestParameters.marketplaceIds, requestParameters.sellerId, requestParameters.productTypeVersion, requestParameters.requirements, requestParameters.requirementsEnforced, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
@@ -217,30 +210,20 @@ export class ProductTypeDefinitionsApi extends BaseAPI {
217
210
  * @param {ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest} requestParameters Request parameters.
218
211
  * @param {*} [options] Override http request option.
219
212
  * @throws {RequiredError}
220
- * @memberof ProductTypeDefinitionsApi
221
213
  */
222
214
  searchDefinitionsProductTypes(requestParameters, options) {
223
215
  return ProductTypeDefinitionsApiFp(this.configuration).searchDefinitionsProductTypes(requestParameters.marketplaceIds, requestParameters.keywords, requestParameters.itemName, requestParameters.locale, requestParameters.searchLocale, options).then((request) => request(this.axios, this.basePath));
224
216
  }
225
217
  }
226
- /**
227
- * @export
228
- */
229
218
  export const GetDefinitionsProductTypeRequirementsEnum = {
230
219
  Listing: 'LISTING',
231
220
  ListingProductOnly: 'LISTING_PRODUCT_ONLY',
232
221
  ListingOfferOnly: 'LISTING_OFFER_ONLY'
233
222
  };
234
- /**
235
- * @export
236
- */
237
223
  export const GetDefinitionsProductTypeRequirementsEnforcedEnum = {
238
224
  Enforced: 'ENFORCED',
239
225
  NotEnforced: 'NOT_ENFORCED'
240
226
  };
241
- /**
242
- * @export
243
- */
244
227
  export const GetDefinitionsProductTypeLocaleEnum = {
245
228
  Default: 'DEFAULT',
246
229
  Ar: 'ar',
@@ -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 { ProductTypeDefinition } from '../models';
17
17
  import type { ProductTypeList } from '../models';
18
18
  /**
19
19
  * ProductTypeDefinitionsApi - axios parameter creator
20
- * @export
21
20
  */
22
21
  export declare const ProductTypeDefinitionsApiAxiosParamCreator: (configuration?: Configuration) => {
23
22
  /**
@@ -47,7 +46,6 @@ export declare const ProductTypeDefinitionsApiAxiosParamCreator: (configuration?
47
46
  };
48
47
  /**
49
48
  * ProductTypeDefinitionsApi - functional programming interface
50
- * @export
51
49
  */
52
50
  export declare const ProductTypeDefinitionsApiFp: (configuration?: Configuration) => {
53
51
  /**
@@ -77,7 +75,6 @@ export declare const ProductTypeDefinitionsApiFp: (configuration?: Configuration
77
75
  };
78
76
  /**
79
77
  * ProductTypeDefinitionsApi - factory interface
80
- * @export
81
78
  */
82
79
  export declare const ProductTypeDefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
83
80
  /**
@@ -97,95 +94,64 @@ export declare const ProductTypeDefinitionsApiFactory: (configuration?: Configur
97
94
  };
98
95
  /**
99
96
  * Request parameters for getDefinitionsProductType operation in ProductTypeDefinitionsApi.
100
- * @export
101
- * @interface ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest
102
97
  */
103
98
  export interface ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest {
104
99
  /**
105
100
  * The Amazon product type name.
106
- * @type {string}
107
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
108
101
  */
109
102
  readonly productType: string;
110
103
  /**
111
104
  * A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time.
112
- * @type {Array<string>}
113
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
114
105
  */
115
106
  readonly marketplaceIds: Array<string>;
116
107
  /**
117
108
  * A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.
118
- * @type {string}
119
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
120
109
  */
121
110
  readonly sellerId?: string;
122
111
  /**
123
112
  * The version of the Amazon product type to retrieve. Defaults to \&quot;LATEST\&quot;,. Prerelease versions of product type definitions may be retrieved with \&quot;RELEASE_CANDIDATE\&quot;. If no prerelease version is currently available, the \&quot;LATEST\&quot; live version will be provided.
124
- * @type {string}
125
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
126
113
  */
127
114
  readonly productTypeVersion?: string;
128
115
  /**
129
116
  * The name of the requirements set to retrieve requirements for.
130
- * @type {'LISTING' | 'LISTING_PRODUCT_ONLY' | 'LISTING_OFFER_ONLY'}
131
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
132
117
  */
133
118
  readonly requirements?: GetDefinitionsProductTypeRequirementsEnum;
134
119
  /**
135
120
  * Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).
136
- * @type {'ENFORCED' | 'NOT_ENFORCED'}
137
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
138
121
  */
139
122
  readonly requirementsEnforced?: GetDefinitionsProductTypeRequirementsEnforcedEnum;
140
123
  /**
141
124
  * Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.
142
- * @type {'DEFAULT' | 'ar' | 'ar_AE' | 'de' | 'de_DE' | 'en' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GB' | 'en_IN' | 'en_SG' | 'en_US' | 'es' | 'es_ES' | 'es_MX' | 'es_US' | 'fr' | 'fr_CA' | 'fr_FR' | 'it' | 'it_IT' | 'ja' | 'ja_JP' | 'nl' | 'nl_NL' | 'pl' | 'pl_PL' | 'pt' | 'pt_BR' | 'pt_PT' | 'sv' | 'sv_SE' | 'tr' | 'tr_TR' | 'zh' | 'zh_CN' | 'zh_TW'}
143
- * @memberof ProductTypeDefinitionsApiGetDefinitionsProductType
144
125
  */
145
126
  readonly locale?: GetDefinitionsProductTypeLocaleEnum;
146
127
  }
147
128
  /**
148
129
  * Request parameters for searchDefinitionsProductTypes operation in ProductTypeDefinitionsApi.
149
- * @export
150
- * @interface ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest
151
130
  */
152
131
  export interface ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest {
153
132
  /**
154
133
  * A comma-delimited list of Amazon marketplace identifiers for the request.
155
- * @type {Array<string>}
156
- * @memberof ProductTypeDefinitionsApiSearchDefinitionsProductTypes
157
134
  */
158
135
  readonly marketplaceIds: Array<string>;
159
136
  /**
160
137
  * A comma-delimited list of keywords to search product types. **Note:** Cannot be used with &#x60;itemName&#x60;.
161
- * @type {Array<string>}
162
- * @memberof ProductTypeDefinitionsApiSearchDefinitionsProductTypes
163
138
  */
164
139
  readonly keywords?: Array<string>;
165
140
  /**
166
141
  * The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with &#x60;keywords&#x60;.
167
- * @type {string}
168
- * @memberof ProductTypeDefinitionsApiSearchDefinitionsProductTypes
169
142
  */
170
143
  readonly itemName?: string;
171
144
  /**
172
145
  * The locale for the display names in the response. Defaults to the primary locale of the marketplace.
173
- * @type {string}
174
- * @memberof ProductTypeDefinitionsApiSearchDefinitionsProductTypes
175
146
  */
176
147
  readonly locale?: string;
177
148
  /**
178
149
  * The locale used for the &#x60;keywords&#x60; and &#x60;itemName&#x60; parameters. Defaults to the primary locale of the marketplace.
179
- * @type {string}
180
- * @memberof ProductTypeDefinitionsApiSearchDefinitionsProductTypes
181
150
  */
182
151
  readonly searchLocale?: string;
183
152
  }
184
153
  /**
185
154
  * ProductTypeDefinitionsApi - object-oriented interface
186
- * @export
187
- * @class ProductTypeDefinitionsApi
188
- * @extends {BaseAPI}
189
155
  */
190
156
  export declare class ProductTypeDefinitionsApi extends BaseAPI {
191
157
  /**
@@ -193,7 +159,6 @@ export declare class ProductTypeDefinitionsApi extends BaseAPI {
193
159
  * @param {ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest} requestParameters Request parameters.
194
160
  * @param {*} [options] Override http request option.
195
161
  * @throws {RequiredError}
196
- * @memberof ProductTypeDefinitionsApi
197
162
  */
198
163
  getDefinitionsProductType(requestParameters: ProductTypeDefinitionsApiGetDefinitionsProductTypeRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ProductTypeDefinition, any>>;
199
164
  /**
@@ -201,30 +166,20 @@ export declare class ProductTypeDefinitionsApi extends BaseAPI {
201
166
  * @param {ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest} requestParameters Request parameters.
202
167
  * @param {*} [options] Override http request option.
203
168
  * @throws {RequiredError}
204
- * @memberof ProductTypeDefinitionsApi
205
169
  */
206
170
  searchDefinitionsProductTypes(requestParameters: ProductTypeDefinitionsApiSearchDefinitionsProductTypesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ProductTypeList, any>>;
207
171
  }
208
- /**
209
- * @export
210
- */
211
172
  export declare const GetDefinitionsProductTypeRequirementsEnum: {
212
173
  readonly Listing: "LISTING";
213
174
  readonly ListingProductOnly: "LISTING_PRODUCT_ONLY";
214
175
  readonly ListingOfferOnly: "LISTING_OFFER_ONLY";
215
176
  };
216
177
  export type GetDefinitionsProductTypeRequirementsEnum = typeof GetDefinitionsProductTypeRequirementsEnum[keyof typeof GetDefinitionsProductTypeRequirementsEnum];
217
- /**
218
- * @export
219
- */
220
178
  export declare const GetDefinitionsProductTypeRequirementsEnforcedEnum: {
221
179
  readonly Enforced: "ENFORCED";
222
180
  readonly NotEnforced: "NOT_ENFORCED";
223
181
  };
224
182
  export type GetDefinitionsProductTypeRequirementsEnforcedEnum = typeof GetDefinitionsProductTypeRequirementsEnforcedEnum[keyof typeof GetDefinitionsProductTypeRequirementsEnforcedEnum];
225
- /**
226
- * @export
227
- */
228
183
  export declare const GetDefinitionsProductTypeLocaleEnum: {
229
184
  readonly Default: "DEFAULT";
230
185
  readonly Ar: "ar";
@@ -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,7 @@
11
11
  */
12
12
  /**
13
13
  * A list of error responses returned when a request is unsuccessful.
14
- * @export
15
- * @interface ErrorList
16
14
  */
17
15
  export interface ErrorList {
18
- /**
19
- *
20
- * @type {Array<Error>}
21
- * @memberof ErrorList
22
- */
23
16
  'errors': Array<Error>;
24
17
  }
@@ -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
  }
@@ -14,71 +14,40 @@ import type { PropertyGroup } from './property-group';
14
14
  import type { SchemaLink } from './schema-link';
15
15
  /**
16
16
  * A product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds.
17
- * @export
18
- * @interface ProductTypeDefinition
19
17
  */
20
18
  export interface ProductTypeDefinition {
21
- /**
22
- *
23
- * @type {SchemaLink}
24
- * @memberof ProductTypeDefinition
25
- */
26
19
  'metaSchema'?: SchemaLink;
27
- /**
28
- *
29
- * @type {SchemaLink}
30
- * @memberof ProductTypeDefinition
31
- */
32
20
  'schema': SchemaLink;
33
21
  /**
34
22
  * Name of the requirements set represented in this product type definition.
35
- * @type {string}
36
- * @memberof ProductTypeDefinition
37
23
  */
38
24
  'requirements': ProductTypeDefinitionRequirementsEnum;
39
25
  /**
40
26
  * Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates).
41
- * @type {string}
42
- * @memberof ProductTypeDefinition
43
27
  */
44
28
  'requirementsEnforced': ProductTypeDefinitionRequirementsEnforcedEnum;
45
29
  /**
46
30
  * Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes.
47
- * @type {{ [key: string]: PropertyGroup; }}
48
- * @memberof ProductTypeDefinition
49
31
  */
50
32
  'propertyGroups': {
51
33
  [key: string]: PropertyGroup;
52
34
  };
53
35
  /**
54
36
  * Locale of the display elements contained in the product type definition.
55
- * @type {string}
56
- * @memberof ProductTypeDefinition
57
37
  */
58
38
  'locale': string;
59
39
  /**
60
40
  * Amazon marketplace identifiers for which the product type definition is applicable.
61
- * @type {Array<string>}
62
- * @memberof ProductTypeDefinition
63
41
  */
64
42
  'marketplaceIds': Array<string>;
65
43
  /**
66
44
  * The name of the Amazon product type that this product type definition applies to.
67
- * @type {string}
68
- * @memberof ProductTypeDefinition
69
45
  */
70
46
  'productType': string;
71
47
  /**
72
48
  * Human-readable and localized description of the Amazon product type.
73
- * @type {string}
74
- * @memberof ProductTypeDefinition
75
49
  */
76
50
  'displayName': string;
77
- /**
78
- *
79
- * @type {ProductTypeVersion}
80
- * @memberof ProductTypeDefinition
81
- */
82
51
  'productTypeVersion': ProductTypeVersion;
83
52
  }
84
53
  export declare const ProductTypeDefinitionRequirementsEnum: {
@@ -12,20 +12,11 @@
12
12
  import type { ProductType } from './product-type';
13
13
  /**
14
14
  * A list of Amazon product types with definitions available.
15
- * @export
16
- * @interface ProductTypeList
17
15
  */
18
16
  export interface ProductTypeList {
19
- /**
20
- *
21
- * @type {Array<ProductType>}
22
- * @memberof ProductTypeList
23
- */
24
17
  'productTypes': Array<ProductType>;
25
18
  /**
26
19
  * Amazon product type version identifier.
27
- * @type {string}
28
- * @memberof ProductTypeList
29
20
  */
30
21
  'productTypeVersion': string;
31
22
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * The version details for an Amazon product type.
14
- * @export
15
- * @interface ProductTypeVersion
16
14
  */
17
15
  export interface ProductTypeVersion {
18
16
  /**
19
17
  * Version identifier.
20
- * @type {string}
21
- * @memberof ProductTypeVersion
22
18
  */
23
19
  'version': string;
24
20
  /**
25
21
  * When true, the version indicated by the version identifier is the latest available for the Amazon product type.
26
- * @type {boolean}
27
- * @memberof ProductTypeVersion
28
22
  */
29
23
  'latest': boolean;
30
24
  /**
31
25
  * When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type.
32
- * @type {boolean}
33
- * @memberof ProductTypeVersion
34
26
  */
35
27
  'releaseCandidate'?: boolean;
36
28
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * An Amazon product type with a definition available.
14
- * @export
15
- * @interface ProductType
16
14
  */
17
15
  export interface ProductType {
18
16
  /**
19
17
  * The name of the Amazon product type.
20
- * @type {string}
21
- * @memberof ProductType
22
18
  */
23
19
  'name': string;
24
20
  /**
25
21
  * The human-readable and localized description of the Amazon product type.
26
- * @type {string}
27
- * @memberof ProductType
28
22
  */
29
23
  'displayName': string;
30
24
  /**
31
25
  * The Amazon marketplace identifiers for which the product type definition is available.
32
- * @type {Array<string>}
33
- * @memberof ProductType
34
26
  */
35
27
  'marketplaceIds': Array<string>;
36
28
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * A property group represents a logical grouping of schema properties that can be used for display or informational purposes.
14
- * @export
15
- * @interface PropertyGroup
16
14
  */
17
15
  export interface PropertyGroup {
18
16
  /**
19
17
  * The display label of the property group.
20
- * @type {string}
21
- * @memberof PropertyGroup
22
18
  */
23
19
  'title'?: string;
24
20
  /**
25
21
  * The description of the property group.
26
- * @type {string}
27
- * @memberof PropertyGroup
28
22
  */
29
23
  'description'?: string;
30
24
  /**
31
25
  * The names of the schema properties for the property group.
32
- * @type {Array<string>}
33
- * @memberof PropertyGroup
34
26
  */
35
27
  'propertyNames'?: Array<string>;
36
28
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * Link to retrieve the schema.
14
- * @export
15
- * @interface SchemaLinkLink
16
14
  */
17
15
  export interface SchemaLinkLink {
18
16
  /**
19
17
  * URI resource for the link.
20
- * @type {string}
21
- * @memberof SchemaLinkLink
22
18
  */
23
19
  'resource': string;
24
20
  /**
25
21
  * HTTP method for the link operation.
26
- * @type {string}
27
- * @memberof SchemaLinkLink
28
22
  */
29
23
  'verb': SchemaLinkLinkVerbEnum;
30
24
  }
@@ -10,22 +10,10 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SchemaLinkLink } from './schema-link-link';
13
- /**
14
- *
15
- * @export
16
- * @interface SchemaLink
17
- */
18
13
  export interface SchemaLink {
19
- /**
20
- *
21
- * @type {SchemaLinkLink}
22
- * @memberof SchemaLink
23
- */
24
14
  'link': SchemaLinkLink;
25
15
  /**
26
16
  * Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching.
27
- * @type {string}
28
- * @memberof SchemaLink
29
17
  */
30
18
  'checksum': string;
31
19
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/product-type-definitions-api-2020-09-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For more information, see the Product Type Definitions API Use Case Guide.",
5
- "version": "4.0.0",
5
+ "version": "4.0.2",
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.14",
22
- "axios": "^1.9.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
  "product type definitions api"
42
42
  ],
43
- "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
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
  }