@sp-api-sdk/fba-inventory-api-v1 3.0.22 → 4.1.0

package/dist/index.d.ts

@@ -0,0 +1,782 @@
+import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
+import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
+//#region src/api-model/configuration.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+  options?: {
+    region?: string;
+    service?: string;
+  };
+  credentials?: {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
+  };
+}
+interface ConfigurationParameters {
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+  username?: string;
+  password?: string;
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+  awsv4?: AWSv4Configuration;
+  basePath?: string;
+  serverIndex?: number;
+  baseOptions?: any;
+  formDataCtor?: new () => any;
+}
+declare class Configuration {
+  /**
+   * parameter for apiKey security
+   * @param name security name
+   */
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+  /**
+   * parameter for basic security
+   */
+  username?: string;
+  /**
+   * parameter for basic security
+   */
+  password?: string;
+  /**
+   * parameter for oauth2 security
+   * @param name security name
+   * @param scopes oauth2 scope
+   */
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+  /**
+   * parameter for aws4 signature security
+   * @param {Object} AWS4Signature - AWS4 Signature security
+   * @param {string} options.region - aws region
+   * @param {string} options.service - name of the service.
+   * @param {string} credentials.accessKeyId - aws access key id
+   * @param {string} credentials.secretAccessKey - aws access key
+   * @param {string} credentials.sessionToken - aws session token
+   * @memberof Configuration
+   */
+  awsv4?: AWSv4Configuration;
+  /**
+   * override base path
+   */
+  basePath?: string;
+  /**
+   * override server index
+   */
+  serverIndex?: number;
+  /**
+   * base options for axios calls
+   */
+  baseOptions?: any;
+  /**
+   * The FormData constructor that will be used to create multipart form data
+   * requests. You can inject this here so that execution environments that
+   * do not support the FormData class can still run the generated client.
+   *
+   * @type {new () => FormData}
+   */
+  formDataCtor?: new () => any;
+  constructor(param?: ConfigurationParameters);
+  /**
+   * Check if the given MIME is a JSON MIME.
+   * JSON MIME examples:
+   *   application/json
+   *   application/json; charset=UTF8
+   *   APPLICATION/JSON
+   *   application/vnd.company+json
+   * @param mime - MIME (Multipurpose Internet Mail Extensions)
+   * @return True if the given MIME is JSON, false otherwise.
+   */
+  isJsonMime(mime: string): boolean;
+}
+//#endregion
+//#region src/api-model/base.d.ts
+interface RequestArgs {
+  url: string;
+  options: RawAxiosRequestConfig;
+}
+declare class BaseAPI {
+  protected basePath: string;
+  protected axios: AxiosInstance;
+  protected configuration: Configuration | undefined;
+  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+//#endregion
+//#region src/api-model/models/inventory-item.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An item in the list of inventory to be added.
+ */
+interface InventoryItem {
+  /**
+   * The seller SKU of the item.
+   */
+  'sellerSku': string;
+  /**
+   * The marketplaceId.
+   */
+  'marketplaceId': string;
+  /**
+   * The quantity of item to add.
+   */
+  'quantity': number;
+}
+//#endregion
+//#region src/api-model/models/add-inventory-request.d.ts
+/**
+ * The object with the list of Inventory to be added
+ */
+interface AddInventoryRequest {
+  /**
+   * List of Inventory to be added
+   */
+  'inventoryItems'?: Array<InventoryItem>;
+}
+//#endregion
+//#region src/api-model/models/add-inventory-response.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response schema for the AddInventory operation.
+ */
+interface AddInventoryResponse {
+  /**
+   * A list of error responses returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/create-inventory-item-request.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An item to be created in the inventory.
+ */
+interface CreateInventoryItemRequest {
+  /**
+   * The seller SKU of the item.
+   */
+  'sellerSku': string;
+  /**
+   * The marketplaceId.
+   */
+  'marketplaceId': string;
+  /**
+   * The name of the item.
+   */
+  'productName': string;
+}
+//#endregion
+//#region src/api-model/models/create-inventory-item-response.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response schema for the CreateInventoryItem operation.
+ */
+interface CreateInventoryItemResponse {
+  /**
+   * A list of error responses returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/delete-inventory-item-response.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response schema for the DeleteInventoryItem operation.
+ */
+interface DeleteInventoryItemResponse {
+  /**
+   * A list of error responses returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/granularity.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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.
+ */
+interface Granularity {
+  /**
+   * The granularity type for the inventory aggregation level.
+   */
+  'granularityType'?: string;
+  /**
+   * The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.
+   */
+  'granularityId'?: string;
+}
+//#endregion
+//#region src/api-model/models/researching-quantity-entry.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers.
+ */
+interface ResearchingQuantityEntry {
+  /**
+   * The duration of the research.
+   */
+  'name': ResearchingQuantityEntryNameEnum;
+  /**
+   * The number of units.
+   */
+  'quantity': number;
+}
+declare const ResearchingQuantityEntryNameEnum: {
+  readonly ResearchingQuantityInShortTerm: "researchingQuantityInShortTerm";
+  readonly ResearchingQuantityInMidTerm: "researchingQuantityInMidTerm";
+  readonly ResearchingQuantityInLongTerm: "researchingQuantityInLongTerm";
+};
+type ResearchingQuantityEntryNameEnum = typeof ResearchingQuantityEntryNameEnum[keyof typeof ResearchingQuantityEntryNameEnum];
+//#endregion
+//#region src/api-model/models/researching-quantity.d.ts
+/**
+ * The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.
+ */
+interface ResearchingQuantity {
+  /**
+   * The total number of units currently being researched in Amazon\'s fulfillment network.
+   */
+  'totalResearchingQuantity'?: number;
+  /**
+   * A list of quantity details for items currently being researched.
+   */
+  'researchingQuantityBreakdown'?: Array<ResearchingQuantityEntry>;
+}
+//#endregion
+//#region src/api-model/models/reserved-quantity.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The quantity of reserved inventory.
+ */
+interface ReservedQuantity {
+  /**
+   * The total number of units in Amazon\'s fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.
+   */
+  'totalReservedQuantity'?: number;
+  /**
+   * The number of units reserved for customer orders.
+   */
+  'pendingCustomerOrderQuantity'?: number;
+  /**
+   * The number of units being transferred from one fulfillment center to another.
+   */
+  'pendingTransshipmentQuantity'?: number;
+  /**
+   * The number of units that have been sidelined at the fulfillment center for additional processing.
+   */
+  'fcProcessingQuantity'?: number;
+}
+//#endregion
+//#region src/api-model/models/unfulfillable-quantity.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The quantity of unfulfillable inventory.
+ */
+interface UnfulfillableQuantity {
+  /**
+   * The total number of units in Amazon\'s fulfillment network in unsellable condition.
+   */
+  'totalUnfulfillableQuantity'?: number;
+  /**
+   * The number of units in customer damaged disposition.
+   */
+  'customerDamagedQuantity'?: number;
+  /**
+   * The number of units in warehouse damaged disposition.
+   */
+  'warehouseDamagedQuantity'?: number;
+  /**
+   * The number of units in distributor damaged disposition.
+   */
+  'distributorDamagedQuantity'?: number;
+  /**
+   * The number of units in carrier damaged disposition.
+   */
+  'carrierDamagedQuantity'?: number;
+  /**
+   * The number of units in defective disposition.
+   */
+  'defectiveQuantity'?: number;
+  /**
+   * The number of units in expired disposition.
+   */
+  'expiredQuantity'?: number;
+}
+//#endregion
+//#region src/api-model/models/inventory-details.d.ts
+/**
+ * Summarized inventory details. This object will not appear if the details parameter in the request is false.
+ */
+interface InventoryDetails {
+  /**
+   * The item quantity that can be picked, packed, and shipped.
+   */
+  'fulfillableQuantity'?: number;
+  /**
+   * The number of units in an inbound shipment for which you have notified Amazon.
+   */
+  'inboundWorkingQuantity'?: number;
+  /**
+   * The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.
+   */
+  '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.
+   */
+  'inboundReceivingQuantity'?: number;
+  'reservedQuantity'?: ReservedQuantity;
+  'researchingQuantity'?: ResearchingQuantity;
+  'unfulfillableQuantity'?: UnfulfillableQuantity;
+}
+//#endregion
+//#region src/api-model/models/inventory-summary.d.ts
+/**
+ * Inventory summary for a specific item.
+ */
+interface InventorySummary {
+  /**
+   * The Amazon Standard Identification Number (ASIN) of an item.
+   */
+  'asin'?: string;
+  /**
+   * Amazon\'s fulfillment network SKU identifier.
+   */
+  'fnSku'?: string;
+  /**
+   * The seller SKU of the item.
+   */
+  'sellerSku'?: string;
+  /**
+   * The condition of the item as described by the seller (for example, New Item).
+   */
+  'condition'?: string;
+  'inventoryDetails'?: InventoryDetails;
+  /**
+   * The date and time that any quantity was last updated.
+   */
+  'lastUpdatedTime'?: string;
+  /**
+   * The localized language product title of the item within the specific marketplace.
+   */
+  'productName'?: string;
+  /**
+   * The total number of units in an inbound shipment or in Amazon fulfillment centers.
+   */
+  'totalQuantity'?: number;
+  /**
+   * A list of seller-enrolled stores that apply to this seller SKU.
+   */
+  'stores'?: Array<string>;
+}
+//#endregion
+//#region src/api-model/models/get-inventory-summaries-result.d.ts
+/**
+ * The payload schema for the getInventorySummaries operation.
+ */
+interface GetInventorySummariesResult {
+  'granularity': Granularity;
+  /**
+   * A list of inventory summaries.
+   */
+  'inventorySummaries': Array<InventorySummary>;
+}
+//#endregion
+//#region src/api-model/models/pagination.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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.
+ */
+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.
+   */
+  'nextToken'?: string;
+}
+//#endregion
+//#region src/api-model/models/get-inventory-summaries-response.d.ts
+/**
+ * The Response schema.
+ */
+interface GetInventorySummariesResponse {
+  'payload'?: GetInventorySummariesResult;
+  'pagination'?: Pagination;
+  /**
+   * A list of error responses returned when a request is unsuccessful.
+   */
+  'errors'?: Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/model-error.d.ts
+/**
+ * Selling Partner API for FBA Inventory
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An error response returned when the request is unsuccessful.
+ */
+interface ModelError {
+  /**
+   * An error code that identifies the type of error that occurred.
+   */
+  'code': string;
+  /**
+   * A message that describes the error condition in a human-readable form.
+   */
+  'message'?: string;
+  /**
+   * Additional information that can help the caller understand or fix the issue.
+   */
+  'details'?: string;
+}
+//#endregion
+//#region src/api-model/api/fba-inventory-api.d.ts
+/**
+ * FbaInventoryApi - axios parameter creator
+ */
+declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
+  /**
+   * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
+   * @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  addInventory: (xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createInventoryItem: (createInventoryItemRequestBody: CreateInventoryItemRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries.
+   * @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  deleteInventoryItem: (sellerSku: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:  - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.  Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).  Usage Plan:  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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).
+   * @param {GetInventorySummariesGranularityTypeEnum} granularityType The granularity type for the inventory aggregation level.
+   * @param {string} granularityId The granularity ID for the inventory aggregation level.
+   * @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
+   * @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
+   * @param {string} [startDateTime] 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.
+   * @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
+   * @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
+   * @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getInventorySummaries: (granularityType: GetInventorySummariesGranularityTypeEnum, granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FbaInventoryApi - functional programming interface
+ */
+declare const FbaInventoryApiFp: (configuration?: Configuration) => {
+  /**
+   * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
+   * @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  addInventory(xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddInventoryResponse>>;
+  /**
+   * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createInventoryItem(createInventoryItemRequestBody: CreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInventoryItemResponse>>;
+  /**
+   * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries.
+   * @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  deleteInventoryItem(sellerSku: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteInventoryItemResponse>>;
+  /**
+   * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:  - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.  Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).  Usage Plan:  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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).
+   * @param {GetInventorySummariesGranularityTypeEnum} granularityType The granularity type for the inventory aggregation level.
+   * @param {string} granularityId The granularity ID for the inventory aggregation level.
+   * @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
+   * @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
+   * @param {string} [startDateTime] 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.
+   * @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
+   * @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
+   * @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getInventorySummaries(granularityType: GetInventorySummariesGranularityTypeEnum, granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventorySummariesResponse>>;
+};
+/**
+ * FbaInventoryApi - factory interface
+ */
+declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+  /**
+   * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddInventoryResponse>;
+  /**
+   * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInventoryItemResponse>;
+  /**
+   * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteInventoryItemResponse>;
+  /**
+   * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:  - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.  Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).  Usage Plan:  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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).
+   * @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInventorySummariesResponse>;
+};
+/**
+ * Request parameters for addInventory operation in FbaInventoryApi.
+ */
+interface FbaInventoryApiAddInventoryRequest {
+  /**
+   * A unique token/requestId provided with each call to ensure idempotency.
+   */
+  readonly xAmznIdempotencyToken: string;
+  /**
+   * List of items to add to Sandbox inventory.
+   */
+  readonly addInventoryRequestBody: AddInventoryRequest;
+}
+/**
+ * Request parameters for createInventoryItem operation in FbaInventoryApi.
+ */
+interface FbaInventoryApiCreateInventoryItemRequest {
+  /**
+   * CreateInventoryItem Request Body Parameter.
+   */
+  readonly createInventoryItemRequestBody: CreateInventoryItemRequest;
+}
+/**
+ * Request parameters for deleteInventoryItem operation in FbaInventoryApi.
+ */
+interface FbaInventoryApiDeleteInventoryItemRequest {
+  /**
+   * A single seller SKU used for querying the specified seller SKU inventory summaries.
+   */
+  readonly sellerSku: string;
+  /**
+   * The marketplace ID for the marketplace for which the sellerSku is to be deleted.
+   */
+  readonly marketplaceId: string;
+}
+/**
+ * Request parameters for getInventorySummaries operation in FbaInventoryApi.
+ */
+interface FbaInventoryApiGetInventorySummariesRequest {
+  /**
+   * The granularity type for the inventory aggregation level.
+   */
+  readonly granularityType: GetInventorySummariesGranularityTypeEnum;
+  /**
+   * The granularity ID for the inventory aggregation level.
+   */
+  readonly granularityId: string;
+  /**
+   * The marketplace ID for the marketplace for which to return inventory summaries.
+   */
+  readonly marketplaceIds: Array<string>;
+  /**
+   * true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
+   */
+  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.
+   */
+  readonly startDateTime?: string;
+  /**
+   * A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
+   */
+  readonly sellerSkus?: Array<string>;
+  /**
+   * A single seller SKU used for querying the specified seller SKU inventory summaries.
+   */
+  readonly sellerSku?: string;
+  /**
+   * String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
+   */
+  readonly nextToken?: string;
+}
+/**
+ * FbaInventoryApi - object-oriented interface
+ */
+declare class FbaInventoryApi extends BaseAPI {
+  /**
+   * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddInventoryResponse, any, {}>>;
+  /**
+   * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInventoryItemResponse, any, {}>>;
+  /**
+   * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
+   * @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteInventoryItemResponse, any, {}>>;
+  /**
+   * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:  - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.  Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).  Usage Plan:  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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).
+   * @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventorySummariesResponse, any, {}>>;
+}
+declare const GetInventorySummariesGranularityTypeEnum: {
+  readonly Marketplace: "Marketplace";
+};
+type GetInventorySummariesGranularityTypeEnum = typeof GetInventorySummariesGranularityTypeEnum[keyof typeof GetInventorySummariesGranularityTypeEnum];
+//#endregion
+//#region src/client.d.ts
+declare const clientRateLimits: RateLimit[];
+declare class FbaInventoryApiClient extends FbaInventoryApi {
+  constructor(configuration: ClientConfiguration);
+}
+//#endregion
+export { AddInventoryRequest, AddInventoryResponse, CreateInventoryItemRequest, CreateInventoryItemResponse, DeleteInventoryItemResponse, FbaInventoryApi, FbaInventoryApiAddInventoryRequest, FbaInventoryApiAxiosParamCreator, FbaInventoryApiClient, FbaInventoryApiCreateInventoryItemRequest, FbaInventoryApiDeleteInventoryItemRequest, FbaInventoryApiFactory, FbaInventoryApiFp, FbaInventoryApiGetInventorySummariesRequest, GetInventorySummariesGranularityTypeEnum, GetInventorySummariesResponse, GetInventorySummariesResult, Granularity, InventoryDetails, InventoryItem, InventorySummary, ModelError, Pagination, ResearchingQuantity, ResearchingQuantityEntry, ResearchingQuantityEntryNameEnum, ReservedQuantity, UnfulfillableQuantity, clientRateLimits };
+//# sourceMappingURL=index.d.ts.map