@sp-api-sdk/external-fulfillment-inventory-api-2024-09-11 1.1.12 → 2.0.0

package/dist/index.d.cts

@@ -0,0 +1,498 @@
+import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * 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;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+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);
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Error details you can take action on.
+ */
+interface ActionableError {
+    /**
+     * The top level error type that may contain multiple error subtypes.
+     */
+    'errorType'?: string;
+    /**
+     * The secondary level error type.
+     */
+    'errorSubType'?: string;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The HTTP method associated with an individual request within a batch.
+ */
+declare const HttpMethod: {
+    readonly Get: "GET";
+    readonly Post: "POST";
+};
+type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The channel name and marketplace ID. This is required only when multiple channels have the same location ID.
+ */
+interface MarketplaceAttributes {
+    /**
+     * The name of the fulfillment channel in which to update inventory.
+     */
+    'channelName'?: MarketplaceAttributesChannelNameEnum;
+    /**
+     * The marketplace ID of the marketplace where you want to update inventory.
+     */
+    'marketplaceId'?: string;
+}
+declare const MarketplaceAttributesChannelNameEnum: {
+    readonly Fba: "FBA";
+    readonly Mfn: "MFN";
+    readonly Df: "DF";
+};
+type MarketplaceAttributesChannelNameEnum = typeof MarketplaceAttributesChannelNameEnum[keyof typeof MarketplaceAttributesChannelNameEnum];
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The parameters for an individual request.
+ */
+interface InventoryRequestParams {
+    /**
+     * The latest sequence number for the inventory update operation. You find this value in the `clientSequenceNumber` property in the response to the `batchInventory` operation.
+     */
+    'clientSequenceNumber'?: number;
+    /**
+     * The absolute inventory quantity.
+     */
+    'quantity'?: number;
+    'marketplaceAttributes'?: MarketplaceAttributes;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * An inventory request.
+ */
+interface InventoryRequest {
+    /**
+     * The URI associated with the individual APIs from the batch request. The user must provide the resource identifier for the operation they want to use.
+     */
+    'uri': string;
+    'method': HttpMethod;
+    'body'?: InventoryRequestParams;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A list of inventory requests.
+ */
+interface BatchInventoryRequest {
+    /**
+     * A list of inventory requests.
+     */
+    'requests'?: Array<InventoryRequest>;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The HTTP status associated with the response for an individual request within a batch.
+ */
+interface HttpStatusLine {
+    /**
+     * The HTTP response status code.
+     */
+    'statusCode'?: number;
+    /**
+     * The HTTP response reason phrase.
+     */
+    'reasonPhrase'?: string;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * 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 to an inventory request.
+ */
+interface InventoryResponseBody {
+    /**
+     * Latest sequence number for an inventory update.
+     */
+    'clientSequenceNumber'?: number;
+    /**
+     * The location where inventory is updated or retrieved.
+     */
+    'locationId'?: string;
+    /**
+     * The SKU ID for which inventory is updated or retrieved
+     */
+    'skuId'?: string;
+    /**
+     * The number of items of the specified SKU that are available for purchase.
+     */
+    'sellableQuantity'?: number;
+    /**
+     * The number of items of the specified SKU created in any marketplace that are reserved for shipment and yet to be fulfilled.
+     */
+    'reservedQuantity'?: number;
+    'marketplaceAttributes'?: MarketplaceAttributes;
+    /**
+     * Inventory operation errors that require seller action before retrying the inventory request.
+     */
+    'actionableErrors'?: Array<ActionableError>;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A response to an individual inventory request.
+ */
+interface InventoryResponse {
+    'status': HttpStatusLine;
+    'body': InventoryResponseBody;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * 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 of the `batchInventory` operation.
+ */
+interface BatchInventoryResponse {
+    /**
+     * A list of inventory request responses.
+     */
+    'responses'?: Array<InventoryResponse>;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An object containing a list of error responses returned when a request is unsuccessful.
+ */
+interface ErrorList {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     */
+    'errors': Array<Error>;
+}
+
+/**
+ * The Selling Partner API for External Fulfillment Inventory Management
+ * You can use the Amazon External Fulfillment Inventory API to manage inventory operations in Amazon\'s External Fulfillment network, including batch inventory updates and retrievals.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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.
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     */
+    'details'?: string;
+}
+
+/**
+ * ExternalFulfillmentInventoryApi - axios parameter creator
+ */
+declare const ExternalFulfillmentInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the  inventory count for the provided `sku` and `locationId` pair.
+     * @param {BatchInventoryRequest} body A list of inventory requests.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchInventory: (body: BatchInventoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExternalFulfillmentInventoryApi - functional programming interface
+ */
+declare const ExternalFulfillmentInventoryApiFp: (configuration?: Configuration) => {
+    /**
+     * Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the  inventory count for the provided `sku` and `locationId` pair.
+     * @param {BatchInventoryRequest} body A list of inventory requests.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchInventory(body: BatchInventoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchInventoryResponse>>;
+};
+/**
+ * ExternalFulfillmentInventoryApi - factory interface
+ */
+declare const ExternalFulfillmentInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the  inventory count for the provided `sku` and `locationId` pair.
+     * @param {ExternalFulfillmentInventoryApiBatchInventoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchInventory(requestParameters: ExternalFulfillmentInventoryApiBatchInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchInventoryResponse>;
+};
+/**
+ * Request parameters for batchInventory operation in ExternalFulfillmentInventoryApi.
+ */
+interface ExternalFulfillmentInventoryApiBatchInventoryRequest {
+    /**
+     * A list of inventory requests.
+     */
+    readonly body: BatchInventoryRequest;
+}
+/**
+ * ExternalFulfillmentInventoryApi - object-oriented interface
+ */
+declare class ExternalFulfillmentInventoryApi extends BaseAPI {
+    /**
+     * Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the  inventory count for the provided `sku` and `locationId` pair.
+     * @param {ExternalFulfillmentInventoryApiBatchInventoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchInventory(requestParameters: ExternalFulfillmentInventoryApiBatchInventoryRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<BatchInventoryResponse, any, {}>>;
+}
+
+declare const clientRateLimits: RateLimit[];
+declare class ExternalFulfillmentInventoryApiClient extends ExternalFulfillmentInventoryApi {
+    constructor(configuration: ClientConfiguration);
+}
+
+export { type ActionableError, type BatchInventoryRequest, type BatchInventoryResponse, type ErrorList, ExternalFulfillmentInventoryApi, ExternalFulfillmentInventoryApiAxiosParamCreator, type ExternalFulfillmentInventoryApiBatchInventoryRequest, ExternalFulfillmentInventoryApiClient, ExternalFulfillmentInventoryApiFactory, ExternalFulfillmentInventoryApiFp, HttpMethod, type HttpStatusLine, type InventoryRequest, type InventoryRequestParams, type InventoryResponse, type InventoryResponseBody, type MarketplaceAttributes, MarketplaceAttributesChannelNameEnum, type ModelError, clientRateLimits };