@sp-api-sdk/sellers-api-v1 4.1.3 → 4.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.
@@ -25,7 +25,6 @@ const common_1 = require("../common");
25
25
  const base_1 = require("../base");
26
26
  /**
27
27
  * SellersApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const SellersApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -82,7 +81,6 @@ const SellersApiAxiosParamCreator = function (configuration) {
82
81
  exports.SellersApiAxiosParamCreator = SellersApiAxiosParamCreator;
83
82
  /**
84
83
  * SellersApi - functional programming interface
85
- * @export
86
84
  */
87
85
  const SellersApiFp = function (configuration) {
88
86
  const localVarAxiosParamCreator = (0, exports.SellersApiAxiosParamCreator)(configuration);
@@ -114,7 +112,6 @@ const SellersApiFp = function (configuration) {
114
112
  exports.SellersApiFp = SellersApiFp;
115
113
  /**
116
114
  * SellersApi - factory interface
117
- * @export
118
115
  */
119
116
  const SellersApiFactory = function (configuration, basePath, axios) {
120
117
  const localVarFp = (0, exports.SellersApiFp)(configuration);
@@ -140,16 +137,12 @@ const SellersApiFactory = function (configuration, basePath, axios) {
140
137
  exports.SellersApiFactory = SellersApiFactory;
141
138
  /**
142
139
  * SellersApi - object-oriented interface
143
- * @export
144
- * @class SellersApi
145
- * @extends {BaseAPI}
146
140
  */
147
141
  class SellersApi extends base_1.BaseAPI {
148
142
  /**
149
143
  * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
150
144
  * @param {*} [options] Override http request option.
151
145
  * @throws {RequiredError}
152
- * @memberof SellersApi
153
146
  */
154
147
  getAccount(options) {
155
148
  return (0, exports.SellersApiFp)(this.configuration).getAccount(options).then((request) => request(this.axios, this.basePath));
@@ -158,7 +151,6 @@ class SellersApi extends base_1.BaseAPI {
158
151
  * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
159
152
  * @param {*} [options] Override http request option.
160
153
  * @throws {RequiredError}
161
- * @memberof SellersApi
162
154
  */
163
155
  getMarketplaceParticipations(options) {
164
156
  return (0, exports.SellersApiFp)(this.configuration).getMarketplaceParticipations(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, setSearchParams, toPathString, createRequestFunction }
19
19
  import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * SellersApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const SellersApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -75,7 +74,6 @@ export const SellersApiAxiosParamCreator = function (configuration) {
75
74
  };
76
75
  /**
77
76
  * SellersApi - functional programming interface
78
- * @export
79
77
  */
80
78
  export const SellersApiFp = function (configuration) {
81
79
  const localVarAxiosParamCreator = SellersApiAxiosParamCreator(configuration);
@@ -106,7 +104,6 @@ export const SellersApiFp = function (configuration) {
106
104
  };
107
105
  /**
108
106
  * SellersApi - factory interface
109
- * @export
110
107
  */
111
108
  export const SellersApiFactory = function (configuration, basePath, axios) {
112
109
  const localVarFp = SellersApiFp(configuration);
@@ -131,16 +128,12 @@ export const SellersApiFactory = function (configuration, basePath, axios) {
131
128
  };
132
129
  /**
133
130
  * SellersApi - object-oriented interface
134
- * @export
135
- * @class SellersApi
136
- * @extends {BaseAPI}
137
131
  */
138
132
  export class SellersApi extends BaseAPI {
139
133
  /**
140
134
  * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
141
135
  * @param {*} [options] Override http request option.
142
136
  * @throws {RequiredError}
143
- * @memberof SellersApi
144
137
  */
145
138
  getAccount(options) {
146
139
  return SellersApiFp(this.configuration).getAccount(options).then((request) => request(this.axios, this.basePath));
@@ -149,7 +142,6 @@ export class SellersApi extends BaseAPI {
149
142
  * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
150
143
  * @param {*} [options] Override http request option.
151
144
  * @throws {RequiredError}
152
- * @memberof SellersApi
153
145
  */
154
146
  getMarketplaceParticipations(options) {
155
147
  return SellersApiFp(this.configuration).getMarketplaceParticipations(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 { GetAccountResponse } from '../models';
17
17
  import type { GetMarketplaceParticipationsResponse } from '../models';
18
18
  /**
19
19
  * SellersApi - axios parameter creator
20
- * @export
21
20
  */
22
21
  export declare const SellersApiAxiosParamCreator: (configuration?: Configuration) => {
23
22
  /**
@@ -35,7 +34,6 @@ export declare const SellersApiAxiosParamCreator: (configuration?: Configuration
35
34
  };
36
35
  /**
37
36
  * SellersApi - functional programming interface
38
- * @export
39
37
  */
40
38
  export declare const SellersApiFp: (configuration?: Configuration) => {
41
39
  /**
@@ -53,7 +51,6 @@ export declare const SellersApiFp: (configuration?: Configuration) => {
53
51
  };
54
52
  /**
55
53
  * SellersApi - factory interface
56
- * @export
57
54
  */
58
55
  export declare const SellersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
59
56
  /**
@@ -71,23 +68,18 @@ export declare const SellersApiFactory: (configuration?: Configuration, basePath
71
68
  };
72
69
  /**
73
70
  * SellersApi - object-oriented interface
74
- * @export
75
- * @class SellersApi
76
- * @extends {BaseAPI}
77
71
  */
78
72
  export declare class SellersApi extends BaseAPI {
79
73
  /**
80
74
  * Returns information about a seller account and its marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
81
75
  * @param {*} [options] Override http request option.
82
76
  * @throws {RequiredError}
83
- * @memberof SellersApi
84
77
  */
85
78
  getAccount(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetAccountResponse, any>>;
86
79
  /**
87
80
  * Returns a list of marketplaces where the seller can list items and information about the seller\'s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.016 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
88
81
  * @param {*} [options] Override http request option.
89
82
  * @throws {RequiredError}
90
- * @memberof SellersApi
91
83
  */
92
84
  getMarketplaceParticipations(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetMarketplaceParticipationsResponse, any>>;
93
85
  }
@@ -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
  /**
@@ -14,39 +14,21 @@ import type { MarketplaceParticipation } from './marketplace-participation';
14
14
  import type { PrimaryContact } from './primary-contact';
15
15
  /**
16
16
  * The response schema for the `getAccount` operation.
17
- * @export
18
- * @interface Account
19
17
  */
20
18
  export interface Account {
21
19
  /**
22
20
  * List of marketplace participations.
23
- * @type {Array<MarketplaceParticipation>}
24
- * @memberof Account
25
21
  */
26
22
  'marketplaceParticipationList': Array<MarketplaceParticipation>;
27
23
  /**
28
24
  * The type of business registered for the seller account.
29
- * @type {string}
30
- * @memberof Account
31
25
  */
32
26
  'businessType': AccountBusinessTypeEnum;
33
27
  /**
34
28
  * The selling plan details.
35
- * @type {string}
36
- * @memberof Account
37
29
  */
38
30
  'sellingPlan': AccountSellingPlanEnum;
39
- /**
40
- *
41
- * @type {Business}
42
- * @memberof Account
43
- */
44
31
  'business'?: Business;
45
- /**
46
- *
47
- * @type {PrimaryContact}
48
- * @memberof Account
49
- */
50
32
  'primaryContact'?: PrimaryContact;
51
33
  }
52
34
  export declare const AccountBusinessTypeEnum: {
@@ -11,44 +11,30 @@
11
11
  */
12
12
  /**
13
13
  * Represents an address
14
- * @export
15
- * @interface Address
16
14
  */
17
15
  export interface Address {
18
16
  /**
19
17
  * Street address information.
20
- * @type {string}
21
- * @memberof Address
22
18
  */
23
19
  'addressLine1': string;
24
20
  /**
25
21
  * Additional street address information.
26
- * @type {string}
27
- * @memberof Address
28
22
  */
29
23
  'addressLine2'?: string;
30
24
  /**
31
25
  * The country code in two-character ISO 3166-1 alpha-2 format.
32
- * @type {string}
33
- * @memberof Address
34
26
  */
35
27
  'countryCode': string;
36
28
  /**
37
29
  * The state or province code.
38
- * @type {string}
39
- * @memberof Address
40
30
  */
41
31
  'stateOrProvinceCode'?: string;
42
32
  /**
43
33
  * The city.
44
- * @type {string}
45
- * @memberof Address
46
34
  */
47
35
  'city'?: string;
48
36
  /**
49
37
  * The postal code.
50
- * @type {string}
51
- * @memberof Address
52
38
  */
53
39
  'postalCode'?: string;
54
40
  }
@@ -12,38 +12,23 @@
12
12
  import type { Address } from './address';
13
13
  /**
14
14
  * Information about the seller\'s business. Certain fields may be omitted depending on the seller\'s `businessType`.
15
- * @export
16
- * @interface Business
17
15
  */
18
16
  export interface Business {
19
17
  /**
20
18
  * The registered business name.
21
- * @type {string}
22
- * @memberof Business
23
19
  */
24
20
  'name': string;
25
- /**
26
- *
27
- * @type {Address}
28
- * @memberof Business
29
- */
30
21
  'registeredBusinessAddress': Address;
31
22
  /**
32
23
  * The seller\'s company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships.
33
- * @type {string}
34
- * @memberof Business
35
24
  */
36
25
  'companyRegistrationNumber'?: string;
37
26
  /**
38
27
  * The seller\'s company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships.
39
- * @type {string}
40
- * @memberof Business
41
28
  */
42
29
  'companyTaxIdentificationNumber'?: string;
43
30
  /**
44
31
  * The non-Latin script version of the registered business name, if applicable.
45
- * @type {string}
46
- * @memberof Business
47
32
  */
48
33
  'nonLatinName'?: string;
49
34
  }
@@ -12,20 +12,11 @@
12
12
  import type { Account } from './account';
13
13
  /**
14
14
  * The response schema for the `getAccount` operation.
15
- * @export
16
- * @interface GetAccountResponse
17
15
  */
18
16
  export interface GetAccountResponse {
19
- /**
20
- *
21
- * @type {Account}
22
- * @memberof GetAccountResponse
23
- */
24
17
  'payload'?: Account;
25
18
  /**
26
19
  * A list of error responses returned when a request is unsuccessful.
27
- * @type {Array<Error>}
28
- * @memberof GetAccountResponse
29
20
  */
30
21
  'errors'?: Array<Error>;
31
22
  }
@@ -12,20 +12,14 @@
12
12
  import type { MarketplaceParticipation } from './marketplace-participation';
13
13
  /**
14
14
  * The response schema for the `getMarketplaceParticipations` operation.
15
- * @export
16
- * @interface GetMarketplaceParticipationsResponse
17
15
  */
18
16
  export interface GetMarketplaceParticipationsResponse {
19
17
  /**
20
18
  * List of marketplace participations.
21
- * @type {Array<MarketplaceParticipation>}
22
- * @memberof GetMarketplaceParticipationsResponse
23
19
  */
24
20
  'payload'?: Array<MarketplaceParticipation>;
25
21
  /**
26
22
  * A list of error responses returned when a request is unsuccessful.
27
- * @type {Array<Error>}
28
- * @memberof GetMarketplaceParticipationsResponse
29
23
  */
30
24
  'errors'?: Array<Error>;
31
25
  }
@@ -11,28 +11,11 @@
11
11
  */
12
12
  import type { Marketplace } from './marketplace';
13
13
  import type { Participation } from './participation';
14
- /**
15
- *
16
- * @export
17
- * @interface MarketplaceParticipation
18
- */
19
14
  export interface MarketplaceParticipation {
20
- /**
21
- *
22
- * @type {Marketplace}
23
- * @memberof MarketplaceParticipation
24
- */
25
15
  'marketplace': Marketplace;
26
- /**
27
- *
28
- * @type {Participation}
29
- * @memberof MarketplaceParticipation
30
- */
31
16
  'participation': Participation;
32
17
  /**
33
18
  * The name of the seller\'s store as displayed in the marketplace.
34
- * @type {string}
35
- * @memberof MarketplaceParticipation
36
19
  */
37
20
  'storeName': string;
38
21
  }
@@ -11,44 +11,30 @@
11
11
  */
12
12
  /**
13
13
  * Information about an Amazon marketplace where a seller can list items and customers can view and purchase items.
14
- * @export
15
- * @interface Marketplace
16
14
  */
17
15
  export interface Marketplace {
18
16
  /**
19
17
  * The encrypted marketplace value.
20
- * @type {string}
21
- * @memberof Marketplace
22
18
  */
23
19
  'id': string;
24
20
  /**
25
21
  * The marketplace name.
26
- * @type {string}
27
- * @memberof Marketplace
28
22
  */
29
23
  'name': string;
30
24
  /**
31
25
  * The ISO 3166-1 alpha-2 format country code of the marketplace.
32
- * @type {string}
33
- * @memberof Marketplace
34
26
  */
35
27
  'countryCode': string;
36
28
  /**
37
29
  * The ISO 4217 format currency code of the marketplace.
38
- * @type {string}
39
- * @memberof Marketplace
40
30
  */
41
31
  'defaultCurrencyCode': string;
42
32
  /**
43
33
  * The ISO 639-1 format language code of the marketplace.
44
- * @type {string}
45
- * @memberof Marketplace
46
34
  */
47
35
  'defaultLanguageCode': string;
48
36
  /**
49
37
  * The domain name of the marketplace.
50
- * @type {string}
51
- * @memberof Marketplace
52
38
  */
53
39
  'domainName': string;
54
40
  }
@@ -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 in a human-readable form.
26
- * @type {string}
27
- * @memberof ModelError
28
22
  */
29
23
  'message': string;
30
24
  /**
31
25
  * Additional details that can help you 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
  * Information that is specific to a seller in a marketplace.
14
- * @export
15
- * @interface Participation
16
14
  */
17
15
  export interface Participation {
18
16
  /**
19
17
  * If `true`, the seller participates in the marketplace. Otherwise `false`.
20
- * @type {boolean}
21
- * @memberof Participation
22
18
  */
23
19
  'isParticipating': boolean;
24
20
  /**
25
21
  * Specifies if the seller has suspended listings. `true` if the seller Listing Status is set to Inactive, otherwise `false`.
26
- * @type {boolean}
27
- * @memberof Participation
28
22
  */
29
23
  'hasSuspendedListings': boolean;
30
24
  }
@@ -12,26 +12,15 @@
12
12
  import type { Address } from './address';
13
13
  /**
14
14
  * Information about the seller\'s primary contact.
15
- * @export
16
- * @interface PrimaryContact
17
15
  */
18
16
  export interface PrimaryContact {
19
17
  /**
20
18
  * The full name of the seller\'s primary contact.
21
- * @type {string}
22
- * @memberof PrimaryContact
23
19
  */
24
20
  'name': string;
25
- /**
26
- *
27
- * @type {Address}
28
- * @memberof PrimaryContact
29
- */
30
21
  'address': Address;
31
22
  /**
32
23
  * The non-Latin script version of the primary contact\'s name, if applicable.
33
- * @type {string}
34
- * @memberof PrimaryContact
35
24
  */
36
25
  'nonLatinName'?: string;
37
26
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/sellers-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Sellers (Sellers API) provides essential information about seller accounts, such as: The marketplaces a seller can list in The default language and currency of a marketplace Whether the seller has suspended listings Refer to the Sellers API reference for details about this API's operations, data types, and schemas.",
5
- "version": "4.1.3",
5
+ "version": "4.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.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
  "sellers 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
  }