@sp-api-sdk/vendor-direct-fulfillment-inventory-api-v1 4.0.16 → 5.0.0

package/dist/index.d.cts

@@ -0,0 +1,391 @@
+import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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 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);
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+/**
+ * Details of item quantity.
+ */
+interface ItemQuantity {
+    /**
+     * Quantity of units available for a specific item.
+     */
+    'amount'?: number;
+    /**
+     * Unit of measure for the available quantity.
+     */
+    'unitOfMeasure': string;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+
+/**
+ * Updated inventory details for an item.
+ */
+interface ItemDetails {
+    /**
+     * The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted.
+     */
+    'buyerProductIdentifier'?: string;
+    /**
+     * The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted.
+     */
+    'vendorProductIdentifier'?: string;
+    'availableQuantity': ItemQuantity;
+    /**
+     * When true, the item is permanently unavailable.
+     */
+    'isObsolete'?: boolean;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+/**
+ * Name, address and tax details of a party.
+ */
+interface PartyIdentification {
+    /**
+     * Assigned identification for the party.
+     */
+    'partyId': string;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+
+/**
+ * Inventory details required to update some or all items for the requested warehouse.
+ */
+interface InventoryUpdate {
+    'sellingParty': PartyIdentification;
+    /**
+     * When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged.
+     */
+    'isFullUpdate': boolean;
+    /**
+     * A list of inventory items with updated details, including quantity available.
+     */
+    'items': Array<ItemDetails>;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+/**
+ * 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;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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 request body for the submitInventoryUpdate operation.
+ */
+interface SubmitInventoryUpdateRequest {
+    'inventory'?: InventoryUpdate;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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.
+ */
+/**
+ * Response containing the transaction ID.
+ */
+interface TransactionReference {
+    /**
+     * GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
+     */
+    'transactionId'?: string;
+}
+
+/**
+ * Selling Partner API for Direct Fulfillment Inventory Updates
+ * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ *
+ * 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 submitInventoryUpdate operation.
+ */
+interface SubmitInventoryUpdateResponse {
+    'payload'?: TransactionReference;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     */
+    'errors'?: Array<Error>;
+}
+
+/**
+ * VendorDirectFulfillmentInventoryApi - axios parameter creator
+ */
+declare const VendorDirectFulfillmentInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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} warehouseId Identifier for the warehouse for which to update inventory.
+     * @param {SubmitInventoryUpdateRequest} body The request body containing the inventory update data to submit.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitInventoryUpdate: (warehouseId: string, body: SubmitInventoryUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VendorDirectFulfillmentInventoryApi - functional programming interface
+ */
+declare const VendorDirectFulfillmentInventoryApiFp: (configuration?: Configuration) => {
+    /**
+     * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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} warehouseId Identifier for the warehouse for which to update inventory.
+     * @param {SubmitInventoryUpdateRequest} body The request body containing the inventory update data to submit.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitInventoryUpdate(warehouseId: string, body: SubmitInventoryUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitInventoryUpdateResponse>>;
+};
+/**
+ * VendorDirectFulfillmentInventoryApi - factory interface
+ */
+declare const VendorDirectFulfillmentInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitInventoryUpdate(requestParameters: VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitInventoryUpdateResponse>;
+};
+/**
+ * Request parameters for submitInventoryUpdate operation in VendorDirectFulfillmentInventoryApi.
+ */
+interface VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest {
+    /**
+     * Identifier for the warehouse for which to update inventory.
+     */
+    readonly warehouseId: string;
+    /**
+     * The request body containing the inventory update data to submit.
+     */
+    readonly body: SubmitInventoryUpdateRequest;
+}
+/**
+ * VendorDirectFulfillmentInventoryApi - object-oriented interface
+ */
+declare class VendorDirectFulfillmentInventoryApi extends BaseAPI {
+    /**
+     * Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 |  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 {VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitInventoryUpdate(requestParameters: VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SubmitInventoryUpdateResponse, any, {}>>;
+}
+
+declare const clientRateLimits: RateLimit[];
+declare class VendorDirectFulfillmentInventoryApiClient extends VendorDirectFulfillmentInventoryApi {
+    constructor(configuration: ClientConfiguration);
+}
+
+export { type InventoryUpdate, type ItemDetails, type ItemQuantity, type ModelError, type PartyIdentification, type SubmitInventoryUpdateRequest, type SubmitInventoryUpdateResponse, type TransactionReference, VendorDirectFulfillmentInventoryApi, VendorDirectFulfillmentInventoryApiAxiosParamCreator, VendorDirectFulfillmentInventoryApiClient, VendorDirectFulfillmentInventoryApiFactory, VendorDirectFulfillmentInventoryApiFp, type VendorDirectFulfillmentInventoryApiSubmitInventoryUpdateRequest, clientRateLimits };