ebay-api 8.5.1 → 8.6.1

package/lib/api/restful/sell/marketing/index.js

@@ -4,120 +4,49 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:
- * </p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i>
- * for the products they want to promote. eBay displays the ads in search results and in other
- * marketing modules as <b>SPONSORED</b> listings.
- */
 class Marketing extends index_js_1.default {
     get basePath() {
         return '/sell/marketing/v1';
     }
-    /**
-     * This method creates an ad for each inventory reference ID specified in the request and associates the newly
-     * created ads with the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
-     * @param body This type defines the fields for the bulkCreateAdsByInventoryReference request.
-     */
     bulkCreateAdsByInventoryReference(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_inventory_reference`, body);
     }
-    /**
-     * This method creates an ad for each listing ID specified in the request and associates the newly created ads with
-     * the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body The container for the bulk request to create ads for eBay listing IDs. eBay listing IDs are
-     *     generated when the listing is created on eBay.
-     */
     bulkCreateAdsByListingId(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_create_ads_by_listing_id`, body);
     }
-    /**
-     * This method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified
-     * campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for a bulkDeleteAdsByInventoryReference request.
-     */
     bulkDeleteAdsByInventoryReference(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_inventory_reference`, body);
     }
-    /**
-     * This method deletes a set of ads, as specified by a list of listing IDs, from the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for the bulkDeleteAdsByListingId request.
-     */
     bulkDeleteAdsByListingId(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_delete_ads_by_listing_id`, body);
     }
-    /**
-     * This method replaces an ad bid based on a list of inventory references IDs associated with the specified
-     * campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
-     * @param body This type defines the fields for the BulkCreateAdsByInventoryReference request.
-     */
     bulkUpdateAdsBidByInventoryReference(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_inventory_reference`, body);
     }
-    /**
-     * This method replaces an ad bid based on a supplied list of listing IDs that are associated with the specified
-     * campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body Container for the bulk request to update ads.
-     */
     bulkUpdateAdsBidByListingId(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_listing_id`, body);
     }
-    /**
-     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body The bulk request to update the ads.
-     */
     bulkUpdateAdsStatus(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status`, body);
     }
-    /**
-     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body The bulk request to update ads.
-     */
     bulkUpdateAdsStatusByListingId(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status_by_listing_id`, body);
     }
-    /**
-     * This method retrieves all the ads for the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param limit Specifies the maximum number of ads to return on a page in the paginated response. Default: 10
-     *     Maximum: 500
-     * @param listingIds A comma separated list of eBay listing IDs. The response includes only active ads (ads
-     *     associated with a RUNNING campaign).
-     * @param offset Specifies the number of ads to skip in the result set before returning the first ad in the
-     *     paginated response.
-     */
+    launchCampaign(campaignId) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/launch`);
+    }
+    setupQuickCampaign(body) {
+        return this.post(`/ad_campaign/setup_quick_campaign`, body);
+    }
     getAds(campaignId, { limit, listingIds, offset } = {}) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/ad`, {
@@ -128,74 +57,28 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method creates an ad for the specified listing ID, sets the bid percentage for that specific item, and
-     * associates the ad with the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for the createAd request.
-     */
     createAdByListingId(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/ad`, body);
     }
-    /**
-     * This method creates an ad for the specified inventory reference ID, sets the bid percentage for that specific
-     * item, and associates the ad with the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for the createAdsByInventoryReference request.
-     */
     createAdsByInventoryReference(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/create_ads_by_inventory_reference`, body);
     }
-    /**
-     * This method retrieves the specified ad from the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adId Identifier of an ad. This ID was generated when the ad was created.
-     */
     getAd(campaignId, adId) {
         campaignId = encodeURIComponent(campaignId);
         adId = encodeURIComponent(adId);
         return this.get(`/ad_campaign/${campaignId}/ad/${adId}`);
     }
-    /**
-     * This method retrieves the specified ad from the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created.
-     * @param adId Identifier of an ad. This ID was generated when the ad was created.
-     */
     deleteAd(campaignId, adId) {
         campaignId = encodeURIComponent(campaignId);
         adId = encodeURIComponent(adId);
         return this.delete(`/ad_campaign/${campaignId}/ad/${adId}`);
     }
-    /**
-     * This method deletes ads using a list of seller inventory reference IDs that are associated with the specified
-     * campaign ID.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     deleteAdsByInventoryReference(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/delete_ads_by_inventory_reference`);
     }
-    /**
-     * This method retrieves ads from the specified campaign using the seller's inventory reference ID and inventory
-     * reference type.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param inventoryReferenceId The inventory reference ID associated with the ad you want returned.
-     * @param inventoryReferenceType The type of the inventory reference ID. Set this value to either INVENTORY_ITEM (a
-     *     single listing) or INVENTORY_ITEM_GROUP (a multi-variation listing).
-     */
     getAdsByInventoryReference(campaignId, inventoryReferenceId, inventoryReferenceType) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/get_ads_by_inventory_reference`, {
@@ -205,28 +88,11 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method updates the bid for the specified ad in the specified campaign. In the request, supply the
-     * campaign_id and ad_id as a URI parameters.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adId A unique eBay-assigned ID for an ad that's generated when an ad is created.
-     * @param body This type defines the fields for the updateBid request.
-     */
     updateBid(campaignId, adId, body) {
         campaignId = encodeURIComponent(campaignId);
         adId = encodeURIComponent(adId);
         return this.post(`/ad_campaign/${campaignId}/ad/${adId}/update_bid`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupStatus A comma-separated list of ad group statuses.
-     * @param limit The number of results, from the current result set, to be returned in a single page.
-     * @param offset The number of results that will be skipped in the result set.
-     */
     getAdGroups(campaignId, { adGroupStatus, limit, offset } = {}) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/ad_group`, {
@@ -237,90 +103,34 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for the <b>createAdGroup</b> request.
-     */
     createAdGroup(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/ad_group`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupId The ID of the ad group that shall be retrieved.
-     */
     getAdGroup(campaignId, adGroupId) {
         adGroupId = encodeURIComponent(adGroupId);
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupId The ID of the ad group that shall be retrieved.
-     * @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
-     */
     updateAdGroup(campaignId, adGroupId, body) {
         adGroupId = encodeURIComponent(adGroupId);
         campaignId = encodeURIComponent(campaignId);
         return this.put(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupId The ID of the ad group that shall be retrieved.
-     * @param body The data requested to retrieve the suggested bids.
-     */
     suggestBids(campaignId, adGroupId, body) {
         adGroupId = encodeURIComponent(adGroupId);
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_bids`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupId The ID of the ad group that shall be retrieved.
-     * @param body The required data to retrieve suggested keywords.
-     */
     suggestKeywords(campaignId, adGroupId, body) {
         adGroupId = encodeURIComponent(adGroupId);
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_keywords`, body);
     }
-    /**
-     * This method clones (makes a copy of) the specified campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields for a clone campaign request.
-     */
     cloneCampaign(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/clone`, body);
     }
-    /**
-     * This method retrieves the details for all the campaigns of a seller, including the campaign's the selection
-     * rules.
-     *
-     * @param campaignName Specifies the campaign name. The results are filtered to include only the campaign by the
-     *     specified name.
-     * @param campaignStatus Specifies the campaign status. The results are filtered to include only campaigns that are
-     *     in the specified states.
-     * @param endDateRange Specifies the range of a campaign's end date. The results are filtered to include only
-     *     campaigns with an end date that is within specified range.
-     * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response. Default:
-     *     10 Maximum: 500
-     * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in
-     *     the paginated response.
-     * @param startDateRange Specifies the range of a campaign's start date in which to filter the results.
-     */
     getCampaigns({ campaignName, campaignStatus, endDateRange, limit, offset, startDateRange } = {}) {
         return this.get(`/ad_campaign`, {
             params: {
@@ -333,55 +143,21 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     getCampaign(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}`);
     }
-    /**
-     * This method creates a Promoted Listings ad campaign.
-     *
-     * @param body his type defines the fields for the create campaign request.
-     */
     createCampaign(body) {
         return this.post(`/ad_campaign`, body);
     }
-    /**
-     * This method deletes the campaign specified by the campaign_id query parameter.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     deleteCampaign(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.delete(`/ad_campaign/${campaignId}`);
     }
-    /**
-     * This method ends an active (RUNNINGM) or paused campaign. Specify the campaign you want to end by supplying its
-     * campaign ID in a query parameter.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     endCampaign(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/end`);
     }
-    /**
-     * This method retrieves the campaign containing the listing that is specified using either an eBay listing ID or
-     * an inventory reference ID and inventory reference type.
-     *
-     * @param inventoryReferenceId The seller's inventory reference ID of the listing to be used to find the campaign
-     *     in which it is associated.
-     * @param inventoryReferenceType The type of the seller's inventory reference ID, which is a listing or group of
-     *     items.
-     * @param listingId Identifier of the eBay listing associated with the ad.
-     */
     findCampaignByAdReference({ inventoryReferenceId, inventoryReferenceType, listingId } = {}) {
         return this.get(`/ad_campaign/find_campaign_by_ad_reference`, {
             params: {
@@ -391,11 +167,6 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method retrieves the details of a single campaign, as specified with the campaign_name query parameter.
-     *
-     * @param campaignName Name of the campaign.
-     */
     getCampaignByName(campaignName) {
         return this.get(`/ad_campaign/get_campaign_by_name`, {
             params: {
@@ -403,34 +174,14 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method pauses an active (RUNNING) campaign. You can restarted by calling resumeCampaign, as long as the
-     * campaign's end date is in the future..
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     pauseCampaign(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/pause`);
     }
-    /**
-     * This method resumes a paused campaign, as long as it's end date is in the future.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     */
     resumeCampaign(campaignId) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/resume`);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
-     * @param categoryIds Specifies the category ID that is used to limit the results.
-     * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
-     * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
-     */
     suggestItems(campaignId, { categoryIds, limit, offset } = {}) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/suggest_items`, {
@@ -441,64 +192,26 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
-     * @param body This type defines the request fields for the ad rate strategy that shall be updated.
-     */
     updateAdRateStrategy(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/update_ad_rate_strategy`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
-     * @param body This type defines the request fields for the budget details that shall be updated.
-     */
     updateCampaignBudget(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/update_campaign_budget`, body);
     }
-    /**
-     * This method replaces the name and the start and end dates of a campaign.
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body This type defines the fields to updated the campaign name and start and end dates.
-     */
     updateCampaignIdentification(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/update_campaign_identification`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body A type that defines the fields for the bulk request to create keywords.
-     */
     bulkCreateKeyword(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_create_keyword`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body A type that defines the fields for the bulk request to update keywords.
-     */
     bulkUpdateKeyword(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_keyword`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param adGroupIds A comma-separated list of ad group IDs.
-     * @param keywordStatus A comma-separated list of keyword statuses.
-     * @param limit Specifies the maximum number of results to return on a page in the paginated response.
-     * @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
-     */
     getKeywords(campaignId, { adGroupIds, keywordStatus, limit, offset } = {}) {
         campaignId = encodeURIComponent(campaignId);
         return this.get(`/ad_campaign/${campaignId}/keyword`, {
@@ -510,61 +223,26 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param body A type that defines the fields for the request to create a keyword.
-     */
     createKeyword(campaignId, body) {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/keyword`, body);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param keywordId This path parameter is used to identify the keyword to retrieve.
-     */
     getKeyword(campaignId, keywordId) {
         campaignId = encodeURIComponent(campaignId);
         keywordId = encodeURIComponent(keywordId);
         return this.get(`/ad_campaign/${campaignId}/keyword/${keywordId}`);
     }
-    /**
-     *
-     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
-     *     a seller's campaign IDs by calling getCampaigns.
-     * @param keywordId This path parameter is used to identify the keyword to retrieve.
-     * @param body A type that defines the fields for the request to update a keyword.
-     */
     updateKeyword(campaignId, keywordId, body) {
         campaignId = encodeURIComponent(campaignId);
         keywordId = encodeURIComponent(keywordId);
         return this.put(`/ad_campaign/${campaignId}/keyword/${keywordId}`, body);
     }
-    /**
-     *
-     * @param body A type that defines the fields for the bulk request to create negative keywords.
-     */
     bulkCreateNegativeKeyword(body) {
         return this.post(`/bulk_create_negative_keyword`, body);
     }
-    /**
-     *
-     * @param body A type that defines the fields for the bulk request to create negative keywords.
-     */
     bulkUpdateNegativeKeyword(body) {
         return this.post(`/bulk_update_negative_keyword`, body);
     }
-    /**
-     *
-     * @param adGroupIds A comma-separated list of ad group IDs.
-     * @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
-     * @param limit The number of results, from the current result set, to be returned in a single page.
-     * @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
-     * @param offset The number of results that will be skipped in the result set.
-     */
     getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset } = {}) {
         return this.get(`/negative_keyword`, {
             params: {
@@ -574,66 +252,28 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     *
-     * @param body A type that defines the fields for the request to create a negative keyword.
-     */
     createNegativeKeyword(body) {
         return this.post(`/negative_keyword`, body);
     }
-    /**
-     *
-     * @param negativeKeywordId The unique identifier for the negative keyword.
-     */
     getNegativeKeyword(negativeKeywordId) {
         negativeKeywordId = encodeURIComponent(negativeKeywordId);
         return this.get(`/negative_keyword/${negativeKeywordId}`);
     }
-    /**
-     *
-     * @param negativeKeywordId The unique identifier for the negative keyword.
-     * @param body A type that defines the fields for the request to update a negative keyword.
-     */
     updateNegativeKeyword(negativeKeywordId, body) {
         negativeKeywordId = encodeURIComponent(negativeKeywordId);
         return this.put(`/negative_keyword/${negativeKeywordId}`, body);
     }
-    /**
-     * This call downloads the report as specified by the report_id path parameter.
-     *
-     * @param reportId The unique ID of the Promoted Listings report you want to get. This ID is generated by eBay when
-     *     you run a report task with a call to createReportTask.
-     */
     getReport(reportId) {
         reportId = encodeURIComponent(reportId);
         return this.get(`/ad_report/${reportId}`);
     }
-    /**
-     * This call retrieves information that details the fields used in each of the Promoted Listings reports.
-     */
     getReportMetadata() {
         return this.get(`/ad_report_metadata`);
     }
-    /**
-     * This call retrieves metadata that details the fields used by the Promoted Listings report type that's specified
-     * by the report_type path parameter.
-     *
-     * @param reportType The name of the report type whose metadata you want to get.
-     */
     getReportMetadataForReportType(reportType) {
         reportType = encodeURIComponent(reportType);
         return this.get(`/ad_report_metadata/${reportType}`);
     }
-    /**
-     * This method returns information on all the existing report tasks related to a seller.
-     *
-     * @param limit Specifies the maximum number of report tasks to return on a page in the paginated response.
-     *     Default: 10 Maximum: 500
-     * @param offset Specifies the number of report tasks to skip in the result set before returning the first report
-     *     in the paginated response.
-     * @param reportTaskStatuses This parameter filters the returned report tasks by their status. Supply a
-     *     comma-separated list of the report statuses you want returned.
-     */
     getReportTasks({ limit, offset, reportTaskStatuses } = {}) {
         return this.get(`/ad_report_task`, {
             params: {
@@ -643,128 +283,47 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id
-     * path parameter. T
-     *
-     * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
-     *     created by a call to createReportTask.
-     */
     getReportTask(reportTaskId) {
         reportTaskId = encodeURIComponent(reportTaskId);
         return this.get(`/ad_report_task/${reportTaskId}`);
     }
-    /**
-     * This method creates a report task, which generates a Promoted Listings report based on the values specified in
-     * the call.
-     *
-     * @param body The container for the fields that define the report task.
-     */
     createReportTask(body) {
         return this.post(`/ad_report_task`, body);
     }
-    /**
-     * This call deletes the report task specified by the report_task_id path parameter.
-     *
-     * @param reportTaskId A unique eBay-assigned ID for the report task that's generated when the report task is
-     *     created by a call to createReportTask.
-     */
     deleteReportTask(reportTaskId) {
         reportTaskId = encodeURIComponent(reportTaskId);
         return this.delete(`/ad_report_task/${reportTaskId}`);
     }
-    /**
-     * This method creates an item price markdown promotion (know simply as a &quot;markdown promotion&quot;) where a
-     * discount amount is applied directly to the items included the promotion.
-     *
-     * @param body This type defines the fields that describe an item price markdown promotion.
-     */
     createItemPriceMarkdownPromotion(body) {
         return this.post(`/item_price_markdown`, body);
     }
-    /**
-     * This method updates the specified item price markdown promotion with the new configuration that you supply in
-     * the payload of the request.
-     *
-     * @param promotionId The ID of the promotion you want to update.
-     * @param body This type defines the fields that describe an item price markdown promotion.
-     */
     updateItemPriceMarkdownPromotion(promotionId, body) {
         promotionId = encodeURIComponent(promotionId);
         return this.put(`/item_price_markdown/${promotionId}`, body);
     }
-    /**
-     * This method deletes the item price markdown promotion specified by the promotion_id path parameter.
-     *
-     * @param promotionId The ID of the promotion you want to delete.
-     */
     deleteItemPriceMarkdownPromotion(promotionId) {
         promotionId = encodeURIComponent(promotionId);
         return this.delete(`/item_price_markdown/${promotionId}`);
     }
-    /**
-     * This method returns the complete details of the item price markdown promotion that's indicated by the
-     * promotion_id path parameter.
-     *
-     * @param promotionId The ID of the promotion you want to retrieve.
-     */
     getItemPriceMarkdownPromotion(promotionId) {
         promotionId = encodeURIComponent(promotionId);
         return this.get(`/item_price_markdown/${promotionId}`);
     }
-    /**
-     * This method creates an item promotion (known casually as a &quot;threshold promotion&quot;) where the buyer
-     * receives a discount when they meet the buying criteria that's set for the promotion.
-     *
-     * @param body This type defines the fields that describe an item promotion.
-     */
     createItemPromotion(body) {
         return this.post(`/item_promotion`, body);
     }
-    /**
-     * This method updates the specified threshold promotion with the new configuration that you supply in the request.
-     *
-     * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
-     *     value that's generated when the promotion is created.
-     * @param body type defines the fields that describe an item promotion.
-     */
     updateItemPromotion(promotionId, body) {
         promotionId = encodeURIComponent(promotionId);
         return this.put(`/item_promotion/${promotionId}`, body);
     }
-    /**
-     * This method deletes the threshold promotion specified by the promotion_id path parameter.
-     *
-     * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
-     *     value that's generated when the promotion is created.
-     */
     deleteItemPromotion(promotionId) {
         promotionId = encodeURIComponent(promotionId);
         return this.delete(`/item_promotion/${promotionId}`);
     }
-    /**
-     * This method returns the complete details of the threshold promotion specified by the promotion_id path
-     * parameter.
-     *
-     * @param promotionId The ID of the promotion you want to retrieve. The promotion ID is a unique eBay-assigned
-     *     value that's generated when the promotion is created.
-     */
     getItemPromotion(promotionId) {
         promotionId = encodeURIComponent(promotionId);
         return this.get(`/item_promotion/${promotionId}`);
     }
-    /**
-     * This method returns the set of listings associated with the promotion_id specified in the path parameter.
-     *
-     * @param promotionId The ID of the promotion whose associated listings you want to retrieve.
-     * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
-     *     Maximum: 200
-     * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
-     *     in the paginated response.
-     * @param q Reserved for future use.
-     * @param sort Specifies the order in which to sort the associated listings in the response.
-     * @param status This query parameter applies only to markdown promotions.
-     */
     getListingSet(promotionId, { limit, offset, q, sort, status } = {}) {
         promotionId = encodeURIComponent(promotionId);
         return this.get(`/promotion/${promotionId}/get_listing_set`, {
@@ -777,19 +336,6 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method returns a list of a seller's undeleted promotions.
-     *
-     * @param marketplaceId The eBay marketplace ID of the site where the promotion is hosted.
-     * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
-     *     Maximum: 200
-     * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
-     *     in the paginated response.
-     * @param promotionStatus Specifies the promotion state by which you want to filter the results.
-     * @param promotionType Filters the returned promotions based on the their campaign promotion type.
-     * @param q A string consisting of one or more keywords.
-     * @param sort Specifies the order for how to sort the response.
-     */
     getPromotions(marketplaceId, { limit, offset, promotionStatus, promotionType, q, sort } = {}) {
         return this.get(`/promotion`, {
             params: {
@@ -803,42 +349,14 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from
-     * RUNNING to PAUSED.
-     *
-     * @param promotionId Identifier of the promotion you want to pause.
-     */
     pausePromotion(promotionId) {
         const id = encodeURIComponent(promotionId);
         return this.post(`/promotion/${id}/pause`);
     }
-    /**
-     * This method restarts a threshold promotion that was previously paused and changes the state of the promotion
-     * from PAUSED to RUNNING.
-     *
-     * @param promotionId Identifier of the promotion you want to make active. The ID is a unique eBay-assigned value
-     *     that's generated when the promotion is created.
-     */
     resumePromotion(promotionId) {
         const id = encodeURIComponent(promotionId);
         return this.post(`/promotion/${id}/resume`);
     }
-    /**
-     * This method generates a report that lists the seller's running, paused, and ended promotions for the specified
-     * eBay marketplace.
-     *
-     * @param marketplaceId The eBay marketplace ID of the siteId for which you want the promotions report.
-     * @param limit Specifies the maximum number of promotions returned on a page from the result set. Default: 200
-     *     Maximum: 200
-     * @param offset Specifies the number of promotions to skip in the result set before returning the first promotion
-     *     in the paginated response.
-     * @param promotionStatus Limits the results to the promotions that are in the state specified by this query
-     *     parameter.
-     * @param promotionType Filters the returned promotions in the report based on the their campaign promotion type.
-     * @param q A string consisting of one or more keywords. eBay filters the response by returning only the promotions
-     *     that contain the supplied keywords in the promotion title.
-     */
     getPromotionReports(marketplaceId, { limit, offset, promotionStatus, promotionType, q } = {}) {
         return this.get(`/promotion_report`, {
             params: {
@@ -851,11 +369,6 @@ class Marketing extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method generates a report that summarizes the seller's promotions for the specified eBay marketplace.
-     *
-     * @param marketplaceId The eBay marketplace ID of the siteId you for which you want a promotion summary report.
-     */
     getPromotionSummaryReport(marketplaceId) {
         return this.get(`/promotion_summary_report`, {
             params: {
@@ -863,6 +376,47 @@ class Marketing extends index_js_1.default {
             }
         });
     }
+    getEmailCampaign(emailCampaignId) {
+        emailCampaignId = encodeURIComponent(emailCampaignId);
+        return this.get(`/email_campaign/${emailCampaignId}`);
+    }
+    getEmailCampaigns({ limit, q, offset, sort } = {}) {
+        return this.get(`/email_campaign`, {
+            params: {
+                limit,
+                offset,
+                q,
+                sort
+            }
+        });
+    }
+    createEmailCampaign(body) {
+        return this.post(`/email_campaign`, body);
+    }
+    updateEmailCampaign(emailCampaignId, body) {
+        emailCampaignId = encodeURIComponent(emailCampaignId);
+        return this.put(`/email_campaign/${emailCampaignId}`, body);
+    }
+    deleteEmailCampaign(emailCampaignId) {
+        emailCampaignId = encodeURIComponent(emailCampaignId);
+        return this.delete(`/email_campaign/${emailCampaignId}`);
+    }
+    getEmailPreview(emailCampaignId) {
+        emailCampaignId = encodeURIComponent(emailCampaignId);
+        return this.get(`/email_campaign/${emailCampaignId}/email_preview`);
+    }
+    getAudiences() {
+        return this.get(`/email_campaign/audience`);
+    }
+    ;
+    getEmailReport(startDate, endDate) {
+        return this.get(`/email_campaign/report`, {
+            params: {
+                startDate,
+                endDate
+            }
+        });
+    }
 }
 Marketing.id = 'Marketing';
 exports.default = Marketing;