ebay-api 8.2.0 → 8.4.0

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

@@ -79,6 +79,28 @@ export default class Marketing extends Restful {
         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.
      *
@@ -192,6 +214,81 @@ export default class Marketing extends Restful {
         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`, {
+            params: {
+                ad_group_status: adGroupStatus,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @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.
      *
@@ -322,6 +419,41 @@ export default class Marketing extends Restful {
         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`, {
+            params: {
+                category_ids: categoryIds,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @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.
      *
@@ -333,6 +465,134 @@ export default class Marketing extends Restful {
         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`, {
+            params: {
+                ad_group_ids: adGroupIds,
+                keyword_status: keywordStatus,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @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: {
+                ad_group_ids: adGroupIds,
+                campaign_ids: campaignIds, limit,
+                negative_keyword_status: negativeKeywordStatus, offset
+            }
+        });
+    }
+    /**
+     *
+     * @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.
      *

package/dist/api/traditional/XMLRequest.d.ts

@@ -34,12 +34,14 @@ export type TraditionalApiConfig = {
     raw?: boolean;
     parseOptions?: object;
     useIaf?: boolean;
+    sign?: boolean;
     hook?: (xml: string) => BodyHeaders;
 } & ApiRequestConfig;
 export type XMLReqConfig = TraditionalApiConfig & {
     endpoint: string;
     xmlns: string;
     eBayAuthToken?: string | null;
+    digitalSignatureHeaders?: (payload: any) => Headers;
 };
 export declare const defaultApiConfig: Required<Omit<TraditionalApiConfig, 'hook'>>;
 export declare const defaultHeaders: {
@@ -63,7 +65,7 @@ export default class XMLRequest {
      * @param      {Object} req the request
      * @param      {XMLReqConfig}  config
      */
-    constructor(callName: string, fields: Fields, config: XMLReqConfig, req: IEBayApiRequest);
+    constructor(callName: string, fields: Fields | null, config: XMLReqConfig, req: IEBayApiRequest);
     /**
      * returns the expected name of XML node of a Request
      *

package/dist/api/traditional/XMLRequest.js

@@ -1,5 +1,5 @@
 import debug from 'debug';
-import { XMLParser, XMLBuilder } from 'fast-xml-parser';
+import { XMLBuilder, XMLParser } from 'fast-xml-parser';
 import { checkEBayResponse, EbayNoCallError } from '../../errors/index.js';
 const log = debug('ebay:xml:request');
 export const defaultJSON2XMLOptions = {
@@ -32,6 +32,7 @@ export const defaultApiConfig = {
     raw: false,
     parseOptions: defaultXML2JSONParseOptions,
     useIaf: true,
+    sign: false,
     headers: {},
     returnResponse: false
 };
@@ -137,6 +138,7 @@ export default class XMLRequest {
             const config = {
                 headers: {
                     ...this.getHeaders(),
+                    ...this.config.digitalSignatureHeaders ? this.config.digitalSignatureHeaders(body) : {},
                     ...(headers ? headers : {})
                 }
             };

package/dist/api/traditional/index.d.ts

@@ -1,5 +1,5 @@
-import Api from '../index.js';
 import { ClientAlerts, Finding, Merchandising, Shopping, Trading } from '../../types/index.js';
+import Api from '../index.js';
 /**
  * Traditional eBay API.
  */

package/dist/api/traditional/index.js

@@ -1,6 +1,6 @@
 import { stringify } from 'qs';
-import Api from '../index.js';
 import { EBayIAFTokenExpired, EBayIAFTokenInvalid, handleEBayError } from '../../errors/index.js';
+import Api from '../index.js';
 import ClientAlertsCalls from './clientAlerts/index.js';
 import FindingCalls from './finding/index.js';
 import MerchandisingCalls from './merchandising/index.js';
@@ -28,17 +28,15 @@ export default class Traditional extends Api {
         };
     }
     createTradingApi() {
-        if (!this.config.devId) {
-            throw new Error('devId is required for trading API.');
-        }
         if (typeof this.config.siteId !== 'number') {
             throw new Error('siteId is required for trading API.');
         }
         return this.createTraditionalXMLApi({
             endpoint: {
-                production: 'https://api.ebay.com/ws/api.dll',
-                sandbox: 'https://api.sandbox.ebay.com/ws/api.dll'
+                production: 'api.ebay.com',
+                sandbox: 'api.sandbox.ebay.com'
             },
+            path: '/ws/api.dll',
             calls: TradingCalls,
             xmlns: 'urn:ebay:apis:eBLBaseComponents',
             headers: (callName, accessToken) => ({
@@ -58,9 +56,10 @@ export default class Traditional extends Api {
         }
         return this.createTraditionalXMLApi({
             endpoint: {
-                production: 'https://open.api.ebay.com/shopping',
-                sandbox: 'https://open.api.sandbox.ebay.com/shopping'
+                production: 'open.api.ebay.com',
+                sandbox: 'open.api.sandbox.ebay.com'
             },
+            path: '/shopping',
             xmlns: 'urn:ebay:apis:eBLBaseComponents',
             calls: ShoppingCalls,
             headers: (callName, accessToken) => ({
@@ -76,9 +75,10 @@ export default class Traditional extends Api {
     createFindingApi() {
         return this.createTraditionalXMLApi({
             endpoint: {
-                production: 'https://svcs.ebay.com/services/search/FindingService/v1',
-                sandbox: 'https://svcs.sandbox.ebay.com/services/search/FindingService/v1'
+                production: 'svcs.ebay.com',
+                sandbox: 'svcs.sandbox.ebay.com'
             },
+            path: '/services/search/FindingService/v1',
             xmlns: 'http://www.ebay.com/marketplace/search/v1/services',
             calls: FindingCalls,
             headers: (callName) => ({
@@ -93,9 +93,10 @@ export default class Traditional extends Api {
         }
         const api = {
             endpoint: {
-                production: 'https://clientalerts.ebay.com/ws/ecasvc/ClientAlerts',
-                sandbox: 'https://clientalerts.sandbox.ebay.com/ws/ecasvc/ClientAlerts'
+                production: 'clientalerts.ebay.com',
+                sandbox: 'clientalerts.sandbox.ebay.com'
             },
+            path: '/ws/ecasvc/ClientAlerts',
             calls: ClientAlertsCalls
         };
         const endpoint = api.endpoint[this.config.sandbox ? 'sandbox' : 'production'];
@@ -129,9 +130,10 @@ export default class Traditional extends Api {
     createMerchandisingApi() {
         return this.createTraditionalXMLApi({
             endpoint: {
-                production: 'https://svcs.ebay.com/MerchandisingService',
-                sandbox: 'https://svcs.sandbox.ebay.com/MerchandisingService'
+                production: 'svcs.ebay.com',
+                sandbox: 'svcs.sandbox.ebay.com'
             },
+            path: '/MerchandisingService',
             xmlns: 'http://www.ebay.com/marketplace/services',
             calls: MerchandisingCalls,
             headers: (callName) => ({
@@ -160,14 +162,22 @@ export default class Traditional extends Api {
         const eBayAuthToken = this.auth.authNAuth.eBayAuthToken;
         const accessToken = !eBayAuthToken && apiConfig.useIaf ? (await this.auth.OAuth2.getAccessToken()) : null;
         const useIaf = !eBayAuthToken && accessToken;
+        const host = this.config.sandbox ? api.endpoint.sandbox : api.endpoint.production;
         return {
             ...apiConfig,
             xmlns: api.xmlns,
-            endpoint: api.endpoint[this.config.sandbox ? 'sandbox' : 'production'],
+            endpoint: `https://${host}${api.path}`,
             headers: {
                 ...api.headers(callName, useIaf ? accessToken : null),
                 ...apiConfig.headers
             },
+            digitalSignatureHeaders: payload => {
+                return apiConfig.sign ? this.getDigitalSignatureHeaders({
+                    method: 'POST',
+                    authority: host,
+                    path: api.path
+                }, payload) : {};
+            },
             ...(!useIaf ? { eBayAuthToken } : {})
         };
     }

package/dist/eBayApi.d.ts

@@ -11,7 +11,7 @@ import { ContentLanguage, Locale, MarketplaceId, SiteId } from './enums/index.js
 import * as errors from './errors/index.js';
 import { IEBayApiRequest } from './request.js';
 import * as types from './types/index.js';
-import { AppConfig, ClientAlerts, Finding, Merchandising, Shopping, Trading } from './types/index.js';
+import { AppConfig, ClientAlerts, Finding, Merchandising, Shopping, Signature, Trading } from './types/index.js';
 export default class eBayApi extends Api {
     static readonly SiteId: typeof enums.SiteId;
     static readonly MarketplaceId: typeof enums.MarketplaceId;
@@ -54,5 +54,6 @@ export default class eBayApi extends Api {
     get shopping(): Shopping;
     get merchandising(): Merchandising;
     get clientAlerts(): ClientAlerts;
+    setSignature(signature: Signature): void;
 }
 export { eBayApi, SiteId, MarketplaceId, ContentLanguage, Locale, enums, errors, types };

package/dist/eBayApi.js

@@ -29,6 +29,13 @@ export default class eBayApi extends Api {
         if (!process.env.EBAY_CERT_ID) {
             throw new ApiEnvError('EBAY_CERT_ID');
         }
+        let signature = null;
+        if (process.env.EBAY_JWE && process.env.EBAY_PRIVATE_KEY) {
+            signature = {
+                jwe: process.env.EBAY_JWE,
+                privateKey: process.env.EBAY_PRIVATE_KEY
+            };
+        }
         return new eBayApi({
             appId: process.env.EBAY_APP_ID,
             certId: process.env.EBAY_CERT_ID,
@@ -39,7 +46,8 @@ export default class eBayApi extends Api {
                 MarketplaceId[process.env.EBAY_MARKETPLACE_ID] :
                 MarketplaceId.EBAY_US,
             ruName: process.env.EBAY_RU_NAME,
-            sandbox: (process.env.EBAY_SANDBOX === 'true')
+            sandbox: (process.env.EBAY_SANDBOX === 'true'),
+            signature
         }, req);
     }
     /**
@@ -85,6 +93,9 @@ export default class eBayApi extends Api {
     get clientAlerts() {
         return this._clientAlerts || (this._clientAlerts = this.factory.createClientAlertsApi());
     }
+    setSignature(signature) {
+        this.config.signature = signature;
+    }
 }
 eBayApi.SiteId = SiteId;
 eBayApi.MarketplaceId = MarketplaceId;