ebay-api 8.4.1 → 8.5.0

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

@@ -1,42 +1,42 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * This method retrieves the call limit and utilization data for an application.
- */
-class KeyManagement extends index_js_1.default {
-    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`);
-    }
-    /**
-     * This method creates keypairs.
-     */
-    createSigningKey(signingKeyCipher) {
-        return this.post(`/signing_key`, {
-            signingKeyCipher
-        });
-    }
-    /**
-     * 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}`);
-    }
-}
-exports.default = KeyManagement;
-KeyManagement.id = 'KeyManagement';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = __importDefault(require("../../index.js"));
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+class KeyManagement extends index_js_1.default {
+    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`);
+    }
+    /**
+     * This method creates keypairs.
+     */
+    createSigningKey(signingKeyCipher) {
+        return this.post(`/signing_key`, {
+            signingKeyCipher
+        });
+    }
+    /**
+     * 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';
+exports.default = KeyManagement;

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

@@ -1,67 +1,70 @@
-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;
-    sandbox?: boolean;
-    tld?: string;
-} & ApiRequestConfig;
-export type ApiRequest = {
-    method: keyof IEBayApiRequest;
-    path: 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;
-    /**
-     * 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(apiRequest: ApiRequest, payload?: any, apiConfig?: Required<RestfulApiConfig>): Promise<any>;
-    private doRequest;
-    private shouldRefreshToken;
-    private request;
-}
+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;
+    sandbox?: boolean;
+    tld?: string;
+} & ApiRequestConfig;
+export type ApiRequest = {
+    method: keyof IEBayApiRequest;
+    path: string;
+    config?: any;
+    data?: any;
+};
+export interface IRestful {
+    new (config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: RestfulApiConfig): Restful;
+    id: string;
+}
+export type OpenApi<T> = {
+    [K in keyof T]: any;
+};
+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;
+    /**
+     * 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(apiRequest: ApiRequest, payload?: any, apiConfig?: Required<RestfulApiConfig>): Promise<any>;
+    private doRequest;
+    private shouldRefreshToken;
+    private request;
+}

package/lib/api/restful/index.js

@@ -1,187 +1,187 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultApiHeaders = void 0;
-const index_js_1 = require("../../errors/index.js");
-const index_js_2 = __importDefault(require("../index.js"));
-exports.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',
-};
-class Restful extends index_js_2.default {
-    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,
-            sign: 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' });
-    }
-    /**
-     * Sign request
-     */
-    get sign() {
-        return this.api({ sign: true });
-    }
-    async get(path, config = {}, apiConfig) {
-        return this.doRequest({ method: 'get', path, config }, apiConfig);
-    }
-    async delete(path, config = {}, apiConfig) {
-        return this.doRequest({ method: 'delete', path, config }, apiConfig);
-    }
-    async post(path, data, config = {}, apiConfig) {
-        return this.doRequest({ method: 'post', path, data, config }, apiConfig);
-    }
-    async put(path, data, config = {}, apiConfig) {
-        return this.doRequest({ method: 'put', path, 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(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 = {
-            ...exports.defaultApiHeaders,
-            ...this.additionalHeaders,
-            ...authHeader,
-            ...apiConfig.headers,
-            ...signatureHeaders
-        };
-        return {
-            ...apiRequest.config,
-            headers: {
-                ...(apiRequest.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 === index_js_1.EBayInvalidAccessToken.name) {
-            return true;
-        }
-        else if (error?.meta?.res?.status === 403 && this.apiConfig.basePath === '/sell/inventory/v1') {
-            return true;
-        }
-        return error?.meta?.res?.status === 401 && this.apiConfig.basePath === '/post-order/v2';
-    }
-    async request(apiRequest, apiConfig = this.apiConfig, refreshToken = false) {
-        const { path, method, data } = apiRequest;
-        const apiCfg = { ...this.apiConfig, ...apiConfig };
-        const endpoint = this.getServerUrl(apiCfg) + path;
-        try {
-            if (refreshToken) {
-                await this.auth.OAuth2.refreshToken();
-            }
-            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);
-            if (this.apiConfig.returnResponse) {
-                return response;
-            }
-            else {
-                return response.data;
-            }
-        }
-        catch (ex) {
-            (0, index_js_1.handleEBayError)(ex);
-        }
-    }
-}
-exports.default = Restful;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultApiHeaders = void 0;
+const index_js_1 = require("../../errors/index.js");
+const index_js_2 = __importDefault(require("../index.js"));
+exports.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',
+};
+class Restful extends index_js_2.default {
+    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,
+            sign: 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' });
+    }
+    /**
+     * Sign request
+     */
+    get sign() {
+        return this.api({ sign: true });
+    }
+    async get(path, config = {}, apiConfig) {
+        return this.doRequest({ method: 'get', path, config }, apiConfig);
+    }
+    async delete(path, config = {}, apiConfig) {
+        return this.doRequest({ method: 'delete', path, config }, apiConfig);
+    }
+    async post(path, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'post', path, data, config }, apiConfig);
+    }
+    async put(path, data, config = {}, apiConfig) {
+        return this.doRequest({ method: 'put', path, 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(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 = {
+            ...exports.defaultApiHeaders,
+            ...this.additionalHeaders,
+            ...authHeader,
+            ...apiConfig.headers,
+            ...signatureHeaders
+        };
+        return {
+            ...apiRequest.config,
+            headers: {
+                ...(apiRequest.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 === index_js_1.EBayInvalidAccessToken.name) {
+            return true;
+        }
+        else if (error?.meta?.res?.status === 403 && this.apiConfig.basePath === '/sell/inventory/v1') {
+            return true;
+        }
+        return error?.meta?.res?.status === 401 && this.apiConfig.basePath === '/post-order/v2';
+    }
+    async request(apiRequest, apiConfig = this.apiConfig, refreshToken = false) {
+        const { path, method, data } = apiRequest;
+        const apiCfg = { ...this.apiConfig, ...apiConfig };
+        const endpoint = this.getServerUrl(apiCfg) + path;
+        try {
+            if (refreshToken) {
+                await this.auth.OAuth2.refreshToken();
+            }
+            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);
+            if (this.apiConfig.returnResponse) {
+                return response;
+            }
+            else {
+                return response.data;
+            }
+        }
+        catch (ex) {
+            (0, index_js_1.handleEBayError)(ex);
+        }
+    }
+}
+exports.default = Restful;