ebay-api 1.13.5 → 6.1.0

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

@@ -0,0 +1,609 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * <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 __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 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.
+     */
+    getAds(campaignId, { limit, listingIds, offset } = {}) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.get(`/ad_campaign/${campaignId}/ad`, {
+            params: {
+                limit,
+                listing_ids: listingIds,
+                offset
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                inventory_reference_id: inventoryReferenceId,
+                inventory_reference_type: inventoryReferenceType
+            }
+        });
+    }
+    /**
+     * 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);
+    }
+    /**
+     * 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: {
+                campaign_name: campaignName,
+                campaign_status: campaignStatus,
+                end_date_range: endDateRange,
+                limit,
+                offset,
+                start_date_range: startDateRange
+            }
+        });
+    }
+    /**
+     * 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: {
+                inventory_reference_id: inventoryReferenceId,
+                inventory_reference_type: inventoryReferenceType,
+                listing_id: listingId
+            }
+        });
+    }
+    /**
+     * 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: {
+                campaign_name: campaignName
+            }
+        });
+    }
+    /**
+     * 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`);
+    }
+    /**
+     * 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);
+    }
+    /**
+     * 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: {
+                limit,
+                offset,
+                report_task_statuses: reportTaskStatuses
+            }
+        });
+    }
+    /**
+     * 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`, {
+            params: {
+                limit,
+                offset,
+                q,
+                sort,
+                status
+            }
+        });
+    }
+    /**
+     * 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: {
+                marketplace_id: marketplaceId,
+                limit,
+                offset,
+                promotion_status: promotionStatus,
+                promotion_type: promotionType,
+                q,
+                sort
+            }
+        });
+    }
+    /**
+     * 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: {
+                marketplace_id: marketplaceId,
+                limit,
+                offset,
+                promotion_status: promotionStatus,
+                promotion_type: promotionType,
+                q
+            }
+        });
+    }
+    /**
+     * 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: {
+                marketplace_id: marketplaceId
+            }
+        });
+    }
+}
+exports.default = Marketing;
+Marketing.id = 'Marketing';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/marketing/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAiB7B;;;;;GAKG;AACH,MAAqB,SAAU,SAAQ,WAAO;IAI5C,IAAI,QAAQ;QACV,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,iCAAiC,CAAC,UAAkB,EAAE,IAA8C;QACzG,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,yCAAyC,EAAE,IAAI,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;OAQG;IACI,wBAAwB,CAAC,UAAkB,EAAE,IAAyB;QAC3E,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,gCAAgC,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACI,iCAAiC,CAAC,UAAkB,EAAE,IAA8C;QACzG,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,yCAAyC,EAAE,IAAI,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,UAAkB,EAAE,IAAyB;QAC3E,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,gCAAgC,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;OAMG;IACI,oCAAoC,CAAC,UAAkB,EAAE,IAA8C;QAC5G,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,6CAA6C,EAAE,IAAI,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;OAOG;IACI,2BAA2B,CAAC,UAAkB,EAAE,IAAyB;QAC9E,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,oCAAoC,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,UAAkB,EAAE,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,KACC,EAAE;QAC7D,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,UAAU,KAAK,EAAE;YAC/C,MAAM,EAAE;gBACN,KAAK;gBACL,WAAW,EAAE,UAAU;gBACvB,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAC,UAAkB,EAAE,IAAqB;QAClE,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CAAC,UAAkB,EAAE,IAA0C;QACjG,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,oCAAoC,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAkB,EAAE,IAAY;QAC3C,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,UAAU,OAAO,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,UAAkB,EAAE,IAAY;QAC9C,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,UAAU,OAAO,IAAI,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,6BAA6B,CAAC,UAAkB;QACrD,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,oCAAoC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACI,0BAA0B,CAAC,UAAkB,EAAE,oBAA4B,EAChD,sBAA8B;QAC9D,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,UAAU,iCAAiC,EAAE;YAC3E,MAAM,EAAE;gBACN,sBAAsB,EAAE,oBAAoB;gBAC5C,wBAAwB,EAAE,sBAAsB;aACjD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,SAAS,CAAC,UAAkB,EAAE,IAAY,EAAE,IAAgC;QACjF,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,OAAO,IAAI,aAAa,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,UAAkB,EAAE,IAA0B;QACjE,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,YAAY,CAAC,EAAC,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,KAIpE,EAAE;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,aAAa,EAAE,YAAY;gBAC3B,eAAe,EAAE,cAAc;gBAC/B,cAAc,EAAE,YAAY;gBAC5B,KAAK;gBACL,MAAM;gBACN,gBAAgB,EAAE,cAAc;aACjC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,UAAkB;QACnC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAA2B;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAkB;QACtC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,UAAkB;QACnC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;OASG;IACI,yBAAyB,CAAC,EAAC,oBAAoB,EAAE,sBAAsB,EAAE,SAAS,KAIrF,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,4CAA4C,EAAE;YAC5D,MAAM,EAAE;gBACN,sBAAsB,EAAE,oBAAoB;gBAC5C,wBAAwB,EAAE,sBAAsB;gBAChD,UAAU,EAAE,SAAS;aACtB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,YAAoB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE;YACnD,MAAM,EAAE;gBACN,aAAa,EAAE,YAAY;aAC5B;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,UAAkB;QACrC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAkB;QACtC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,4BAA4B,CAAC,UAAkB,EAAE,IAAyC;QAC/F,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,UAAU,iCAAiC,EAAE,IAAI,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,QAAgB;QAC/B,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,8BAA8B,CAAC,UAAkB;QACtD,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;OASG;IACI,cAAc,CAAC,EAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,KACmC,EAAE;QAC3F,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,KAAK;gBACL,MAAM;gBACN,oBAAoB,EAAE,kBAAkB;aACzC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,YAAoB;QACvC,YAAY,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,IAAsB;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,YAAoB;QAC1C,YAAY,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gCAAgC,CAAC,IAAuB;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,gCAAgC,CAAC,WAAmB,EAAE,IAAuB;QAClF,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,gCAAgC,CAAC,WAAmB;QACzD,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,6BAA6B,CAAC,WAAmB;QACtD,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,IAAmB;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAC,WAAmB,EAAE,IAAmB;QACjE,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,WAAmB;QAC5C,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,WAAmB;QACzC,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAAC,WAAmB,EACnB,EAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,KAG3B,EAAE;QACzB,WAAW,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,WAAW,kBAAkB,EAAE;YAC3D,MAAM,EAAE;gBACN,KAAK;gBACL,MAAM;gBACN,CAAC;gBACD,IAAI;gBACJ,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,aAAa,CAAC,aAAqB,EACrB,EAAC,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC,EAAE,IAAI,KAIjD,EAAE;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE;YAC5B,MAAM,EAAE;gBACN,cAAc,EAAE,aAAa;gBAC7B,KAAK;gBACL,MAAM;gBACN,gBAAgB,EAAE,eAAe;gBACjC,cAAc,EAAE,aAAa;gBAC7B,CAAC;gBACD,IAAI;aACL;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,WAAmB;QACvC,MAAM,EAAE,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,WAAmB;QACxC,MAAM,EAAE,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,mBAAmB,CAAC,aAAqB,EAAE,EAAC,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC,KACG,EAAE;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,cAAc,EAAE,aAAa;gBAC7B,KAAK;gBACL,MAAM;gBACN,gBAAgB,EAAE,eAAe;gBACjC,cAAc,EAAE,aAAa;gBAC7B,CAAC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,yBAAyB,CAAC,aAAqB;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE;YAC3C,MAAM,EAAE;gBACN,cAAc,EAAE,aAAa;aAC9B;SACF,CAAC,CAAC;IACL,CAAC;;AAtpBH,4BAupBC;AArpBQ,YAAE,GAAG,WAAW,CAAC"}