@sp-api-sdk/fba-inventory-api-v1 3.0.6 → 3.0.7

package/dist/types/api-model/api/fba-inventory-api.d.ts

@@ -21,7 +21,6 @@ import type { DeleteInventoryItemResponse } from '../models';
 import type { GetInventorySummariesResponse } from '../models';
 /**
  * FbaInventoryApi - axios parameter creator
- * @export
  */
 export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -64,7 +63,6 @@ export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configur
 };
 /**
  * FbaInventoryApi - functional programming interface
- * @export
  */
 export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
     /**
@@ -107,7 +105,6 @@ export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
 };
 /**
  * FbaInventoryApi - factory interface
- * @export
  */
 export declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -141,115 +138,78 @@ export declare const FbaInventoryApiFactory: (configuration?: Configuration, bas
 };
 /**
  * Request parameters for addInventory operation in FbaInventoryApi.
- * @export
- * @interface FbaInventoryApiAddInventoryRequest
  */
 export interface FbaInventoryApiAddInventoryRequest {
     /**
      * A unique token/requestId provided with each call to ensure idempotency.
-     * @type {string}
-     * @memberof FbaInventoryApiAddInventory
      */
     readonly xAmznIdempotencyToken: string;
     /**
      * List of items to add to Sandbox inventory.
-     * @type {AddInventoryRequest}
-     * @memberof FbaInventoryApiAddInventory
      */
     readonly addInventoryRequestBody: AddInventoryRequest;
 }
 /**
  * Request parameters for createInventoryItem operation in FbaInventoryApi.
- * @export
- * @interface FbaInventoryApiCreateInventoryItemRequest
  */
 export interface FbaInventoryApiCreateInventoryItemRequest {
     /**
      * CreateInventoryItem Request Body Parameter.
-     * @type {CreateInventoryItemRequest}
-     * @memberof FbaInventoryApiCreateInventoryItem
      */
     readonly createInventoryItemRequestBody: CreateInventoryItemRequest;
 }
 /**
  * Request parameters for deleteInventoryItem operation in FbaInventoryApi.
- * @export
- * @interface FbaInventoryApiDeleteInventoryItemRequest
  */
 export interface FbaInventoryApiDeleteInventoryItemRequest {
     /**
      * A single seller SKU used for querying the specified seller SKU inventory summaries.
-     * @type {string}
-     * @memberof FbaInventoryApiDeleteInventoryItem
      */
     readonly sellerSku: string;
     /**
      * The marketplace ID for the marketplace for which the sellerSku is to be deleted.
-     * @type {string}
-     * @memberof FbaInventoryApiDeleteInventoryItem
      */
     readonly marketplaceId: string;
 }
 /**
  * Request parameters for getInventorySummaries operation in FbaInventoryApi.
- * @export
- * @interface FbaInventoryApiGetInventorySummariesRequest
  */
 export interface FbaInventoryApiGetInventorySummariesRequest {
     /**
      * The granularity type for the inventory aggregation level.
-     * @type {'Marketplace'}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly granularityType: GetInventorySummariesGranularityTypeEnum;
     /**
      * The granularity ID for the inventory aggregation level.
-     * @type {string}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly granularityId: string;
     /**
      * The marketplace ID for the marketplace for which to return inventory summaries.
-     * @type {Array<string>}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly marketplaceIds: Array<string>;
     /**
      * true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
-     * @type {boolean}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly details?: boolean;
     /**
      * A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
-     * @type {string}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly startDateTime?: string;
     /**
      * A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
-     * @type {Array<string>}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly sellerSkus?: Array<string>;
     /**
      * A single seller SKU used for querying the specified seller SKU inventory summaries.
-     * @type {string}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly sellerSku?: string;
     /**
      * String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
-     * @type {string}
-     * @memberof FbaInventoryApiGetInventorySummaries
      */
     readonly nextToken?: string;
 }
 /**
  * FbaInventoryApi - object-oriented interface
- * @export
- * @class FbaInventoryApi
- * @extends {BaseAPI}
  */
 export declare class FbaInventoryApi extends BaseAPI {
     /**
@@ -257,7 +217,6 @@ export declare class FbaInventoryApi extends BaseAPI {
      * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof FbaInventoryApi
      */
     addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AddInventoryResponse, any>>;
     /**
@@ -265,7 +224,6 @@ export declare class FbaInventoryApi extends BaseAPI {
      * @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof FbaInventoryApi
      */
     createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInventoryItemResponse, any>>;
     /**
@@ -273,7 +231,6 @@ export declare class FbaInventoryApi extends BaseAPI {
      * @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof FbaInventoryApi
      */
     deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteInventoryItemResponse, any>>;
     /**
@@ -281,13 +238,9 @@ export declare class FbaInventoryApi extends BaseAPI {
      * @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof FbaInventoryApi
      */
     getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInventorySummariesResponse, any>>;
 }
-/**
- * @export
- */
 export declare const GetInventorySummariesGranularityTypeEnum: {
     readonly Marketplace: "Marketplace";
 };

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/add-inventory-request.d.ts

@@ -12,14 +12,10 @@
 import type { InventoryItem } from './inventory-item';
 /**
  * The object with the list of Inventory to be added
- * @export
- * @interface AddInventoryRequest
  */
 export interface AddInventoryRequest {
     /**
      * List of Inventory to be added
-     * @type {Array<InventoryItem>}
-     * @memberof AddInventoryRequest
      */
     'inventoryItems'?: Array<InventoryItem>;
 }

package/dist/types/api-model/models/add-inventory-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the AddInventory operation.
- * @export
- * @interface AddInventoryResponse
  */
 export interface AddInventoryResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof AddInventoryResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/create-inventory-item-request.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * An item to be created in the inventory.
- * @export
- * @interface CreateInventoryItemRequest
  */
 export interface CreateInventoryItemRequest {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof CreateInventoryItemRequest
      */
     'sellerSku': string;
     /**
      * The marketplaceId.
-     * @type {string}
-     * @memberof CreateInventoryItemRequest
      */
     'marketplaceId': string;
     /**
      * The name of the item.
-     * @type {string}
-     * @memberof CreateInventoryItemRequest
      */
     'productName': string;
 }

package/dist/types/api-model/models/create-inventory-item-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the CreateInventoryItem operation.
- * @export
- * @interface CreateInventoryItemResponse
  */
 export interface CreateInventoryItemResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof CreateInventoryItemResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/delete-inventory-item-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The response schema for the DeleteInventoryItem operation.
- * @export
- * @interface DeleteInventoryItemResponse
  */
 export interface DeleteInventoryItemResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof DeleteInventoryItemResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-inventory-summaries-response.d.ts

@@ -13,26 +13,12 @@ import type { GetInventorySummariesResult } from './get-inventory-summaries-resu
 import type { Pagination } from './pagination';
 /**
  * The Response schema.
- * @export
- * @interface GetInventorySummariesResponse
  */
 export interface GetInventorySummariesResponse {
-    /**
-     *
-     * @type {GetInventorySummariesResult}
-     * @memberof GetInventorySummariesResponse
-     */
     'payload'?: GetInventorySummariesResult;
-    /**
-     *
-     * @type {Pagination}
-     * @memberof GetInventorySummariesResponse
-     */
     'pagination'?: Pagination;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetInventorySummariesResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-inventory-summaries-result.d.ts

@@ -13,20 +13,11 @@ import type { Granularity } from './granularity';
 import type { InventorySummary } from './inventory-summary';
 /**
  * The payload schema for the getInventorySummaries operation.
- * @export
- * @interface GetInventorySummariesResult
  */
 export interface GetInventorySummariesResult {
-    /**
-     *
-     * @type {Granularity}
-     * @memberof GetInventorySummariesResult
-     */
     'granularity': Granularity;
     /**
      * A list of inventory summaries.
-     * @type {Array<InventorySummary>}
-     * @memberof GetInventorySummariesResult
      */
     'inventorySummaries': Array<InventorySummary>;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.
- * @export
- * @interface Granularity
  */
 export interface Granularity {
     /**
      * The granularity type for the inventory aggregation level.
-     * @type {string}
-     * @memberof Granularity
      */
     'granularityType'?: string;
     /**
      * The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.
-     * @type {string}
-     * @memberof Granularity
      */
     'granularityId'?: string;
 }

package/dist/types/api-model/models/inventory-details.d.ts

@@ -14,50 +14,25 @@ import type { ReservedQuantity } from './reserved-quantity';
 import type { UnfulfillableQuantity } from './unfulfillable-quantity';
 /**
  * Summarized inventory details. This object will not appear if the details parameter in the request is false.
- * @export
- * @interface InventoryDetails
  */
 export interface InventoryDetails {
     /**
      * The item quantity that can be picked, packed, and shipped.
-     * @type {number}
-     * @memberof InventoryDetails
      */
     'fulfillableQuantity'?: number;
     /**
      * The number of units in an inbound shipment for which you have notified Amazon.
-     * @type {number}
-     * @memberof InventoryDetails
      */
     'inboundWorkingQuantity'?: number;
     /**
      * The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.
-     * @type {number}
-     * @memberof InventoryDetails
      */
     'inboundShippedQuantity'?: number;
     /**
      * The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed.
-     * @type {number}
-     * @memberof InventoryDetails
      */
     'inboundReceivingQuantity'?: number;
-    /**
-     *
-     * @type {ReservedQuantity}
-     * @memberof InventoryDetails
-     */
     'reservedQuantity'?: ReservedQuantity;
-    /**
-     *
-     * @type {ResearchingQuantity}
-     * @memberof InventoryDetails
-     */
     'researchingQuantity'?: ResearchingQuantity;
-    /**
-     *
-     * @type {UnfulfillableQuantity}
-     * @memberof InventoryDetails
-     */
     'unfulfillableQuantity'?: UnfulfillableQuantity;
 }

package/dist/types/api-model/models/inventory-item.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * An item in the list of inventory to be added.
- * @export
- * @interface InventoryItem
  */
 export interface InventoryItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof InventoryItem
      */
     'sellerSku': string;
     /**
      * The marketplaceId.
-     * @type {string}
-     * @memberof InventoryItem
      */
     'marketplaceId': string;
     /**
      * The quantity of item to add.
-     * @type {number}
-     * @memberof InventoryItem
      */
     'quantity': number;
 }

package/dist/types/api-model/models/inventory-summary.d.ts

@@ -12,62 +12,39 @@
 import type { InventoryDetails } from './inventory-details';
 /**
  * Inventory summary for a specific item.
- * @export
- * @interface InventorySummary
  */
 export interface InventorySummary {
     /**
      * The Amazon Standard Identification Number (ASIN) of an item.
-     * @type {string}
-     * @memberof InventorySummary
      */
     'asin'?: string;
     /**
      * Amazon\'s fulfillment network SKU identifier.
-     * @type {string}
-     * @memberof InventorySummary
      */
     'fnSku'?: string;
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof InventorySummary
      */
     'sellerSku'?: string;
     /**
      * The condition of the item as described by the seller (for example, New Item).
-     * @type {string}
-     * @memberof InventorySummary
      */
     'condition'?: string;
-    /**
-     *
-     * @type {InventoryDetails}
-     * @memberof InventorySummary
-     */
     'inventoryDetails'?: InventoryDetails;
     /**
      * The date and time that any quantity was last updated.
-     * @type {string}
-     * @memberof InventorySummary
      */
     'lastUpdatedTime'?: string;
     /**
      * The localized language product title of the item within the specific marketplace.
-     * @type {string}
-     * @memberof InventorySummary
      */
     'productName'?: string;
     /**
      * The total number of units in an inbound shipment or in Amazon fulfillment centers.
-     * @type {number}
-     * @memberof InventorySummary
      */
     'totalQuantity'?: number;
     /**
      * A list of seller-enrolled stores that apply to this seller SKU.
-     * @type {Array<string>}
-     * @memberof InventorySummary
      */
     'stores'?: Array<string>;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * An error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @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 information that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It\'s a form of traffic management.
- * @export
- * @interface Pagination
  */
 export interface Pagination {
     /**
      * A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.
-     * @type {string}
-     * @memberof Pagination
      */
     'nextToken'?: string;
 }