ebay-api 8.2.0 → 8.4.0

package/README.md

@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.2.0` is the latest release.
+* `v8.4.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -34,7 +34,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 | **Commerce API**   | ✔ Catalog API<br>✔ Charity API `v1.2.0`<br>✔ Identity API<br>✔ Notification API `v1.2.0`<br>✔ Taxonomy API `v1.0.0`<br>✔ Translation API `v1_beta.1.4`                                                                                                                                                                                 |
 | **Developer API**  | ✔ Analytics API                                                                                                                                                                                                                                                                                                                        |
 | **Post Order API** | ✔ Cancellation API<br>✔ Case Management API<br>✔ Inquiry API<br>✔ Return API                                                                                                                                                                                                                                                           |
-| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.10.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
+| **Sell API**       | ✔ Account API `v1.9.0`<br>✔ Analytics API `v1.3.0`<br>✔ Compliance API `v1.4.1`<br>✔ Feed API<br>✔ Finance API `v1.9.0`<br>✔ Fulfillment API `v1.19.10`<br>✔ Inventory API `v1.14.0`<br>✔ Listing API<br>✔ Logistics API<br>✔ Marketing API `v1.14.0`<br>✔ Metadata API<br>✔ Negotiation API `v1.1.0`<br>✔ Recommendation API `v1.1.0` |
 
 ### Traditional API
 
@@ -306,6 +306,41 @@ app.get('/orders/:id', async function (req, res) {
 });
 ```
 
+## Digital Signature
+Signatures are required when the call is made for EU- or UK-domiciled sellers, and only for the following APIs/methods:
+
+* All methods in the Finances API
+* issueRefund in the Fulfillment API
+* GetAccount in the Trading API
+* The following methods in the Post-Order API:
+  - Issue Inquiry Refund
+  - Issue case refund
+  - Issue return refund
+  - Process Return Request
+  - Create Cancellation Request
+  - Approve Cancellation Request
+
+### How to use Digital Signature
+```js
+// 1. Create singning key and save it appropriatly
+const signingKey = await eBay.developer.keyManagement.createSigningKey('ED25519');
+// 2. Set the signature
+eBay.setSignature(signingKey)
+// or in constructor
+eBay = new eBayApi({
+   appId: '...',
+   certId: '...',
+   signature: {
+      jwe: signingKey.jwe,
+      privateKey: signingKey.privateKey
+   }
+});
+// 3. Use the 'sign' keyword in Restful API
+const summary = await eBay.sell.finances.sign.getSellerFundsSummary();
+// 3. Or the 'sign' parameter in traditional API
+const account = await eBay.trading.GetAccount(null, {sign: true});
+```
+
 ## RESTful API
 
 ### How to set the Scope

package/dist/api/digitalSignature.d.ts

@@ -0,0 +1,43 @@
+import { Cipher, Headers } from '../types/index.js';
+/**
+ * Generates the 'Content-Digest' header value for the input payload.
+ *
+ * @param {any} payload The request payload.
+ * @param {string} cipher The algorithm used to calculate the digest.
+ * @returns {string} contentDigest The 'Content-Digest' header value.
+ */
+export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
+export type SignatureComponents = {
+    method: string;
+    authority: string;
+    path: string;
+};
+/**
+ * Generates the base string.
+ *
+ * @param {any} headers The HTTP request headers.
+ * @param {SignatureComponents} signatureComponents The config.
+ * @param {any} payload The payload.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} payload The base string.
+ */
+export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
+/**
+ * Generates the Signature-Input header value for the input payload.
+ *
+ * @param {any} payload The input config.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} the 'Signature-Input' header value.
+ */
+export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
+/**
+ * Generates the 'Signature' header.
+ *
+ * @param {any} headers The HTTP headers.
+ * @param {string} privateKey The HTTP headers.
+ * @param {SignatureComponents} signatureComponents The signature components
+ * @param {any} payload The payload
+ * @param {number} timestamp The payload
+ * @returns {string} the signature header value.
+ */
+export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;

package/dist/api/digitalSignature.js

@@ -0,0 +1,105 @@
+import { createHash, sign } from 'crypto';
+const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
+const endPrivateKey = '-----END PRIVATE KEY-----';
+// based on https://github.com/ebay/digital-signature-nodejs-sdk
+/**
+ * Returns the current UNIX timestamp.
+ *
+ * @returns {number} The unix timestamp.
+ */
+const getUnixTimestamp = () => Date.now() / 1000 | 0;
+const getSignatureParams = (payload) => [
+    ...payload ? ['content-digest'] : [],
+    'x-ebay-signature-key',
+    '@method',
+    '@path',
+    '@authority'
+];
+const getSignatureParamsValue = (payload) => getSignatureParams(payload).map(param => `"${param}"`).join(' ');
+/**
+ * Generates the 'Content-Digest' header value for the input payload.
+ *
+ * @param {any} payload The request payload.
+ * @param {string} cipher The algorithm used to calculate the digest.
+ * @returns {string} contentDigest The 'Content-Digest' header value.
+ */
+export const generateContentDigestValue = (payload, cipher = 'sha256') => {
+    const payloadBuffer = Buffer.from(typeof payload === 'string' ? payload : JSON.stringify(payload));
+    const hash = createHash(cipher).update(payloadBuffer).digest('base64');
+    const algo = cipher === 'sha512' ? 'sha-512' : 'sha-256';
+    return `${algo}=:${hash}:`;
+};
+/**
+ * Generates the base string.
+ *
+ * @param {any} headers The HTTP request headers.
+ * @param {SignatureComponents} signatureComponents The config.
+ * @param {any} payload The payload.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} payload The base string.
+ */
+export function generateBaseString(headers, signatureComponents, payload, timestamp = getUnixTimestamp()) {
+    try {
+        let baseString = '';
+        const signatureParams = getSignatureParams(payload);
+        signatureParams.forEach(param => {
+            baseString += `"${param.toLowerCase()}": `;
+            if (param.startsWith('@')) {
+                switch (param.toLowerCase()) {
+                    case '@method':
+                        baseString += signatureComponents.method;
+                        break;
+                    case '@authority':
+                        baseString += signatureComponents.authority;
+                        break;
+                    case '@path':
+                        baseString += signatureComponents.path;
+                        break;
+                    default:
+                        throw new Error('Unknown pseudo header ' + param);
+                }
+            }
+            else {
+                if (!headers[param]) {
+                    throw new Error('Header ' + param + ' not included in message');
+                }
+                baseString += headers[param];
+            }
+            baseString += '\n';
+        });
+        baseString += `"@signature-params": (${getSignatureParamsValue(payload)});created=${timestamp}`;
+        return baseString;
+    }
+    catch (ex) {
+        throw new Error(`Error calculating signature base: ${ex.message}`);
+    }
+}
+/**
+ * Generates the Signature-Input header value for the input payload.
+ *
+ * @param {any} payload The input config.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} the 'Signature-Input' header value.
+ */
+export const generateSignatureInput = (payload, timestamp = getUnixTimestamp()) => `sig1=(${getSignatureParamsValue(payload)});created=${timestamp}`;
+/**
+ * Generates the 'Signature' header.
+ *
+ * @param {any} headers The HTTP headers.
+ * @param {string} privateKey The HTTP headers.
+ * @param {SignatureComponents} signatureComponents The signature components
+ * @param {any} payload The payload
+ * @param {number} timestamp The payload
+ * @returns {string} the signature header value.
+ */
+export function generateSignature(headers, privateKey, signatureComponents, payload, timestamp = getUnixTimestamp()) {
+    const baseString = generateBaseString(headers, signatureComponents, payload, timestamp);
+    privateKey = privateKey.trim();
+    if (!privateKey.startsWith(beginPrivateKey)) {
+        privateKey = beginPrivateKey + '\n' + privateKey + '\n' + endPrivateKey;
+    }
+    const signatureBuffer = sign(undefined, // If algorithm is undefined, then it is dependent upon the private key type.
+    Buffer.from(baseString), privateKey);
+    const signature = signatureBuffer.toString('base64');
+    return `sig1=:${signature}:`;
+}

package/dist/api/index.d.ts

@@ -2,10 +2,12 @@ import Auth from '../auth/index.js';
 import { IEBayApiRequest } from '../request.js';
 import { AppConfig } from '../types/index.js';
 import Base from './base.js';
+import { SignatureComponents } from './digitalSignature.js';
 /**
  * Superclass with Auth container.
  */
 export default abstract class Api extends Base {
     readonly auth: Auth;
     constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth);
+    getDigitalSignatureHeaders(signatureComponents: SignatureComponents, payload: any): {};
 }

package/dist/api/index.js

@@ -1,5 +1,6 @@
 import Auth from '../auth/index.js';
 import Base from './base.js';
+import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
 /**
  * Superclass with Auth container.
  */
@@ -8,4 +9,21 @@ export default class Api extends Base {
         super(config, req);
         this.auth = auth || new Auth(this.config, this.req);
     }
+    getDigitalSignatureHeaders(signatureComponents, payload) {
+        if (!this.config.signature) {
+            return {};
+        }
+        const digitalSignatureHeaders = {
+            'x-ebay-enforce-signature': true,
+            'x-ebay-signature-key': this.config.signature.jwe,
+            ...payload ? {
+                'content-digest': generateContentDigestValue(payload, this.config.signature.cipher ?? 'sha256')
+            } : {},
+            'signature-input': generateSignatureInput(payload)
+        };
+        return {
+            ...digitalSignatureHeaders,
+            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
+        };
+    }
 }

package/dist/api/restful/developer/keyManagement/index.d.ts

@@ -12,11 +12,9 @@ export default class KeyManagement extends Restful {
      */
     getSigningKeys(): Promise<any>;
     /**
-     * his method creates keypairs.
+     * This method creates keypairs.
      */
-    createSigningKey(data: {
-        signingKeyCipher: string;
-    }): Promise<any>;
+    createSigningKey(signingKeyCipher: 'ED25519' | 'RSA'): Promise<any>;
     /**
      * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
      * and metadata for a specified <code>signingKeyId</code> associated with the application key making the call.

package/dist/api/restful/developer/keyManagement/index.js

@@ -17,10 +17,12 @@ export default class KeyManagement extends Restful {
         return this.get(`/signing_key`);
     }
     /**
-     * his method creates keypairs.
+     * This method creates keypairs.
      */
-    createSigningKey(data) {
-        return this.post(`/signing_key`, data);
+    createSigningKey(signingKeyCipher) {
+        return this.post(`/signing_key`, {
+            signingKeyCipher
+        });
     }
     /**
      * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,

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

@@ -1,11 +1,12 @@
-import Api from '../index.js';
 import Auth from '../../auth/index.js';
 import { IEBayApiRequest } from '../../request.js';
 import { ApiRequestConfig, AppConfig } from '../../types/index.js';
+import Api from '../index.js';
 export declare const defaultApiHeaders: Record<string, string>;
 export type RestfulApiConfig = {
     subdomain?: string;
     useIaf?: boolean;
+    sign?: boolean;
     apiVersion?: string;
     basePath?: string;
     schema?: string;
@@ -14,7 +15,7 @@ export type RestfulApiConfig = {
 } & ApiRequestConfig;
 export type ApiRequest = {
     method: keyof IEBayApiRequest;
-    url: string;
+    path: string;
     config?: any;
     data?: any;
 };
@@ -50,12 +51,16 @@ export default abstract class Restful extends Api {
      * Use "apiz" subdomain
      */
     get apiz(): this;
-    get(url: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
-    delete(url: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
-    post(url: string, data?: any, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
-    put(url: string, data?: any, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
+    /**
+     * Sign request
+     */
+    get sign(): this;
+    get(path: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
+    delete(path: string, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
+    post(path: string, data?: any, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
+    put(path: string, data?: any, config?: any, apiConfig?: RestfulApiConfig): Promise<any>;
     get additionalHeaders(): any;
-    enrichRequestConfig(config?: any, apiConfig?: Required<RestfulApiConfig>): Promise<any>;
+    enrichRequestConfig(apiRequest: ApiRequest, payload?: any, apiConfig?: Required<RestfulApiConfig>): Promise<any>;
     private doRequest;
     private shouldRefreshToken;
     private request;

package/dist/api/restful/index.js

@@ -1,5 +1,5 @@
-import Api from '../index.js';
 import { EBayInvalidAccessToken, handleEBayError } from '../../errors/index.js';
+import Api from '../index.js';
 export const defaultApiHeaders = {
     'Content-Type': 'application/json',
     'Cache-Control': 'no-cache',
@@ -53,7 +53,8 @@ export default class Restful extends Api {
             sandbox: this.config.sandbox,
             tld: 'ebay.com',
             headers: {},
-            returnResponse: false
+            returnResponse: false,
+            sign: false
         };
     }
     get baseUrl() {
@@ -79,17 +80,23 @@ export default class Restful extends Api {
     get apiz() {
         return this.api({ subdomain: 'apiz' });
     }
-    async get(url, config = {}, apiConfig) {
-        return this.doRequest({ method: 'get', url, config }, apiConfig);
+    /**
+     * Sign request
+     */
+    get sign() {
+        return this.api({ sign: true });
+    }
+    async get(path, config = {}, apiConfig) {
+        return this.doRequest({ method: 'get', path, config }, apiConfig);
     }
-    async delete(url, config = {}, apiConfig) {
-        return this.doRequest({ method: 'delete', url, config }, apiConfig);
+    async delete(path, config = {}, apiConfig) {
+        return this.doRequest({ method: 'delete', path, config }, apiConfig);
     }
-    async post(url, data, config = {}, apiConfig) {
-        return this.doRequest({ method: 'post', url, data, config }, apiConfig);
+    async post(path, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'post', path, data, config }, apiConfig);
     }
-    async put(url, data, config = {}, apiConfig) {
-        return this.doRequest({ method: 'put', url, data, config }, apiConfig);
+    async put(path, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'put', path, data, config }, apiConfig);
     }
     get additionalHeaders() {
         return Object.keys(additionalHeaders)
@@ -101,18 +108,24 @@ export default class Restful extends Api {
             return headers;
         }, {});
     }
-    async enrichRequestConfig(config = {}, apiConfig = this.apiConfig) {
+    async enrichRequestConfig(apiRequest, payload = null, apiConfig = this.apiConfig) {
         const authHeader = await this.auth.getHeaderAuthorization(apiConfig.useIaf);
+        const signatureHeaders = apiConfig.sign ? this.getDigitalSignatureHeaders({
+            method: apiRequest.method.toUpperCase(),
+            authority: Restful.buildServerUrl('', apiConfig.subdomain, apiConfig.sandbox, apiConfig.tld),
+            path: apiConfig.apiVersion + apiConfig.basePath + apiRequest.path
+        }, payload) : {};
         const headers = {
             ...defaultApiHeaders,
             ...this.additionalHeaders,
             ...authHeader,
-            ...apiConfig.headers
+            ...apiConfig.headers,
+            ...signatureHeaders
         };
         return {
-            ...config,
+            ...apiRequest.config,
             headers: {
-                ...(config.headers || {}),
+                ...(apiRequest.config.headers || {}),
                 ...headers
             }
         };
@@ -139,14 +152,14 @@ export default class Restful extends Api {
         return error?.meta?.res?.status === 401 && this.apiConfig.basePath === '/post-order/v2';
     }
     async request(apiRequest, apiConfig = this.apiConfig, refreshToken = false) {
-        const { url, method, data, config } = apiRequest;
+        const { path, method, data } = apiRequest;
         const apiCfg = { ...this.apiConfig, ...apiConfig };
-        const endpoint = this.getServerUrl(apiCfg) + url;
+        const endpoint = this.getServerUrl(apiCfg) + path;
         try {
             if (refreshToken) {
                 await this.auth.OAuth2.refreshToken();
             }
-            const enrichedConfig = await this.enrichRequestConfig(config, apiCfg);
+            const enrichedConfig = await this.enrichRequestConfig(apiRequest, data, apiCfg);
             const args = ['get', 'delete'].includes(method) ? [enrichedConfig] : [data, enrichedConfig];
             // @ts-ignore
             const response = await this.req[method](endpoint, ...args);

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

@@ -1,5 +1,5 @@
+import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkCreateKeywordRequest, BulkCreateNegativeKeywordRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, BulkUpdateAdStatusByListingIdRequest, BulkUpdateAdStatusRequest, BulkUpdateKeywordRequest, BulkUpdateNegativeKeywordRequest, CloneCampaignRequest, CreateAdGroupRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateKeywordRequest, CreateNegativeKeywordRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, TargetedBidRequest, TargetedKeywordRequest, UpdateAdGroupRequest, UpdateAdrateStrategyRequest, UpdateBidPercentageRequest, UpdateCampaignBudgetRequest, UpdateCampaignIdentificationRequest, UpdateKeywordRequest, UpdateNegativeKeywordRequest } from '../../../../types/index.js';
 import Restful from '../../index.js';
-import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, CloneCampaignRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, UpdateBidPercentageRequest, UpdateCampaignIdentificationRequest } from '../../../../types/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>
@@ -61,6 +61,22 @@ export default class Marketing extends Restful {
      * @param body Container for the bulk request to update ads.
      */
     bulkUpdateAdsBidByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<any>;
+    /**
+     * 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: string, body: BulkUpdateAdStatusRequest): Promise<any>;
+    /**
+     * 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: string, body: BulkUpdateAdStatusByListingIdRequest): Promise<any>;
     /**
      * This method retrieves all the ads for the specified campaign.
      *
@@ -140,6 +156,57 @@ export default class Marketing extends Restful {
      * @param body This type defines the fields for the updateBid request.
      */
     updateBid(campaignId: string, adId: string, body: UpdateBidPercentageRequest): Promise<any>;
+    /**
+     *
+     * @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: string, { adGroupStatus, limit, offset }?: {
+        adGroupStatus?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @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: string, body: CreateAdGroupRequest): Promise<any>;
+    /**
+     *
+     * @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: string, adGroupId: string): Promise<any>;
+    /**
+     *
+     * @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: string, adGroupId: string, body: UpdateAdGroupRequest): Promise<any>;
+    /**
+     *
+     * @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: string, adGroupId: string, body: TargetedBidRequest): Promise<any>;
+    /**
+     *
+     * @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: string, adGroupId: string, body: TargetedKeywordRequest): Promise<any>;
     /**
      * This method clones (makes a copy of) the specified campaign.
      *
@@ -236,6 +303,30 @@ export default class Marketing extends Restful {
      *     a seller's campaign IDs by calling getCampaigns.
      */
     resumeCampaign(campaignId: string): Promise<any>;
+    /**
+     *
+     * @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: string, { categoryIds, limit, offset }?: {
+        categoryIds?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @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: string, body: UpdateAdrateStrategyRequest): Promise<any>;
+    /**
+     *
+     * @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: string, body: UpdateCampaignBudgetRequest): Promise<any>;
     /**
      * This method replaces the name and the start and end dates of a campaign.
      *
@@ -244,6 +335,98 @@ export default class Marketing extends Restful {
      * @param body This type defines the fields to updated the campaign name and start and end dates.
      */
     updateCampaignIdentification(campaignId: string, body: UpdateCampaignIdentificationRequest): Promise<any>;
+    /**
+     *
+     * @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: string, body: BulkCreateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @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: string, body: BulkUpdateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @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: string, { adGroupIds, keywordStatus, limit, offset }?: {
+        adGroupIds?: string;
+        keywordStatus?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @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: string, body: CreateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @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: string, keywordId: string): Promise<any>;
+    /**
+     *
+     * @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: string, keywordId: string, body: UpdateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkCreateNegativeKeyword(body: BulkCreateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkUpdateNegativeKeyword(body: BulkUpdateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @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 }?: {
+        adGroupIds?: string;
+        campaignIds?: string;
+        limit?: number;
+        negativeKeywordStatus?: string;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the request to create a negative keyword.
+     */
+    createNegativeKeyword(body: CreateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param negativeKeywordId The unique identifier for the negative keyword.
+     */
+    getNegativeKeyword(negativeKeywordId: string): Promise<any>;
+    /**
+     *
+     * @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: string, body: UpdateNegativeKeywordRequest): Promise<any>;
     /**
      * This call downloads the report as specified by the report_id path parameter.
      *