@sp-api-sdk/sales-api-v1 3.1.0 → 3.1.1

package/dist/cjs/api-model/api/sales-api.js

@@ -25,7 +25,6 @@ const common_1 = require("../common");
 const base_1 = require("../base");
 /**
  * SalesApi - axios parameter creator
- * @export
  */
 const SalesApiAxiosParamCreator = function (configuration) {
     return {
@@ -104,7 +103,6 @@ const SalesApiAxiosParamCreator = function (configuration) {
 exports.SalesApiAxiosParamCreator = SalesApiAxiosParamCreator;
 /**
  * SalesApi - functional programming interface
- * @export
  */
 const SalesApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.SalesApiAxiosParamCreator)(configuration);
@@ -135,7 +133,6 @@ const SalesApiFp = function (configuration) {
 exports.SalesApiFp = SalesApiFp;
 /**
  * SalesApi - factory interface
- * @export
  */
 const SalesApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.SalesApiFp)(configuration);
@@ -154,9 +151,6 @@ const SalesApiFactory = function (configuration, basePath, axios) {
 exports.SalesApiFactory = SalesApiFactory;
 /**
  * SalesApi - object-oriented interface
- * @export
- * @class SalesApi
- * @extends {BaseAPI}
  */
 class SalesApi extends base_1.BaseAPI {
     /**
@@ -164,16 +158,12 @@ class SalesApi extends base_1.BaseAPI {
      * @param {SalesApiGetOrderMetricsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SalesApi
      */
     getOrderMetrics(requestParameters, options) {
         return (0, exports.SalesApiFp)(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.SalesApi = SalesApi;
-/**
- * @export
- */
 exports.GetOrderMetricsGranularityEnum = {
     Hour: 'Hour',
     Day: 'Day',
@@ -182,24 +172,15 @@ exports.GetOrderMetricsGranularityEnum = {
     Year: 'Year',
     Total: 'Total'
 };
-/**
- * @export
- */
 exports.GetOrderMetricsBuyerTypeEnum = {
     B2B: 'B2B',
     B2C: 'B2C',
     All: 'All'
 };
-/**
- * @export
- */
 exports.GetOrderMetricsFirstDayOfWeekEnum = {
     Monday: 'Monday',
     Sunday: 'Sunday'
 };
-/**
- * @export
- */
 exports.GetOrderMetricsAmazonProgramEnum = {
     AmazonHaul: 'AmazonHaul'
 };

package/dist/cjs/api-model/base.js

@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     basePath;
     axios;
@@ -49,12 +40,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/dist/cjs/api-model/common.js

@@ -15,15 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
     }
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
     }
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
 exports.setSearchParams = setSearchParams;
-/**
- *
- * @export
- */
 const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/cjs/api-model/configuration.js

@@ -18,49 +18,32 @@ class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/es/api-model/api/sales-api.js

@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
 /**
  * SalesApi - axios parameter creator
- * @export
  */
 export const SalesApiAxiosParamCreator = function (configuration) {
     return {
@@ -97,7 +96,6 @@ export const SalesApiAxiosParamCreator = function (configuration) {
 };
 /**
  * SalesApi - functional programming interface
- * @export
  */
 export const SalesApiFp = function (configuration) {
     const localVarAxiosParamCreator = SalesApiAxiosParamCreator(configuration);
@@ -127,7 +125,6 @@ export const SalesApiFp = function (configuration) {
 };
 /**
  * SalesApi - factory interface
- * @export
  */
 export const SalesApiFactory = function (configuration, basePath, axios) {
     const localVarFp = SalesApiFp(configuration);
@@ -145,9 +142,6 @@ export const SalesApiFactory = function (configuration, basePath, axios) {
 };
 /**
  * SalesApi - object-oriented interface
- * @export
- * @class SalesApi
- * @extends {BaseAPI}
  */
 export class SalesApi extends BaseAPI {
     /**
@@ -155,15 +149,11 @@ export class SalesApi extends BaseAPI {
      * @param {SalesApiGetOrderMetricsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SalesApi
      */
     getOrderMetrics(requestParameters, options) {
         return SalesApiFp(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(this.axios, this.basePath));
     }
 }
-/**
- * @export
- */
 export const GetOrderMetricsGranularityEnum = {
     Hour: 'Hour',
     Day: 'Day',
@@ -172,24 +162,15 @@ export const GetOrderMetricsGranularityEnum = {
     Year: 'Year',
     Total: 'Total'
 };
-/**
- * @export
- */
 export const GetOrderMetricsBuyerTypeEnum = {
     B2B: 'B2B',
     B2C: 'B2C',
     All: 'All'
 };
-/**
- * @export
- */
 export const GetOrderMetricsFirstDayOfWeekEnum = {
     Monday: 'Monday',
     Sunday: 'Sunday'
 };
-/**
- * @export
- */
 export const GetOrderMetricsAmazonProgramEnum = {
     AmazonHaul: 'AmazonHaul'
 };

package/dist/es/api-model/base.js

@@ -13,21 +13,12 @@
  */
 import globalAxios from 'axios';
 export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     basePath;
     axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
     }
 }
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
         this.name = "RequiredError";
     }
 }
-/**
- *
- * @export
- */
 export const operationServerMap = {};

package/dist/es/api-model/common.js

@@ -12,25 +12,16 @@
  * Do not edit the class manually.
  */
 import { RequiredError } from "./base";
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
         throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
     }
 };
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
         object[keyParamName] = localVarApiKeyValue;
     }
 };
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
         object["Authorization"] = "Bearer " + accessToken;
     }
 };
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 export const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
-/**
- *
- * @export
- */
 export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
         ? JSON.stringify(value !== undefined ? value : {})
         : (value || "");
 };
-/**
- *
- * @export
- */
 export const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/es/api-model/configuration.js

@@ -15,49 +15,32 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/types/api-model/api/sales-api.d.ts

@@ -16,7 +16,6 @@ import { type RequestArgs, BaseAPI } from '../base';
 import type { GetOrderMetricsResponse } from '../models';
 /**
  * SalesApi - axios parameter creator
- * @export
  */
 export declare const SalesApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -38,7 +37,6 @@ export declare const SalesApiAxiosParamCreator: (configuration?: Configuration)
 };
 /**
  * SalesApi - functional programming interface
- * @export
  */
 export declare const SalesApiFp: (configuration?: Configuration) => {
     /**
@@ -60,7 +58,6 @@ export declare const SalesApiFp: (configuration?: Configuration) => {
 };
 /**
  * SalesApi - factory interface
- * @export
  */
 export declare const SalesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -73,76 +70,51 @@ export declare const SalesApiFactory: (configuration?: Configuration, basePath?:
 };
 /**
  * Request parameters for getOrderMetrics operation in SalesApi.
- * @export
- * @interface SalesApiGetOrderMetricsRequest
  */
 export interface SalesApiGetOrderMetricsRequest {
     /**
      * A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.  For example, ATVPDKIKX0DER indicates the US marketplace.
-     * @type {Array<string>}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly marketplaceIds: Array<string>;
     /**
      * A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.
-     * @type {string}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly interval: string;
     /**
      * The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity&#x3D;Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity&#x3D;Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone.
-     * @type {'Hour' | 'Day' | 'Week' | 'Month' | 'Year' | 'Total'}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly granularity: GetOrderMetricsGranularityEnum;
     /**
      * An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone.
-     * @type {string}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly granularityTimeZone?: string;
     /**
      * Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers.
-     * @type {'B2B' | 'B2C' | 'All'}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly buyerType?: GetOrderMetricsBuyerTypeEnum;
     /**
      * Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network.
-     * @type {string}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly fulfillmentNetwork?: string;
     /**
      * Specifies the day that the week starts on when granularity&#x3D;Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
-     * @type {'Monday' | 'Sunday'}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum;
     /**
      * Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
-     * @type {string}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly asin?: string;
     /**
      * Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
-     * @type {string}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly sku?: string;
     /**
      * Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
-     * @type {'AmazonHaul'}
-     * @memberof SalesApiGetOrderMetrics
      */
     readonly amazonProgram?: GetOrderMetricsAmazonProgramEnum;
 }
 /**
  * SalesApi - object-oriented interface
- * @export
- * @class SalesApi
- * @extends {BaseAPI}
  */
 export declare class SalesApi extends BaseAPI {
     /**
@@ -150,13 +122,9 @@ export declare class SalesApi extends BaseAPI {
      * @param {SalesApiGetOrderMetricsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SalesApi
      */
     getOrderMetrics(requestParameters: SalesApiGetOrderMetricsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderMetricsResponse, any>>;
 }
-/**
- * @export
- */
 export declare const GetOrderMetricsGranularityEnum: {
     readonly Hour: "Hour";
     readonly Day: "Day";
@@ -166,26 +134,17 @@ export declare const GetOrderMetricsGranularityEnum: {
     readonly Total: "Total";
 };
 export type GetOrderMetricsGranularityEnum = typeof GetOrderMetricsGranularityEnum[keyof typeof GetOrderMetricsGranularityEnum];
-/**
- * @export
- */
 export declare const GetOrderMetricsBuyerTypeEnum: {
     readonly B2B: "B2B";
     readonly B2C: "B2C";
     readonly All: "All";
 };
 export type GetOrderMetricsBuyerTypeEnum = typeof GetOrderMetricsBuyerTypeEnum[keyof typeof GetOrderMetricsBuyerTypeEnum];
-/**
- * @export
- */
 export declare const GetOrderMetricsFirstDayOfWeekEnum: {
     readonly Monday: "Monday";
     readonly Sunday: "Sunday";
 };
 export type GetOrderMetricsFirstDayOfWeekEnum = typeof GetOrderMetricsFirstDayOfWeekEnum[keyof typeof GetOrderMetricsFirstDayOfWeekEnum];
-/**
- * @export
- */
 export declare const GetOrderMetricsAmazonProgramEnum: {
     readonly AmazonHaul: "AmazonHaul";
 };

package/dist/types/api-model/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/types/api-model/common.d.ts

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/configuration.d.ts

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/dist/types/api-model/models/get-order-metrics-response.d.ts

@@ -12,20 +12,14 @@
 import type { OrderMetricsInterval } from './order-metrics-interval';
 /**
  * The response schema for the getOrderMetrics operation.
- * @export
- * @interface GetOrderMetricsResponse
  */
 export interface GetOrderMetricsResponse {
     /**
      * A set of order metrics, each scoped to a particular time interval.
-     * @type {Array<OrderMetricsInterval>}
-     * @memberof GetOrderMetricsResponse
      */
     'payload'?: Array<OrderMetricsInterval>;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetOrderMetricsResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/model-error.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occured.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition in a human-readable form.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

package/dist/types/api-model/models/money.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The currency type and the amount.
- * @export
- * @interface Money
  */
 export interface Money {
     /**
      * Three-digit currency code. In ISO 4217 format.
-     * @type {string}
-     * @memberof Money
      */
     'currencyCode': string;
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unnaceptable, as with currencies. Follows RFC7159 for number representation.
-     * @type {string}
-     * @memberof Money
      */
     'amount': string;
 }

package/dist/types/api-model/models/order-metrics-interval.d.ts

@@ -12,44 +12,24 @@
 import type { Money } from './money';
 /**
  * Contains order metrics.
- * @export
- * @interface OrderMetricsInterval
  */
 export interface OrderMetricsInterval {
     /**
      * The interval of time based on requested granularity (ex. Hour, Day, etc.) If this is the first or the last interval from the list, it might contain incomplete data if the requested interval doesn\'t align with the requested granularity (ex. request interval 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z and granularity day will result in Sept 1st UTC day and Sept 4th UTC days having partial data).
-     * @type {string}
-     * @memberof OrderMetricsInterval
      */
     'interval': string;
     /**
      * The number of units in orders based on the specified filters.
-     * @type {number}
-     * @memberof OrderMetricsInterval
      */
     'unitCount': number;
     /**
      * The number of order items based on the specified filters.
-     * @type {number}
-     * @memberof OrderMetricsInterval
      */
     'orderItemCount': number;
     /**
      * The number of orders based on the specified filters.
-     * @type {number}
-     * @memberof OrderMetricsInterval
      */
     'orderCount': number;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderMetricsInterval
-     */
     'averageUnitPrice': Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderMetricsInterval
-     */
     'totalSales': Money;
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/sales-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Sales provides APIs related to sales performance.",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.1.15",
-    "axios": "^1.10.0"
+    "@sp-api-sdk/common": "2.1.16",
+    "axios": "^1.11.0"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,26 @@
     "sp sdk",
     "sales api"
   ],
-  "gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
+  "xo": {
+    "extends": [
+      "xo-bizon"
+    ],
+    "settings": {
+      "import/internal-regex": "^@sp-api-sdk/"
+    },
+    "semicolon": false,
+    "space": 2,
+    "prettier": true,
+    "ignores": [
+      "src/api-model/**"
+    ],
+    "rules": {
+      "unicorn/prevent-abbreviations": "off"
+    }
+  },
+  "prettier": {
+    "printWidth": 100,
+    "jsxSingleQuote": true
+  },
+  "gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
 }