@sp-api-sdk/vendor-transaction-status-api-v1 4.0.1 → 4.0.3

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
  * VendorTransactionStatusApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  const VendorTransactionStatusApiAxiosParamCreator = function (configuration) {
31
30
  return {
@@ -62,7 +61,6 @@ const VendorTransactionStatusApiAxiosParamCreator = function (configuration) {
62
61
  exports.VendorTransactionStatusApiAxiosParamCreator = VendorTransactionStatusApiAxiosParamCreator;
63
62
  /**
64
63
  * VendorTransactionStatusApi - functional programming interface
65
- * @export
66
64
  */
67
65
  const VendorTransactionStatusApiFp = function (configuration) {
68
66
  const localVarAxiosParamCreator = (0, exports.VendorTransactionStatusApiAxiosParamCreator)(configuration);
@@ -84,7 +82,6 @@ const VendorTransactionStatusApiFp = function (configuration) {
84
82
  exports.VendorTransactionStatusApiFp = VendorTransactionStatusApiFp;
85
83
  /**
86
84
  * VendorTransactionStatusApi - factory interface
87
- * @export
88
85
  */
89
86
  const VendorTransactionStatusApiFactory = function (configuration, basePath, axios) {
90
87
  const localVarFp = (0, exports.VendorTransactionStatusApiFp)(configuration);
@@ -103,9 +100,6 @@ const VendorTransactionStatusApiFactory = function (configuration, basePath, axi
103
100
  exports.VendorTransactionStatusApiFactory = VendorTransactionStatusApiFactory;
104
101
  /**
105
102
  * VendorTransactionStatusApi - object-oriented interface
106
- * @export
107
- * @class VendorTransactionStatusApi
108
- * @extends {BaseAPI}
109
103
  */
110
104
  class VendorTransactionStatusApi extends base_1.BaseAPI {
111
105
  /**
@@ -113,7 +107,6 @@ class VendorTransactionStatusApi extends base_1.BaseAPI {
113
107
  * @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
114
108
  * @param {*} [options] Override http request option.
115
109
  * @throws {RequiredError}
116
- * @memberof VendorTransactionStatusApi
117
110
  */
118
111
  getTransaction(requestParameters, options) {
119
112
  return (0, exports.VendorTransactionStatusApiFp)(this.configuration).getTransaction(requestParameters.transactionId, options).then((request) => request(this.axios, this.basePath));
@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
22
- /**
23
- *
24
- * @export
25
- */
26
22
  exports.COLLECTION_FORMATS = {
27
23
  csv: ",",
28
24
  ssv: " ",
29
25
  tsv: "\t",
30
26
  pipes: "|",
31
27
  };
32
- /**
33
- *
34
- * @export
35
- * @class BaseAPI
36
- */
37
28
  class BaseAPI {
38
29
  basePath;
39
30
  axios;
@@ -49,12 +40,6 @@ class BaseAPI {
49
40
  }
50
41
  exports.BaseAPI = BaseAPI;
51
42
  ;
52
- /**
53
- *
54
- * @export
55
- * @class RequiredError
56
- * @extends {Error}
57
- */
58
43
  class RequiredError extends Error {
59
44
  field;
60
45
  constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
64
49
  }
65
50
  }
66
51
  exports.RequiredError = RequiredError;
67
- /**
68
- *
69
- * @export
70
- */
71
52
  exports.operationServerMap = {};
@@ -15,15 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
17
17
  const base_1 = require("./base");
18
- /**
19
- *
20
- * @export
21
- */
22
18
  exports.DUMMY_BASE_URL = 'https://example.com';
23
19
  /**
24
20
  *
25
21
  * @throws {RequiredError}
26
- * @export
27
22
  */
28
23
  const assertParamExists = function (functionName, paramName, paramValue) {
29
24
  if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
31
26
  }
32
27
  };
33
28
  exports.assertParamExists = assertParamExists;
34
- /**
35
- *
36
- * @export
37
- */
38
29
  const setApiKeyToObject = async function (object, keyParamName, configuration) {
39
30
  if (configuration && configuration.apiKey) {
40
31
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
44
35
  }
45
36
  };
46
37
  exports.setApiKeyToObject = setApiKeyToObject;
47
- /**
48
- *
49
- * @export
50
- */
51
38
  const setBasicAuthToObject = function (object, configuration) {
52
39
  if (configuration && (configuration.username || configuration.password)) {
53
40
  object["auth"] = { username: configuration.username, password: configuration.password };
54
41
  }
55
42
  };
56
43
  exports.setBasicAuthToObject = setBasicAuthToObject;
57
- /**
58
- *
59
- * @export
60
- */
61
44
  const setBearerAuthToObject = async function (object, configuration) {
62
45
  if (configuration && configuration.accessToken) {
63
46
  const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
67
50
  }
68
51
  };
69
52
  exports.setBearerAuthToObject = setBearerAuthToObject;
70
- /**
71
- *
72
- * @export
73
- */
74
53
  const setOAuthToObject = async function (object, name, scopes, configuration) {
75
54
  if (configuration && configuration.accessToken) {
76
55
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
100
79
  }
101
80
  }
102
81
  }
103
- /**
104
- *
105
- * @export
106
- */
107
82
  const setSearchParams = function (url, ...objects) {
108
83
  const searchParams = new URLSearchParams(url.search);
109
84
  setFlattenedQueryParams(searchParams, objects);
110
85
  url.search = searchParams.toString();
111
86
  };
112
87
  exports.setSearchParams = setSearchParams;
113
- /**
114
- *
115
- * @export
116
- */
117
88
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
118
89
  const nonString = typeof value !== 'string';
119
90
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
124
95
  : (value || "");
125
96
  };
126
97
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
127
- /**
128
- *
129
- * @export
130
- */
131
98
  const toPathString = function (url) {
132
99
  return url.pathname + url.search + url.hash;
133
100
  };
134
101
  exports.toPathString = toPathString;
135
- /**
136
- *
137
- * @export
138
- */
139
102
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
140
103
  return (axios = globalAxios, basePath = BASE_PATH) => {
141
104
  const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
@@ -18,49 +18,32 @@ class Configuration {
18
18
  /**
19
19
  * parameter for apiKey security
20
20
  * @param name security name
21
- * @memberof Configuration
22
21
  */
23
22
  apiKey;
24
23
  /**
25
24
  * parameter for basic security
26
- *
27
- * @type {string}
28
- * @memberof Configuration
29
25
  */
30
26
  username;
31
27
  /**
32
28
  * parameter for basic security
33
- *
34
- * @type {string}
35
- * @memberof Configuration
36
29
  */
37
30
  password;
38
31
  /**
39
32
  * parameter for oauth2 security
40
33
  * @param name security name
41
34
  * @param scopes oauth2 scope
42
- * @memberof Configuration
43
35
  */
44
36
  accessToken;
45
37
  /**
46
38
  * override base path
47
- *
48
- * @type {string}
49
- * @memberof Configuration
50
39
  */
51
40
  basePath;
52
41
  /**
53
42
  * override server index
54
- *
55
- * @type {number}
56
- * @memberof Configuration
57
43
  */
58
44
  serverIndex;
59
45
  /**
60
46
  * base options for axios calls
61
- *
62
- * @type {any}
63
- * @memberof Configuration
64
47
  */
65
48
  baseOptions;
66
49
  /**
@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
19
19
  import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
20
20
  /**
21
21
  * VendorTransactionStatusApi - axios parameter creator
22
- * @export
23
22
  */
24
23
  export const VendorTransactionStatusApiAxiosParamCreator = function (configuration) {
25
24
  return {
@@ -55,7 +54,6 @@ export const VendorTransactionStatusApiAxiosParamCreator = function (configurati
55
54
  };
56
55
  /**
57
56
  * VendorTransactionStatusApi - functional programming interface
58
- * @export
59
57
  */
60
58
  export const VendorTransactionStatusApiFp = function (configuration) {
61
59
  const localVarAxiosParamCreator = VendorTransactionStatusApiAxiosParamCreator(configuration);
@@ -76,7 +74,6 @@ export const VendorTransactionStatusApiFp = function (configuration) {
76
74
  };
77
75
  /**
78
76
  * VendorTransactionStatusApi - factory interface
79
- * @export
80
77
  */
81
78
  export const VendorTransactionStatusApiFactory = function (configuration, basePath, axios) {
82
79
  const localVarFp = VendorTransactionStatusApiFp(configuration);
@@ -94,9 +91,6 @@ export const VendorTransactionStatusApiFactory = function (configuration, basePa
94
91
  };
95
92
  /**
96
93
  * VendorTransactionStatusApi - object-oriented interface
97
- * @export
98
- * @class VendorTransactionStatusApi
99
- * @extends {BaseAPI}
100
94
  */
101
95
  export class VendorTransactionStatusApi extends BaseAPI {
102
96
  /**
@@ -104,7 +98,6 @@ export class VendorTransactionStatusApi extends BaseAPI {
104
98
  * @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
105
99
  * @param {*} [options] Override http request option.
106
100
  * @throws {RequiredError}
107
- * @memberof VendorTransactionStatusApi
108
101
  */
109
102
  getTransaction(requestParameters, options) {
110
103
  return VendorTransactionStatusApiFp(this.configuration).getTransaction(requestParameters.transactionId, 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
  /**
@@ -16,7 +16,6 @@ import { type RequestArgs, BaseAPI } from '../base';
16
16
  import type { GetTransactionResponse } from '../models';
17
17
  /**
18
18
  * VendorTransactionStatusApi - axios parameter creator
19
- * @export
20
19
  */
21
20
  export declare const VendorTransactionStatusApiAxiosParamCreator: (configuration?: Configuration) => {
22
21
  /**
@@ -29,7 +28,6 @@ export declare const VendorTransactionStatusApiAxiosParamCreator: (configuration
29
28
  };
30
29
  /**
31
30
  * VendorTransactionStatusApi - functional programming interface
32
- * @export
33
31
  */
34
32
  export declare const VendorTransactionStatusApiFp: (configuration?: Configuration) => {
35
33
  /**
@@ -42,7 +40,6 @@ export declare const VendorTransactionStatusApiFp: (configuration?: Configuratio
42
40
  };
43
41
  /**
44
42
  * VendorTransactionStatusApi - factory interface
45
- * @export
46
43
  */
47
44
  export declare const VendorTransactionStatusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
48
45
  /**
@@ -55,22 +52,15 @@ export declare const VendorTransactionStatusApiFactory: (configuration?: Configu
55
52
  };
56
53
  /**
57
54
  * Request parameters for getTransaction operation in VendorTransactionStatusApi.
58
- * @export
59
- * @interface VendorTransactionStatusApiGetTransactionRequest
60
55
  */
61
56
  export interface VendorTransactionStatusApiGetTransactionRequest {
62
57
  /**
63
58
  * The GUID provided by Amazon in the \'transactionId\' field in response to the post request of a specific transaction.
64
- * @type {string}
65
- * @memberof VendorTransactionStatusApiGetTransaction
66
59
  */
67
60
  readonly transactionId: string;
68
61
  }
69
62
  /**
70
63
  * VendorTransactionStatusApi - object-oriented interface
71
- * @export
72
- * @class VendorTransactionStatusApi
73
- * @extends {BaseAPI}
74
64
  */
75
65
  export declare class VendorTransactionStatusApi extends BaseAPI {
76
66
  /**
@@ -78,7 +68,6 @@ export declare class VendorTransactionStatusApi extends BaseAPI {
78
68
  * @param {VendorTransactionStatusApiGetTransactionRequest} requestParameters Request parameters.
79
69
  * @param {*} [options] Override http request option.
80
70
  * @throws {RequiredError}
81
- * @memberof VendorTransactionStatusApi
82
71
  */
83
72
  getTransaction(requestParameters: VendorTransactionStatusApiGetTransactionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetTransactionResponse, any>>;
84
73
  }
@@ -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
  /**
@@ -12,20 +12,11 @@
12
12
  import type { TransactionStatus } from './transaction-status';
13
13
  /**
14
14
  * The response schema for the getTransaction operation.
15
- * @export
16
- * @interface GetTransactionResponse
17
15
  */
18
16
  export interface GetTransactionResponse {
19
- /**
20
- *
21
- * @type {TransactionStatus}
22
- * @memberof GetTransactionResponse
23
- */
24
17
  'payload'?: TransactionStatus;
25
18
  /**
26
19
  * A list of error responses returned when a request is unsuccessful.
27
- * @type {Array<Error>}
28
- * @memberof GetTransactionResponse
29
20
  */
30
21
  'errors'?: Array<Error>;
31
22
  }
@@ -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
  }
@@ -12,14 +12,7 @@
12
12
  import type { Transaction } from './transaction';
13
13
  /**
14
14
  * Represents the status of a transaction.
15
- * @export
16
- * @interface TransactionStatus
17
15
  */
18
16
  export interface TransactionStatus {
19
- /**
20
- *
21
- * @type {Transaction}
22
- * @memberof TransactionStatus
23
- */
24
17
  'transactionStatus'?: Transaction;
25
18
  }
@@ -11,26 +11,18 @@
11
11
  */
12
12
  /**
13
13
  * The transaction status.
14
- * @export
15
- * @interface Transaction
16
14
  */
17
15
  export interface Transaction {
18
16
  /**
19
17
  * The unique identifier returned in the \'transactionId\' field in response to the post request of a specific transaction.
20
- * @type {string}
21
- * @memberof Transaction
22
18
  */
23
19
  'transactionId': string;
24
20
  /**
25
21
  * Current processing status of the transaction.
26
- * @type {string}
27
- * @memberof Transaction
28
22
  */
29
23
  'status': TransactionStatusEnum;
30
24
  /**
31
25
  * A list of error responses returned when a request is unsuccessful.
32
- * @type {Array<Error>}
33
- * @memberof Transaction
34
26
  */
35
27
  'errors'?: Array<Error>;
36
28
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vendor-transaction-status-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.",
5
- "version": "4.0.1",
5
+ "version": "4.0.3",
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
  "vendor transaction status 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
  }