ebay-api 7.1.3 → 8.0.0

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

@@ -0,0 +1,78 @@
+/// <reference types="node" resolution-mode="require"/>
+import Restful from '../../index.js';
+/**
+ * Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items
+ * for sale, and the most likely categories under which buyers can browse or search for items to purchase.
+ */
+export default class Taxonomy extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the
+     * default for that marketplace.
+     *
+     * @param marketplaceId The ID of the eBay marketplace for which the category tree ID is being requested.
+     */
+    getDefaultCategoryTreeId(marketplaceId: string): Promise<any>;
+    /**
+     * This call retrieves the complete category tree that is identified by the category_tree_id parameter.
+     *
+     * @param categoryTreeId
+     */
+    getCategoryTree(categoryTreeId: string): Promise<any>;
+    /**
+     * This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified
+     * category of a category tree.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree from which a category subtree is being
+     *     requested.
+     * @param categoryId The unique identifier of the category at the top of the subtree being requested.
+     */
+    getCategorySubtree(categoryTreeId: string, categoryId: string): Promise<any>;
+    /**
+     * This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay
+     *  to most closely correspond to the query string q.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree for which suggested nodes are being
+     *     requested.
+     * @param q A quoted string that describes or characterizes the item being offered for sale.
+     */
+    getCategorySuggestions(categoryTreeId: string, q: string): Promise<any>;
+    /**
+     * This call returns a list of aspects that are appropriate or necessary for accurately describing items in the
+     * specified leaf category.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree from which the specified category's
+     *     aspects are being requested.
+     * @param categoryId The unique identifier of the leaf category for which aspects are being requested.
+     */
+    getItemAspectsForCategory(categoryTreeId: string, categoryId: string): Promise<any>;
+    /**
+     * This call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible
+     * with a motor vehicle part or accessory.
+     *
+     * @param categoryTreeId This is the unique identifier of category tree. The following is the list of
+     * category_tree_id values and the eBay marketplaces that they represent.
+     *
+     * @param categoryId The unique identifier of an eBay category.
+     */
+    getCompatibilityProperties(categoryTreeId: string, categoryId: string): Promise<any>;
+    /**
+     * This call retrieves applicable compatible vehicle property values based on the specified eBay marketplace,
+     * specified eBay category, and filters used in the request.
+     *
+     * @param categoryTreeId This is the unique identifier of the category tree.
+     * @param categoryId The unique identifier of an eBay category.
+     * @param compatibilityProperty One compatible vehicle property applicable to the specified eBay marketplace and
+     *     eBay category is specified in this required filter.
+     */
+    getCompatibilityPropertyValues(categoryTreeId: string, categoryId: string, compatibilityProperty: string): Promise<any>;
+    /**
+     * This call returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace.
+     *
+     * @param categoryTreeId
+     *
+     * @return A JSON GZIP compressed file buffer
+     */
+    fetchItemAspects(categoryTreeId: string): Promise<Buffer>;
+}

package/dist/api/restful/commerce/taxonomy/index.js

@@ -0,0 +1,128 @@
+import Restful from '../../index.js';
+/**
+ * Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items
+ * for sale, and the most likely categories under which buyers can browse or search for items to purchase.
+ */
+export default class Taxonomy extends Restful {
+    get basePath() {
+        return '/commerce/taxonomy/v1';
+    }
+    /**
+     * A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the
+     * default for that marketplace.
+     *
+     * @param marketplaceId The ID of the eBay marketplace for which the category tree ID is being requested.
+     */
+    getDefaultCategoryTreeId(marketplaceId) {
+        return this.get(`/get_default_category_tree_id`, {
+            params: {
+                marketplace_id: marketplaceId
+            }
+        });
+    }
+    /**
+     * This call retrieves the complete category tree that is identified by the category_tree_id parameter.
+     *
+     * @param categoryTreeId
+     */
+    getCategoryTree(categoryTreeId) {
+        const cId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${cId}`);
+    }
+    /**
+     * This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified
+     * category of a category tree.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree from which a category subtree is being
+     *     requested.
+     * @param categoryId The unique identifier of the category at the top of the subtree being requested.
+     */
+    getCategorySubtree(categoryTreeId, categoryId) {
+        categoryTreeId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${categoryTreeId}/get_category_subtree`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay
+     *  to most closely correspond to the query string q.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree for which suggested nodes are being
+     *     requested.
+     * @param q A quoted string that describes or characterizes the item being offered for sale.
+     */
+    getCategorySuggestions(categoryTreeId, q) {
+        return this.get(`/category_tree/${categoryTreeId}/get_category_suggestions`, {
+            params: {
+                q
+            }
+        });
+    }
+    /**
+     * This call returns a list of aspects that are appropriate or necessary for accurately describing items in the
+     * specified leaf category.
+     *
+     * @param categoryTreeId The unique identifier of the eBay category tree from which the specified category's
+     *     aspects are being requested.
+     * @param categoryId The unique identifier of the leaf category for which aspects are being requested.
+     */
+    getItemAspectsForCategory(categoryTreeId, categoryId) {
+        categoryTreeId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${categoryTreeId}/get_item_aspects_for_category`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * This call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible
+     * with a motor vehicle part or accessory.
+     *
+     * @param categoryTreeId This is the unique identifier of category tree. The following is the list of
+     * category_tree_id values and the eBay marketplaces that they represent.
+     *
+     * @param categoryId The unique identifier of an eBay category.
+     */
+    getCompatibilityProperties(categoryTreeId, categoryId) {
+        categoryTreeId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${categoryTreeId}/get_compatibility_properties`, {
+            params: {
+                category_id: categoryId
+            }
+        });
+    }
+    /**
+     * This call retrieves applicable compatible vehicle property values based on the specified eBay marketplace,
+     * specified eBay category, and filters used in the request.
+     *
+     * @param categoryTreeId This is the unique identifier of the category tree.
+     * @param categoryId The unique identifier of an eBay category.
+     * @param compatibilityProperty One compatible vehicle property applicable to the specified eBay marketplace and
+     *     eBay category is specified in this required filter.
+     */
+    getCompatibilityPropertyValues(categoryTreeId, categoryId, compatibilityProperty) {
+        categoryTreeId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${categoryTreeId}/get_compatibility_property_values`, {
+            params: {
+                category_id: categoryId,
+                compatibility_property: compatibilityProperty
+            }
+        });
+    }
+    /**
+     * This call returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace.
+     *
+     * @param categoryTreeId
+     *
+     * @return A JSON GZIP compressed file buffer
+     */
+    fetchItemAspects(categoryTreeId) {
+        categoryTreeId = encodeURIComponent(categoryTreeId);
+        return this.get(`/category_tree/${categoryTreeId}/fetch_item_aspects`, {
+            responseType: 'arraybuffer'
+        });
+    }
+}
+Taxonomy.id = 'Taxonomy';

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

@@ -0,0 +1,15 @@
+import Restful from '../../index.js';
+import { TranslateRequest } from '../../../../types/index.js';
+/**
+ * This API allows 3rd party developers to translate item title, description, search query.
+ */
+export default class Translation extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * Translates input text inot a given language.
+     *
+     * @param body TranslateRequest
+     */
+    translate(body: TranslateRequest): Promise<any>;
+}

package/dist/api/restful/commerce/translation/index.js

@@ -0,0 +1,18 @@
+import Restful from '../../index.js';
+/**
+ * This API allows 3rd party developers to translate item title, description, search query.
+ */
+export default class Translation extends Restful {
+    get basePath() {
+        return '/commerce/translation/v1_beta';
+    }
+    /**
+     * Translates input text inot a given language.
+     *
+     * @param body TranslateRequest
+     */
+    translate(body) {
+        return this.post(`/translate`, body);
+    }
+}
+Translation.id = 'Translation';

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

@@ -0,0 +1,22 @@
+import Restful from '../../index.js';
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+export default class Analytics extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method retrieves the call limit and utilization data for an application.
+     *
+     * @param apiContext This optional query parameter filters the result to include only the specified API context.
+     * @param apiName This optional query parameter filters the result to include only the APIs specified.
+     */
+    getRateLimits(apiContext: string, apiName: string): Promise<any>;
+    /**
+     * This method retrieves the call limit and utilization data for an application user.
+     *
+     * @param apiContext This optional query parameter filters the result to include only the specified API context.
+     * @param apiName This optional query parameter filters the result to include only the APIs specified.
+     */
+    getUserRateLimits(apiContext: string, apiName: string): Promise<any>;
+}

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

@@ -0,0 +1,38 @@
+import Restful from '../../index.js';
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+export default class Analytics extends Restful {
+    get basePath() {
+        return '/developer/analytics/v1_beta';
+    }
+    /**
+     * This method retrieves the call limit and utilization data for an application.
+     *
+     * @param apiContext This optional query parameter filters the result to include only the specified API context.
+     * @param apiName This optional query parameter filters the result to include only the APIs specified.
+     */
+    getRateLimits(apiContext, apiName) {
+        return this.get(`/rate_limit/`, {
+            params: {
+                api_context: apiContext,
+                api_name: apiName
+            }
+        });
+    }
+    /**
+     * This method retrieves the call limit and utilization data for an application user.
+     *
+     * @param apiContext This optional query parameter filters the result to include only the specified API context.
+     * @param apiName This optional query parameter filters the result to include only the APIs specified.
+     */
+    getUserRateLimits(apiContext, apiName) {
+        return this.get(`/user_rate_limit/`, {
+            params: {
+                api_context: apiContext,
+                api_name: apiName
+            }
+        });
+    }
+}
+Analytics.id = 'Analytics';

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

@@ -0,0 +1,7 @@
+import Analytics from './analytics/index.js';
+import KeyManagement from './keyManagement/index.js';
+export type Developer = {
+    analytics: Analytics;
+    keyManagement: KeyManagement;
+};
+export { Analytics, KeyManagement };

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

@@ -0,0 +1,3 @@
+import Analytics from './analytics/index.js';
+import KeyManagement from './keyManagement/index.js';
+export { Analytics, KeyManagement };

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

@@ -0,0 +1,26 @@
+import Restful from '../../index.js';
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+export default class KeyManagement extends Restful {
+    static id: string;
+    get subdomain(): string;
+    get basePath(): string;
+    /**
+     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
+     * and metadata for all keypairs associated with the application key making the call.
+     */
+    getSigningKeys(): Promise<any>;
+    /**
+     * his method creates keypairs.
+     */
+    createSigningKey(data: {
+        signingKeyCipher: string;
+    }): 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.
+     * @param signingKeyId the signin key
+     */
+    getSigningKey(signingKeyId: string): Promise<any>;
+}

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

@@ -0,0 +1,34 @@
+import Restful from '../../index.js';
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+export default class KeyManagement extends Restful {
+    get subdomain() {
+        return 'apiz';
+    }
+    get basePath() {
+        return '/developer/key_management/v1';
+    }
+    /**
+     * This method returns the <b>Public Key</b>, <b>Public Key as JWE</b>,
+     * and metadata for all keypairs associated with the application key making the call.
+     */
+    getSigningKeys() {
+        return this.get(`/signing_key`);
+    }
+    /**
+     * his method creates keypairs.
+     */
+    createSigningKey(data) {
+        return this.post(`/signing_key`, data);
+    }
+    /**
+     * 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.
+     * @param signingKeyId the signin key
+     */
+    getSigningKey(signingKeyId) {
+        return this.get(`/signing_key/${signingKeyId}`);
+    }
+}
+KeyManagement.id = 'KeyManagement';

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

@@ -0,0 +1,62 @@
+import Api from '../index.js';
+import Auth from '../../auth/index.js';
+import { IEBayApiRequest } from '../../request.js';
+import { ApiRequestConfig, AppConfig } from '../../types/index.js';
+export declare const defaultApiHeaders: Record<string, string>;
+export type RestfulApiConfig = {
+    subdomain?: string;
+    useIaf?: boolean;
+    apiVersion?: string;
+    basePath?: string;
+    schema?: string;
+    sandbox?: boolean;
+    tld?: string;
+} & ApiRequestConfig;
+export type ApiRequest = {
+    method: keyof IEBayApiRequest;
+    url: string;
+    config?: any;
+    data?: any;
+};
+export interface IRestful {
+    new (config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: RestfulApiConfig): Restful;
+    id: string;
+}
+export default abstract class Restful extends Api {
+    readonly apiConfig: Required<RestfulApiConfig>;
+    constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: RestfulApiConfig);
+    static buildServerUrl(schema: string, subdomain: string, sandbox: boolean, tld: string): string;
+    abstract get basePath(): string;
+    /**
+     * Enable to supports the use of OAuth tokens for user authorization.
+     */
+    get useIaf(): boolean;
+    get schema(): string;
+    get subdomain(): string;
+    get apiVersionPath(): string;
+    getServerUrl({ schema, subdomain, apiVersion, basePath, sandbox, tld }: Required<RestfulApiConfig>): string;
+    getApiConfig(): Required<RestfulApiConfig>;
+    get baseUrl(): string;
+    /**
+     * Create a new instances of it self with specified api config.
+     * @param apiConfig
+     */
+    api(apiConfig: RestfulApiConfig): this;
+    /**
+     * Use "apix" subdomain
+     */
+    get apix(): this;
+    /**
+     * 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>;
+    get additionalHeaders(): any;
+    enrichRequestConfig(config?: any, apiConfig?: Required<RestfulApiConfig>): Promise<any>;
+    private doRequest;
+    private shouldRefreshToken;
+    private request;
+}

package/dist/api/restful/index.js

@@ -0,0 +1,164 @@
+import Api from '../index.js';
+import { EBayInvalidAccessToken, handleEBayError } from '../../errors/index.js';
+export const defaultApiHeaders = {
+    'Content-Type': 'application/json',
+    'Cache-Control': 'no-cache',
+    // @ts-ignore
+    ...(typeof window === 'undefined' ? {
+        'Accept-Encoding': 'application/gzip'
+    } : {})
+};
+const additionalHeaders = {
+    marketplaceId: 'X-EBAY-C-MARKETPLACE-ID',
+    endUserCtx: 'X-EBAY-C-ENDUSERCTX',
+    acceptLanguage: 'Accept-Language',
+    contentLanguage: 'Content-Language',
+};
+export default class Restful extends Api {
+    constructor(config, req, auth, apiConfig = {}) {
+        super(config, req, auth);
+        this.apiConfig = {
+            ...this.getApiConfig(),
+            ...apiConfig
+        };
+    }
+    static buildServerUrl(schema, subdomain, sandbox, tld) {
+        return `${schema}${subdomain}.${sandbox ? 'sandbox.' : ''}${tld}`;
+    }
+    /**
+     * Enable to supports the use of OAuth tokens for user authorization.
+     */
+    get useIaf() {
+        return false;
+    }
+    get schema() {
+        return 'https://';
+    }
+    get subdomain() {
+        return 'api';
+    }
+    get apiVersionPath() {
+        return '';
+    }
+    getServerUrl({ schema, subdomain, apiVersion, basePath, sandbox, tld }) {
+        return Restful.buildServerUrl(schema, subdomain, sandbox, tld) + apiVersion + basePath;
+    }
+    getApiConfig() {
+        return {
+            subdomain: this.subdomain,
+            useIaf: this.useIaf,
+            apiVersion: this.apiVersionPath,
+            basePath: this.basePath,
+            schema: this.schema,
+            sandbox: this.config.sandbox,
+            tld: 'ebay.com',
+            headers: {},
+            returnResponse: false
+        };
+    }
+    get baseUrl() {
+        return this.getServerUrl(this.apiConfig);
+    }
+    /**
+     * Create a new instances of it self with specified api config.
+     * @param apiConfig
+     */
+    api(apiConfig) {
+        // @ts-ignore
+        return new this.constructor(this.config, this.req, this.auth, apiConfig);
+    }
+    /**
+     * Use "apix" subdomain
+     */
+    get apix() {
+        return this.api({ subdomain: 'apix' });
+    }
+    /**
+     * Use "apiz" subdomain
+     */
+    get apiz() {
+        return this.api({ subdomain: 'apiz' });
+    }
+    async get(url, config = {}, apiConfig) {
+        return this.doRequest({ method: 'get', url, config }, apiConfig);
+    }
+    async delete(url, config = {}, apiConfig) {
+        return this.doRequest({ method: 'delete', url, config }, apiConfig);
+    }
+    async post(url, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'post', url, data, config }, apiConfig);
+    }
+    async put(url, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'put', url, data, config }, apiConfig);
+    }
+    get additionalHeaders() {
+        return Object.keys(additionalHeaders)
+            // @ts-ignore
+            .filter(key => typeof this.config[key] !== 'undefined')
+            .reduce((headers, key) => {
+            // @ts-ignore
+            headers[additionalHeaders[key]] = this.config[key];
+            return headers;
+        }, {});
+    }
+    async enrichRequestConfig(config = {}, apiConfig = this.apiConfig) {
+        const authHeader = await this.auth.getHeaderAuthorization(apiConfig.useIaf);
+        const headers = {
+            ...defaultApiHeaders,
+            ...this.additionalHeaders,
+            ...authHeader,
+            ...apiConfig.headers
+        };
+        return {
+            ...config,
+            headers: {
+                ...(config.headers || {}),
+                ...headers
+            }
+        };
+    }
+    async doRequest(payload, apiConfig) {
+        try {
+            return await this.request(payload, apiConfig);
+        }
+        catch (error) {
+            if (this.shouldRefreshToken(error)) {
+                // Try again and refresh token
+                return await this.request(payload, apiConfig, true /* refresh token */);
+            }
+            throw error;
+        }
+    }
+    shouldRefreshToken(error) {
+        if (!this.config.autoRefreshToken) {
+            return false;
+        }
+        if (error.name === EBayInvalidAccessToken.name) {
+            return true;
+        }
+        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 apiCfg = { ...this.apiConfig, ...apiConfig };
+        const endpoint = this.getServerUrl(apiCfg) + url;
+        try {
+            if (refreshToken) {
+                await this.auth.OAuth2.refreshToken();
+            }
+            const enrichedConfig = await this.enrichRequestConfig(config, apiCfg);
+            const args = ['get', 'delete'].includes(method) ? [enrichedConfig] : [data, enrichedConfig];
+            // @ts-ignore
+            const response = await this.req[method](endpoint, ...args);
+            if (this.apiConfig.returnResponse) {
+                return response;
+            }
+            else {
+                return response.data;
+            }
+        }
+        catch (ex) {
+            handleEBayError(ex);
+        }
+    }
+}

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

@@ -0,0 +1,57 @@
+import Restful from '../../index.js';
+import { CancellationSearchParams, ConfirmRefundRequest, CreateCancelRequest, RejectCancelRequest } from '../../../../types/index.js';
+/**
+ * Post-Order Cancellation API
+ */
+export default class Cancellation extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * Seller approves a cancellation request
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
+     */
+    approveCancellationRequest(cancelId: string): Promise<any>;
+    /**
+     * Check the eligibility of an order cancellation
+     *
+     * @param legacyOrderId The unique ID of the order being canceled or the order being considered for cancellation.
+     */
+    checkCancellationEligibility(legacyOrderId: string): Promise<any>;
+    /**
+     * Buyer confirms the refund from a cancellation was received
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation/refund being confirmed.
+     * @param payload the ConfirmRefundReceivedPayload
+     */
+    confirmRefundReceived(cancelId: string, payload?: ConfirmRefundRequest): Promise<any>;
+    /**
+     * Request or perform an order cancellation.
+     *
+     * @param payload the CreateCancelRequest
+     */
+    createCancellation(payload: CreateCancelRequest): Promise<any>;
+    /**
+     * Retrieve the details of an order cancellation.
+     *
+     * @param cancelId Supply in this path parameter the unique eBay-assigned ID of the cancellation request to
+     *     retrieve.
+     * @param fieldGroups    The value set in this query parameter controls the level of detail that is returned in the
+     *     response.
+     */
+    getCancellation(cancelId: string, fieldGroups?: string): Promise<any>;
+    /**
+     * Seller rejects a cancellation request.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the RejectCancelRequest
+     */
+    rejectCancellationRequest(cancelId: string, payload?: RejectCancelRequest): Promise<any>;
+    /**
+     * Search for cancellations.
+     *
+     * @param params the SearchParams
+     */
+    search(params: CancellationSearchParams): Promise<any>;
+}