@sp-api-sdk/vehicles-api-2024-11-01 1.1.4 → 1.1.6

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 (30) hide show
  1. package/dist/cjs/api-model/api/vehicles-api.js +0 -10
  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/cjs/api-model/models/engine-output-unit.js +0 -2
  6. package/dist/cjs/api-model/models/vehicle-standard.js +0 -2
  7. package/dist/cjs/api-model/models/vehicle-status-in-catalog.js +0 -2
  8. package/dist/es/api-model/api/vehicles-api.js +0 -10
  9. package/dist/es/api-model/base.js +0 -19
  10. package/dist/es/api-model/common.js +0 -37
  11. package/dist/es/api-model/configuration.js +0 -17
  12. package/dist/es/api-model/models/engine-output-unit.js +0 -2
  13. package/dist/es/api-model/models/vehicle-standard.js +0 -2
  14. package/dist/es/api-model/models/vehicle-status-in-catalog.js +0 -2
  15. package/dist/types/api-model/api/vehicles-api.d.ts +0 -20
  16. package/dist/types/api-model/base.d.ts +0 -24
  17. package/dist/types/api-model/common.d.ts +0 -37
  18. package/dist/types/api-model/configuration.d.ts +0 -17
  19. package/dist/types/api-model/models/engine-output-unit.d.ts +0 -2
  20. package/dist/types/api-model/models/engine-output.d.ts +0 -9
  21. package/dist/types/api-model/models/error-list.d.ts +0 -4
  22. package/dist/types/api-model/models/model-error.d.ts +0 -8
  23. package/dist/types/api-model/models/month-and-year.d.ts +0 -6
  24. package/dist/types/api-model/models/pagination.d.ts +0 -6
  25. package/dist/types/api-model/models/vehicle-identifiers.d.ts +0 -9
  26. package/dist/types/api-model/models/vehicle-standard.d.ts +0 -2
  27. package/dist/types/api-model/models/vehicle-status-in-catalog.d.ts +0 -2
  28. package/dist/types/api-model/models/vehicle.d.ts +0 -35
  29. package/dist/types/api-model/models/vehicles-response.d.ts +0 -9
  30. 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
  * VehiclesApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const VehiclesApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -78,7 +77,6 @@ const VehiclesApiAxiosParamCreator = function (configuration) {
78
77
  exports.VehiclesApiAxiosParamCreator = VehiclesApiAxiosParamCreator;
79
78
  /**
80
79
  * VehiclesApi - functional programming interface
81
- * @export
82
80
  */
83
81
  const VehiclesApiFp = function (configuration) {
84
82
  const localVarAxiosParamCreator = (0, exports.VehiclesApiAxiosParamCreator)(configuration);
@@ -103,7 +101,6 @@ const VehiclesApiFp = function (configuration) {
103
101
  exports.VehiclesApiFp = VehiclesApiFp;
104
102
  /**
105
103
  * VehiclesApi - factory interface
106
- * @export
107
104
  */
108
105
  const VehiclesApiFactory = function (configuration, basePath, axios) {
109
106
  const localVarFp = (0, exports.VehiclesApiFp)(configuration);
@@ -122,9 +119,6 @@ const VehiclesApiFactory = function (configuration, basePath, axios) {
122
119
  exports.VehiclesApiFactory = VehiclesApiFactory;
123
120
  /**
124
121
  * VehiclesApi - object-oriented interface
125
- * @export
126
- * @class VehiclesApi
127
- * @extends {BaseAPI}
128
122
  */
129
123
  class VehiclesApi extends base_1.BaseAPI {
130
124
  /**
@@ -132,16 +126,12 @@ class VehiclesApi extends base_1.BaseAPI {
132
126
  * @param {VehiclesApiGetVehiclesRequest} requestParameters Request parameters.
133
127
  * @param {*} [options] Override http request option.
134
128
  * @throws {RequiredError}
135
- * @memberof VehiclesApi
136
129
  */
137
130
  getVehicles(requestParameters, options) {
138
131
  return (0, exports.VehiclesApiFp)(this.configuration).getVehicles(requestParameters.marketplaceId, requestParameters.vehicleType, requestParameters.pageToken, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
139
132
  }
140
133
  }
141
134
  exports.VehiclesApi = VehiclesApi;
142
- /**
143
- * @export
144
- */
145
135
  exports.GetVehiclesVehicleTypeEnum = {
146
136
  Car: 'CAR',
147
137
  Motorbike: 'MOTORBIKE'
@@ -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
  /**
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.EngineOutputUnit = void 0;
17
17
  /**
18
18
  * Unit for measuring engine power.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
  exports.EngineOutputUnit = {
23
21
  Kilowatt: 'KILOWATT',
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.VehicleStandard = void 0;
17
17
  /**
18
18
  * Standard followed to uniquely identify a vehicle.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
  exports.VehicleStandard = {
23
21
  Ktype: 'KTYPE',
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.VehicleStatusInCatalog = void 0;
17
17
  /**
18
18
  * Status of vehicle in Amazon\'s catalog.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
  exports.VehicleStatusInCatalog = {
23
21
  Active: 'ACTIVE',
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
19
19
  import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * VehiclesApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const VehiclesApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -71,7 +70,6 @@ export const VehiclesApiAxiosParamCreator = function (configuration) {
71
70
  };
72
71
  /**
73
72
  * VehiclesApi - functional programming interface
74
- * @export
75
73
  */
76
74
  export const VehiclesApiFp = function (configuration) {
77
75
  const localVarAxiosParamCreator = VehiclesApiAxiosParamCreator(configuration);
@@ -95,7 +93,6 @@ export const VehiclesApiFp = function (configuration) {
95
93
  };
96
94
  /**
97
95
  * VehiclesApi - factory interface
98
- * @export
99
96
  */
100
97
  export const VehiclesApiFactory = function (configuration, basePath, axios) {
101
98
  const localVarFp = VehiclesApiFp(configuration);
@@ -113,9 +110,6 @@ export const VehiclesApiFactory = function (configuration, basePath, axios) {
113
110
  };
114
111
  /**
115
112
  * VehiclesApi - object-oriented interface
116
- * @export
117
- * @class VehiclesApi
118
- * @extends {BaseAPI}
119
113
  */
120
114
  export class VehiclesApi extends BaseAPI {
121
115
  /**
@@ -123,15 +117,11 @@ export class VehiclesApi extends BaseAPI {
123
117
  * @param {VehiclesApiGetVehiclesRequest} requestParameters Request parameters.
124
118
  * @param {*} [options] Override http request option.
125
119
  * @throws {RequiredError}
126
- * @memberof VehiclesApi
127
120
  */
128
121
  getVehicles(requestParameters, options) {
129
122
  return VehiclesApiFp(this.configuration).getVehicles(requestParameters.marketplaceId, requestParameters.vehicleType, requestParameters.pageToken, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
130
123
  }
131
124
  }
132
- /**
133
- * @export
134
- */
135
125
  export const GetVehiclesVehicleTypeEnum = {
136
126
  Car: 'CAR',
137
127
  Motorbike: 'MOTORBIKE'
@@ -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
  /**
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Unit for measuring engine power.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const EngineOutputUnit = {
20
18
  Kilowatt: 'KILOWATT',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Standard followed to uniquely identify a vehicle.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const VehicleStandard = {
20
18
  Ktype: 'KTYPE',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Status of vehicle in Amazon\'s catalog.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const VehicleStatusInCatalog = {
20
18
  Active: 'ACTIVE',
@@ -16,7 +16,6 @@ import { type RequestArgs, BaseAPI } from '../base';
16
16
  import type { VehiclesResponse } from '../models';
17
17
  /**
18
18
  * VehiclesApi - axios parameter creator
19
- * @export
20
19
  */
21
20
  export declare const VehiclesApiAxiosParamCreator: (configuration?: Configuration) => {
22
21
  /**
@@ -32,7 +31,6 @@ export declare const VehiclesApiAxiosParamCreator: (configuration?: Configuratio
32
31
  };
33
32
  /**
34
33
  * VehiclesApi - functional programming interface
35
- * @export
36
34
  */
37
35
  export declare const VehiclesApiFp: (configuration?: Configuration) => {
38
36
  /**
@@ -48,7 +46,6 @@ export declare const VehiclesApiFp: (configuration?: Configuration) => {
48
46
  };
49
47
  /**
50
48
  * VehiclesApi - factory interface
51
- * @export
52
49
  */
53
50
  export declare const VehiclesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
54
51
  /**
@@ -61,40 +58,27 @@ export declare const VehiclesApiFactory: (configuration?: Configuration, basePat
61
58
  };
62
59
  /**
63
60
  * Request parameters for getVehicles operation in VehiclesApi.
64
- * @export
65
- * @interface VehiclesApiGetVehiclesRequest
66
61
  */
67
62
  export interface VehiclesApiGetVehiclesRequest {
68
63
  /**
69
64
  * An identifier for the marketplace in which the resource operates.
70
- * @type {string}
71
- * @memberof VehiclesApiGetVehicles
72
65
  */
73
66
  readonly marketplaceId: string;
74
67
  /**
75
68
  * An identifier for vehicle type.
76
- * @type {'CAR' | 'MOTORBIKE'}
77
- * @memberof VehiclesApiGetVehicles
78
69
  */
79
70
  readonly vehicleType: GetVehiclesVehicleTypeEnum;
80
71
  /**
81
72
  * A token to fetch a certain page when there are multiple pages worth of results.
82
- * @type {string}
83
- * @memberof VehiclesApiGetVehicles
84
73
  */
85
74
  readonly pageToken?: string;
86
75
  /**
87
76
  * Date in ISO 8601 format, if provided only vehicles which are modified/added to Amazon\'s catalog after this date will be returned.
88
- * @type {string}
89
- * @memberof VehiclesApiGetVehicles
90
77
  */
91
78
  readonly updatedAfter?: string;
92
79
  }
93
80
  /**
94
81
  * VehiclesApi - object-oriented interface
95
- * @export
96
- * @class VehiclesApi
97
- * @extends {BaseAPI}
98
82
  */
99
83
  export declare class VehiclesApi extends BaseAPI {
100
84
  /**
@@ -102,13 +86,9 @@ export declare class VehiclesApi extends BaseAPI {
102
86
  * @param {VehiclesApiGetVehiclesRequest} requestParameters Request parameters.
103
87
  * @param {*} [options] Override http request option.
104
88
  * @throws {RequiredError}
105
- * @memberof VehiclesApi
106
89
  */
107
90
  getVehicles(requestParameters: VehiclesApiGetVehiclesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VehiclesResponse, any>>;
108
91
  }
109
- /**
110
- * @export
111
- */
112
92
  export declare const GetVehiclesVehicleTypeEnum: {
113
93
  readonly Car: "CAR";
114
94
  readonly Motorbike: "MOTORBIKE";
@@ -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,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * Unit for measuring engine power.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const EngineOutputUnit: {
18
16
  readonly Kilowatt: "KILOWATT";
@@ -12,20 +12,11 @@
12
12
  import type { EngineOutputUnit } from './engine-output-unit';
13
13
  /**
14
14
  * Engine power output of vehicle.
15
- * @export
16
- * @interface EngineOutput
17
15
  */
18
16
  export interface EngineOutput {
19
17
  /**
20
18
  * Engine power value in specified unit.
21
- * @type {number}
22
- * @memberof EngineOutput
23
19
  */
24
20
  'value': number;
25
- /**
26
- *
27
- * @type {EngineOutputUnit}
28
- * @memberof EngineOutput
29
- */
30
21
  'unit': EngineOutputUnit;
31
22
  }
@@ -11,14 +11,10 @@
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
16
  /**
19
17
  * array of errors
20
- * @type {Array<Error>}
21
- * @memberof ErrorList
22
18
  */
23
19
  'errors': Array<Error>;
24
20
  }
@@ -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,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * Represents a month in a specific year.
14
- * @export
15
- * @interface MonthAndYear
16
14
  */
17
15
  export interface MonthAndYear {
18
16
  /**
19
17
  * Year in YYYY format
20
- * @type {number}
21
- * @memberof MonthAndYear
22
18
  */
23
19
  'year'?: number;
24
20
  /**
25
21
  * Month in MM format
26
- * @type {number}
27
- * @memberof MonthAndYear
28
22
  */
29
23
  'month'?: number;
30
24
  }
@@ -11,20 +11,14 @@
11
11
  */
12
12
  /**
13
13
  * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object.
14
- * @export
15
- * @interface Pagination
16
14
  */
17
15
  export interface Pagination {
18
16
  /**
19
17
  * A token that can be used to fetch the next page.
20
- * @type {string}
21
- * @memberof Pagination
22
18
  */
23
19
  'nextToken'?: string;
24
20
  /**
25
21
  * A token that can be used to fetch the previous page.
26
- * @type {string}
27
- * @memberof Pagination
28
22
  */
29
23
  'previousToken'?: string;
30
24
  }
@@ -12,20 +12,11 @@
12
12
  import type { VehicleStandard } from './vehicle-standard';
13
13
  /**
14
14
  * Combination of vehicle standard and id that can uniquely identify a vehicle from Amazon\'s catalog.
15
- * @export
16
- * @interface VehicleIdentifiers
17
15
  */
18
16
  export interface VehicleIdentifiers {
19
- /**
20
- *
21
- * @type {VehicleStandard}
22
- * @memberof VehicleIdentifiers
23
- */
24
17
  'standard': VehicleStandard;
25
18
  /**
26
19
  * Id that can uniquely identify a vehicle based the vehicle identification standard.
27
- * @type {string}
28
- * @memberof VehicleIdentifiers
29
20
  */
30
21
  'value': string;
31
22
  }
@@ -11,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * Standard followed to uniquely identify a vehicle.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const VehicleStandard: {
18
16
  readonly Ktype: "KTYPE";
@@ -11,8 +11,6 @@
11
11
  */
12
12
  /**
13
13
  * Status of vehicle in Amazon\'s catalog.
14
- * @export
15
- * @enum {string}
16
14
  */
17
15
  export declare const VehicleStatusInCatalog: {
18
16
  readonly Active: "ACTIVE";
@@ -15,80 +15,45 @@ import type { VehicleIdentifiers } from './vehicle-identifiers';
15
15
  import type { VehicleStatusInCatalog } from './vehicle-status-in-catalog';
16
16
  /**
17
17
  * Combinations of attributes and unique identifier that represents a vehicle in vehicle list.
18
- * @export
19
- * @interface Vehicle
20
18
  */
21
19
  export interface Vehicle {
22
20
  /**
23
21
  * Vehicle Brand.
24
- * @type {string}
25
- * @memberof Vehicle
26
22
  */
27
23
  'make': string;
28
24
  /**
29
25
  * Specific model of a vehicle.
30
- * @type {string}
31
- * @memberof Vehicle
32
26
  */
33
27
  'model': string;
34
28
  /**
35
29
  * Name of the vehicle variant.
36
- * @type {string}
37
- * @memberof Vehicle
38
30
  */
39
31
  'variantName'?: string;
40
32
  /**
41
33
  * Body style of vehicle (example: Hatchback, Cabriolet).
42
- * @type {string}
43
- * @memberof Vehicle
44
34
  */
45
35
  'bodyStyle'?: string;
46
36
  /**
47
37
  * Drive type of vehicle(example: Rear wheel drive).
48
- * @type {string}
49
- * @memberof Vehicle
50
38
  */
51
39
  'driveType'?: string;
52
40
  /**
53
41
  * Energy Source for the vehicle(example: Petrol)
54
- * @type {string}
55
- * @memberof Vehicle
56
42
  */
57
43
  'energy'?: string;
58
44
  /**
59
45
  * Engine output of vehicle.
60
- * @type {Array<EngineOutput>}
61
- * @memberof Vehicle
62
46
  */
63
47
  'engineOutput'?: Array<EngineOutput>;
64
- /**
65
- *
66
- * @type {MonthAndYear}
67
- * @memberof Vehicle
68
- */
69
48
  'manufacturingStartDate'?: MonthAndYear;
70
- /**
71
- *
72
- * @type {MonthAndYear}
73
- * @memberof Vehicle
74
- */
75
49
  'manufacturingStopDate'?: MonthAndYear;
76
50
  /**
77
51
  * The date on which the vehicle was last updated, in ISO-8601 date/time format.
78
- * @type {string}
79
- * @memberof Vehicle
80
52
  */
81
53
  'lastProcessedDate'?: string;
82
- /**
83
- *
84
- * @type {VehicleStatusInCatalog}
85
- * @memberof Vehicle
86
- */
87
54
  'status'?: VehicleStatusInCatalog;
88
55
  /**
89
56
  * Identifiers that can be used to identify the vehicle uniquely
90
- * @type {Array<VehicleIdentifiers>}
91
- * @memberof Vehicle
92
57
  */
93
58
  'identifiers': Array<VehicleIdentifiers>;
94
59
  }
@@ -13,20 +13,11 @@ import type { Pagination } from './pagination';
13
13
  import type { Vehicle } from './vehicle';
14
14
  /**
15
15
  * Get paginated list of vehicle from Amazon\'s catalog
16
- * @export
17
- * @interface VehiclesResponse
18
16
  */
19
17
  export interface VehiclesResponse {
20
- /**
21
- *
22
- * @type {Pagination}
23
- * @memberof VehiclesResponse
24
- */
25
18
  'pagination'?: Pagination;
26
19
  /**
27
20
  * List of vehicles from Amazon\'s catalog.
28
- * @type {Array<Vehicle>}
29
- * @memberof VehiclesResponse
30
21
  */
31
22
  'vehicles': Array<Vehicle>;
32
23
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vehicles-api-2024-11-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Automotive provides programmatic access to information needed by selling partners to provide compatibility information about their listed products.",
5
- "version": "1.1.4",
5
+ "version": "1.1.6",
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.17",
22
+ "axios": "^1.11.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,26 @@
40
40
  "sp sdk",
41
41
  "vehicles 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": "961457650a65779f38e5d35547ca8cb2fb749943"
44
65
  }