@sp-api-sdk/fba-inbound-eligibility-api-v1 2.0.6 → 2.1.0

package/dist/cjs/src/api-model/api/fba-inbound-api.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FbaInboundApi = exports.FbaInboundApiFactory = exports.FbaInboundApiFp = exports.FbaInboundApiAxiosParamCreator = void 0;
+exports.GetItemEligibilityPreviewProgramEnum = exports.FbaInboundApi = exports.FbaInboundApiFactory = exports.FbaInboundApiFp = exports.FbaInboundApiAxiosParamCreator = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -32,7 +32,7 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
         /**
          * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
          * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-         * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+         * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
          * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -82,14 +82,16 @@ const FbaInboundApiFp = function (configuration) {
         /**
          * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
          * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-         * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+         * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
          * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         async getItemEligibilityPreview(asin, program, marketplaceIds, options) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getItemEligibilityPreview(asin, program, marketplaceIds, options);
-            return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.getItemEligibilityPreview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     };
 };
@@ -132,3 +134,10 @@ class FbaInboundApi extends base_1.BaseAPI {
     }
 }
 exports.FbaInboundApi = FbaInboundApi;
+/**
+ * @export
+ */
+exports.GetItemEligibilityPreviewProgramEnum = {
+    Inbound: 'INBOUND',
+    Commingling: 'COMMINGLING'
+};

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

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
+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(/\/+$/, "");
 /**
@@ -43,7 +43,7 @@ class BaseAPI {
         this.axios = axios;
         if (configuration) {
             this.configuration = configuration;
-            this.basePath = configuration.basePath || this.basePath;
+            this.basePath = configuration.basePath ?? basePath;
         }
     }
 }
@@ -64,3 +64,8 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
+/**
+ *
+ * @export
+ */
+exports.operationServerMap = {};

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

@@ -138,7 +138,7 @@ exports.toPathString = toPathString;
  */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
-        const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url };
+        const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
         return axios.request(axiosRequestArgs);
     };
 };

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

@@ -49,6 +49,13 @@ class Configuration {
      * @memberof Configuration
      */
     basePath;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex;
     /**
      * base options for axios calls
      *
@@ -70,6 +77,7 @@ class Configuration {
         this.password = param.password;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
         this.baseOptions = param.baseOptions;
         this.formDataCtor = param.formDataCtor;
     }

package/dist/es/src/api-model/api/fba-inbound-api.js

@@ -16,7 +16,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
 /**
  * FbaInboundApi - axios parameter creator
  * @export
@@ -26,7 +26,7 @@ export const FbaInboundApiAxiosParamCreator = function (configuration) {
         /**
          * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
          * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-         * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+         * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
          * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -75,14 +75,16 @@ export const FbaInboundApiFp = function (configuration) {
         /**
          * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
          * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-         * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+         * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
          * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         async getItemEligibilityPreview(asin, program, marketplaceIds, options) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getItemEligibilityPreview(asin, program, marketplaceIds, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['FbaInboundApi.getItemEligibilityPreview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     };
 };
@@ -122,3 +124,10 @@ export class FbaInboundApi extends BaseAPI {
         return FbaInboundApiFp(this.configuration).getItemEligibilityPreview(requestParameters.asin, requestParameters.program, requestParameters.marketplaceIds, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * @export
+ */
+export const GetItemEligibilityPreviewProgramEnum = {
+    Inbound: 'INBOUND',
+    Commingling: 'COMMINGLING'
+};

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

@@ -37,7 +37,7 @@ export class BaseAPI {
         this.axios = axios;
         if (configuration) {
             this.configuration = configuration;
-            this.basePath = configuration.basePath || this.basePath;
+            this.basePath = configuration.basePath ?? basePath;
         }
     }
 }
@@ -56,3 +56,8 @@ export class RequiredError extends Error {
         this.name = "RequiredError";
     }
 }
+/**
+ *
+ * @export
+ */
+export const operationServerMap = {};

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

@@ -127,7 +127,7 @@ export const toPathString = function (url) {
  */
 export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
-        const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url };
+        const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
         return axios.request(axiosRequestArgs);
     };
 };

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

@@ -46,6 +46,13 @@ export class Configuration {
      * @memberof Configuration
      */
     basePath;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex;
     /**
      * base options for axios calls
      *
@@ -67,6 +74,7 @@ export class Configuration {
         this.password = param.password;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
         this.baseOptions = param.baseOptions;
         this.formDataCtor = param.formDataCtor;
     }

package/dist/types/src/api-model/api/fba-inbound-api.d.ts

@@ -10,10 +10,10 @@
  * Do not edit the class manually.
  */
 import type { Configuration } from '../configuration';
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import globalAxios from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
-import { GetItemEligibilityPreviewResponse } from '../models';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { GetItemEligibilityPreviewResponse } from '../models';
 /**
  * FbaInboundApi - axios parameter creator
  * @export
@@ -22,12 +22,12 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
     /**
      * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
      * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-     * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+     * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
      * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getItemEligibilityPreview: (asin: string, program: 'INBOUND' | 'COMMINGLING', marketplaceIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getItemEligibilityPreview: (asin: string, program: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * FbaInboundApi - functional programming interface
@@ -37,12 +37,12 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
     /**
      * This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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).
      * @param {string} asin The ASIN of the item for which you want an eligibility preview.
-     * @param {'INBOUND' | 'COMMINGLING'} program The program that you want to check eligibility against.
+     * @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
      * @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getItemEligibilityPreview(asin: string, program: 'INBOUND' | 'COMMINGLING', marketplaceIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetItemEligibilityPreviewResponse>>;
+    getItemEligibilityPreview(asin: string, program: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetItemEligibilityPreviewResponse>>;
 };
 /**
  * FbaInboundApi - factory interface
@@ -55,7 +55,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: AxiosRequestConfig): AxiosPromise<GetItemEligibilityPreviewResponse>;
+    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetItemEligibilityPreviewResponse>;
 };
 /**
  * Request parameters for getItemEligibilityPreview operation in FbaInboundApi.
@@ -74,7 +74,7 @@ export interface FbaInboundApiGetItemEligibilityPreviewRequest {
      * @type {'INBOUND' | 'COMMINGLING'}
      * @memberof FbaInboundApiGetItemEligibilityPreview
      */
-    readonly program: 'INBOUND' | 'COMMINGLING';
+    readonly program: GetItemEligibilityPreviewProgramEnum;
     /**
      * The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.
      * @type {Array<string>}
@@ -96,5 +96,13 @@ export declare class FbaInboundApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof FbaInboundApi
      */
-    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetItemEligibilityPreviewResponse, any>>;
+    getItemEligibilityPreview(requestParameters: FbaInboundApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetItemEligibilityPreviewResponse, any>>;
 }
+/**
+ * @export
+ */
+export declare const GetItemEligibilityPreviewProgramEnum: {
+    readonly Inbound: "INBOUND";
+    readonly Commingling: "COMMINGLING";
+};
+export type GetItemEligibilityPreviewProgramEnum = typeof GetItemEligibilityPreviewProgramEnum[keyof typeof GetItemEligibilityPreviewProgramEnum];

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import type { Configuration } from './configuration';
-import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
 /**
  *
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
  */
 export interface RequestArgs {
     url: string;
-    options: AxiosRequestConfig;
+    options: RawAxiosRequestConfig;
 }
 /**
  *
@@ -52,3 +52,15 @@ export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
 }
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+/**
+ *
+ * @export
+ */
+export declare const operationServerMap: ServerMap;
+export {};

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

@@ -15,6 +15,7 @@ export interface ConfigurationParameters {
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     basePath?: string;
+    serverIndex?: number;
     baseOptions?: any;
     formDataCtor?: new () => any;
 }
@@ -53,6 +54,13 @@ export declare class Configuration {
      * @memberof Configuration
      */
     basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
     /**
      * base options for axios calls
      *

package/dist/types/src/api-model/models/get-item-eligibility-preview-response.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ItemEligibilityPreview } from './item-eligibility-preview';
+import type { ItemEligibilityPreview } from './item-eligibility-preview';
 /**
  * The response schema for the getItemEligibilityPreview operation.
  * @export

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@sp-api-sdk/fba-inbound-eligibility-api-v1",
-  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
+  "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon's fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon's fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon's fulfillment centers.",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "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.0.6",
-    "axios": "^1.6.8"
+    "@sp-api-sdk/common": "2.0.8",
+    "axios": "^1.7.0"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,5 @@
     "sp sdk",
     "fba inbound eligibility api"
   ],
-  "gitHead": "d757ce0353f64c34db7c46df5fc2bc2716a29f57"
+  "gitHead": "5a245a25a9f1765c825e2178668d4b0f4e44689b"
 }