ebay-api 8.5.0 → 8.6.0

package/dist/api/restful/sell/inventory/index.js

@@ -1,49 +1,20 @@
 import Restful from '../../index.js';
-/**
- * The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay
- * marketplace.
- */
 class Inventory extends Restful {
     get basePath() {
         return '/sell/inventory/v1';
     }
-    /**
-     * This call retrieves all defined details of the inventory location that is specified by the
-     * <b>merchantLocationKey</b> path parameter.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     */
     getInventoryLocation(merchantLocationKey) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.get(`/location/${key}`);
     }
-    /**
-     * <p>This call disables the inventory location that is specified in the <code>merchantLocationKey</code> path
-     * parameter.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     */
     disableInventoryLocation(merchantLocationKey) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.post(`/location/${key}/disable`);
     }
-    /**
-     * <p>This call enables a disabled inventory location that is specified in the <code>merchantLocationKey</code>
-     * path parameter.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     */
     enableInventoryLocation(merchantLocationKey) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.post(`/location/${key}/enable`);
     }
-    /**
-     * This call retrieves all defined details for every inventory location associated with the seller's account.
-     *
-     * @param limit The value passed in this query parameter sets the maximum number of records to return per page of
-     *     data.
-     * @param offset The value passed in this query parameter sets the page number to retrieve.
-     */
     getInventoryLocations({ limit, offset, } = {}) {
         return this.get(`/location`, {
             params: {
@@ -52,74 +23,30 @@ class Inventory extends Restful {
             },
         });
     }
-    /**
-     * <p>Use this call to create a new inventory location.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     * @param body Inventory Location details
-     */
     createInventoryLocation(merchantLocationKey, body) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.post(`/location/${key}`, body);
     }
-    /**
-     * <p>This call deletes the inventory location that is specified in the <code>merchantLocationKey</code> path
-     * parameter.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     */
     deleteInventoryLocation(merchantLocationKey) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.delete(`/location/${key}`);
     }
-    /**
-     * <p>Use this call to update non-physical location details for an existing inventory location.
-     *
-     * @param merchantLocationKey A unique merchant-defined key (ID) for an inventory location.
-     * @param body The inventory location details to be updated (other than the address and geo co-ordinates).
-     */
     updateInventoryLocation(merchantLocationKey, body) {
         const key = encodeURIComponent(merchantLocationKey);
         return this.post(`/location/${key}/update_location_details`, body);
     }
-    /**
-     * This call retrieves the inventory item record for a given SKU.
-     *
-     * @param sku his is the seller-defined SKU value of the product whose inventory item record you wish to
-     *     retrieve.<br/><br/><strong>Max length</strong>: 50.
-     */
     getInventoryItem(sku) {
         sku = encodeURIComponent(sku);
         return this.get(`/inventory_item/${sku}`);
     }
-    /**
-     * This call creates a new inventory item record or replaces an existing inventory item record.
-     *
-     * @param sku The seller-defined SKU value for the inventory item is required whether the seller is creating a new
-     *     inventory item, or updating an existing inventory item.
-     * @param body Details of the inventory item record.
-     */
     createOrReplaceInventoryItem(sku, body) {
         sku = encodeURIComponent(sku);
         return this.put(`/inventory_item/${sku}`, body);
     }
-    /**
-     * This call is used to delete an inventory item record associated with a specified SKU.
-     *
-     * @param sku The seller-defined SKU value for the inventory item is required whether the seller is creating a new
-     *     inventory item, or updating an existing inventory item.
-     */
     deleteInventoryItem(sku) {
         sku = encodeURIComponent(sku);
         return this.delete(`/inventory_item/${sku}`);
     }
-    /**
-     * This call retrieves all inventory item records defined for the seller's account.
-     *
-     * @param limit The value passed in this query parameter sets the maximum number of records to return per page of
-     *     data.
-     * @param offset The value passed in this query parameter sets the page number to retrieve.
-     */
     getInventoryItems({ limit, offset, } = {}) {
         return this.get(`/inventory_item`, {
             params: {
@@ -128,72 +55,27 @@ class Inventory extends Restful {
             },
         });
     }
-    /**
-     * This call is used by the seller to update the total ship-to-home quantity of one inventory item,
-     *  and/or to update the price and/or quantity of one or more offers associated with one inventory item.
-     *
-     * @param body BulkPriceQuantity
-     */
     bulkUpdatePriceQuantity(body) {
         return this.post(`/bulk_update_price_quantity`, body);
     }
-    /**
-     * This call can be used to create and/or update up to 25 new inventory item records.
-     *
-     * @param body BulkInventoryItem
-     */
     bulkCreateOrReplaceInventoryItem(body) {
         return this.post(`/bulk_create_or_replace_inventory_item`, body);
     }
-    /**
-     * This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is
-     * specified in the request payload.
-     *
-     * @param body BulkInventoryItem
-     */
     bulkGetInventoryItem(body) {
         return this.post(`/bulk_get_inventory_item`, body);
     }
-    /**
-     * This call is used by the seller to retrieve the list of products that are compatible with the inventory item.
-     *
-     * @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
-     */
     getProductCompatibility(sku) {
         sku = encodeURIComponent(sku);
         return this.get(`/inventory_item/${sku}/product_compatibility`);
     }
-    /**
-     * This call is used by the seller to create or replace a list of products that are compatible with the inventory
-     * item.
-     *
-     * @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
-     * @param body Details of the compatibility
-     */
     createOrReplaceProductCompatibility(sku, body) {
         sku = encodeURIComponent(sku);
         return this.put(`/inventory_item/${sku}/product_compatibility`, body);
     }
-    /**
-     * This call is used by the seller to delete the list of products that are compatible with the inventory item that
-     * is associated with the compatible product list.
-     *
-     * @param sku A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
-     */
     deleteProductCompatibility(sku) {
         sku = encodeURIComponent(sku);
         return this.delete(`/inventory_item/${sku}/product_compatibility`);
     }
-    /**
-     * This call retrieves all existing offers for the specified SKU value.
-     *
-     * @param sku The seller-defined SKU value is passed in as a query parameter.
-     * @param marketplace_id The unique identifier of the eBay marketplace.
-     * @param format This enumeration value sets the listing format for the offer.
-     * @param limit The value passed in this query parameter sets the maximum number of records to return per page of
-     *     data.
-     * @param offset The value passed in this query parameter sets the page number to retrieve.
-     */
     getOffers({ sku, marketplaceId, format, limit, offset, } = {}) {
         return this.get(`/offer`, {
             params: {
@@ -205,133 +87,54 @@ class Inventory extends Restful {
             },
         });
     }
-    /**
-     * This call retrieves a specific published or unpublished offer.
-     *
-     * @param offerId The unique identifier of the offer that is to be retrieved.
-     */
     getOffer(offerId) {
         offerId = encodeURIComponent(offerId);
         return this.get(`/offer/${offerId}`);
     }
-    /**
-     * This call creates an offer for a specific inventory item on a specific eBay marketplace.
-     *
-     * @param body Details of the offer for the channel
-     */
     createOffer(body) {
         return this.post(`/offer`, body);
     }
-    /**
-     * This call updates an existing offer.
-     *
-     * @param offerId The unique identifier of the offer that is being updated.
-     * @param body Details of the offer for the channel
-     */
     updateOffer(offerId, body) {
         offerId = encodeURIComponent(offerId);
         return this.put(`/offer/${offerId}`, body);
     }
-    /**
-     * If used against an unpublished offer, this call will permanently delete that offer.
-     *
-     * @param offerId The unique identifier of the offer to delete.
-     */
     deleteOffer(offerId) {
         return this.delete(`/offer/${offerId}`);
     }
-    /**
-     * This call is used to convert an unpublished offer into a published offer, or live eBay listing.
-     *
-     * @param offerId The unique identifier of the offer that is to be published.
-     */
     publishOffer(offerId) {
         const id = encodeURIComponent(offerId);
         return this.post(`/offer/${id}/publish/`);
     }
-    /**
-     * This call is used to convert all unpublished offers associated with an inventory item group into an active,
-     * multiple-variation listing.
-     *
-     * @param body PublishByInventoryItemGroupRequest
-     */
     publishOfferByInventoryItemGroup(body) {
         return this.post(`/offer/publish_by_inventory_item_group/`, body);
     }
-    /**
-     * This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item
-     * group.
-     *
-     * @param body WithdrawByInventoryItemGroupRequest
-     */
     withdrawOfferByInventoryItemGroup(body) {
         return this.post(`/offer/withdraw_by_inventory_item_group`, body);
     }
-    /**
-     * This call is used to retrieve the expected listing fees for up to 250 unpublished offers.
-     *
-     * @param body OfferKeysWithId
-     */
     getListingFees(body) {
         return this.post(`/offer/get_listing_fees`, body);
     }
-    /**
-     * This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace.
-     *
-     * @param body BulkEbayOfferDetailsWithKeys
-     */
     bulkCreateOffer(body) {
         return this.post(`/bulk_create_offer`, body);
     }
-    /**
-     * This call is used to convert unpublished offers (up to 25) into  published offers, or live eBay listings.
-     *
-     * @param body BulkOffer
-     */
     bulkPublishOffer(body) {
         return this.post(`/bulk_publish_offer`, body);
     }
-    /**
-     * This call is used to end a single-variation listing that is associated with the specified offer.
-     *
-     * @param offerId he unique identifier of the offer that is to be withdrawn.
-     */
     withdrawOffer(offerId) {
         const id = encodeURIComponent(offerId);
         return this.post(`/offer/${id}/withdraw`);
     }
-    /**
-     * This call retrieves the inventory item group for a given <strong>inventoryItemGroupKey</strong> value.
-     *
-     * @param inventoryItemGroupKey The unique identifier of an inventory item group.
-     */
     getInventoryItemGroup(inventoryItemGroupKey) {
         inventoryItemGroupKey = encodeURIComponent(inventoryItemGroupKey);
         return this.get(`/inventory_item_group/${inventoryItemGroupKey}`);
     }
-    /**
-     * This call creates a new inventory item group or updates an existing inventory item group.
-     *
-     * @param inventoryItemGroupKey Unique identifier of the inventory item group.
-     * @param body Details of the inventory Item Group
-     */
     createOrReplaceInventoryItemGroup(inventoryItemGroupKey, body) {
         inventoryItemGroupKey = encodeURIComponent(inventoryItemGroupKey);
         return this.put(`/inventory_item_group/${inventoryItemGroupKey}`, body);
     }
-    /**
-     * This call deletes the inventory item group for a given <strong>inventoryItemGroupKey</strong> value.
-     *
-     * @param inventoryItemGroupKey Unique identifier of the inventory item group.
-     */
     deleteInventoryItemGroup(inventoryItemGroupKey) {
         return this.delete(`/inventory_item_group/${inventoryItemGroupKey}`);
     }
-    /**
-     * This call is used to convert existing eBay Listings to the corresponding Inventory API objects.
-     *
-     * @param body BulkMigrateListing
-     */
     bulkMigrateListing(body) {
         return this.post(`/bulk_migrate_listing`, body);
     }

package/dist/api/restful/sell/listing/index.d.ts

@@ -1,15 +1,7 @@
 import { operations } from '../../../../types/restful/specs/sell_listing_v1_beta_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * Enables a seller adding an ad or item on a Partner's site to automatically create an eBay listing draft using the item details from the Partner's site.
- */
 export default class Listing extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * This call gives Partners the ability to create an eBay draft of a item for their seller using information from their site.
-     *
-     * @param data The ItemDraft
-     */
     createItemDraft(data?: any): Promise<any>;
 }

package/dist/api/restful/sell/listing/index.js

@@ -1,16 +1,8 @@
 import Restful from '../../index.js';
-/**
- * Enables a seller adding an ad or item on a Partner's site to automatically create an eBay listing draft using the item details from the Partner's site.
- */
 class Listing extends Restful {
     get basePath() {
         return '/sell/listing/v1_beta';
     }
-    /**
-     * This call gives Partners the ability to create an eBay draft of a item for their seller using information from their site.
-     *
-     * @param data The ItemDraft
-     */
     createItemDraft(data) {
         return this.post(`/item_draft/`, data);
     }

package/dist/api/restful/sell/logistics/index.d.ts

@@ -1,45 +1,12 @@
 import { operations } from '../../../../types/restful/specs/sell_logistics_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> &ndash; Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.
- */
 export default class Logistics extends Restful implements OpenApi<operations> {
     static id: string;
     get basePath(): string;
-    /**
-     * The createShippingQuote method returns a shipping quote that contains a list of live &quot;rates.&quot;
-     *
-     * @param data The ShippingQuoteRequest
-     */
     createShippingQuote(data: any): Promise<any>;
-    /**
-     * This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value.
-     *
-     * @param shippingQuoteId This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.
-     */
     getShippingQuote(shippingQuoteId: string): Promise<any>;
-    /**
-     * This method creates a &quot;shipment&quot; based on the shippingQuoteId and rateId values supplied in the request.
-     *
-     * @param data The CreateShipmentFromQuoteRequest
-     */
     createFromShippingQuote(data: any): Promise<any>;
-    /**
-     * This method retrieves the shipment details for the specified shipment ID.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment you want to retrieve.
-     */
     getShipment(shipmentId: any): Promise<any>;
-    /**
-     * This method returns the shipping label file that was generated for the shipmentId value specified in the request.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment associated with the shipping label you want to download.
-     */
     downloadLabelFile(shipmentId: any): Promise<any>;
-    /**
-     * This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.
-     */
     cancelShipment(shipmentId: any): Promise<any>;
 }

package/dist/api/restful/sell/logistics/index.js

@@ -1,57 +1,24 @@
 import Restful from '../../index.js';
-/**
- * The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> &ndash; Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.
- */
 class Logistics extends Restful {
     get basePath() {
         return '/sell/logistics/v1_beta';
     }
-    /**
-     * The createShippingQuote method returns a shipping quote that contains a list of live &quot;rates.&quot;
-     *
-     * @param data The ShippingQuoteRequest
-     */
     createShippingQuote(data) {
         return this.post(`/shipping_quote`, data);
     }
-    /**
-     * This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value.
-     *
-     * @param shippingQuoteId This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.
-     */
     getShippingQuote(shippingQuoteId) {
         shippingQuoteId = encodeURIComponent(shippingQuoteId);
         return this.get(`/shipping_quote/${shippingQuoteId}`);
     }
-    /**
-     * This method creates a &quot;shipment&quot; based on the shippingQuoteId and rateId values supplied in the request.
-     *
-     * @param data The CreateShipmentFromQuoteRequest
-     */
     createFromShippingQuote(data) {
         return this.post(`/shipment/create_from_shipping_quote`, data);
     }
-    /**
-     * This method retrieves the shipment details for the specified shipment ID.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment you want to retrieve.
-     */
     getShipment(shipmentId) {
         return this.get(`/shipment/${shipmentId}`);
     }
-    /**
-     * This method returns the shipping label file that was generated for the shipmentId value specified in the request.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment associated with the shipping label you want to download.
-     */
     downloadLabelFile(shipmentId) {
         return this.get(`/shipment/${shipmentId}/download_label_file`);
     }
-    /**
-     * This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted.
-     *
-     * @param shipmentId This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.
-     */
     cancelShipment(shipmentId) {
         return this.post(`/shipment/${shipmentId}/cancel`);
     }