ebay-api 1.13.7 → 6.2.0

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

@@ -0,0 +1,22 @@
+import Restful from '../../';
+/**
+ * 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/lib/api/restful/developer/analytics/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * This method retrieves the call limit and utilization data for an application.
+ */
+class Analytics extends __1.default {
+    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
+            }
+        });
+    }
+}
+exports.default = Analytics;
+Analytics.id = 'Analytics';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/developer/analytics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/developer/analytics/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAE7B;;GAEG;AACH,MAAqB,SAAU,SAAQ,WAAO;IAI5C,IAAI,QAAQ;QACV,OAAO,8BAA8B,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,UAAkB,EAAE,OAAe;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,WAAW,EAAE,UAAU;gBACvB,QAAQ,EAAE,OAAO;aAClB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,UAAkB,EAAE,OAAe;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,WAAW,EAAE,UAAU;gBACvB,QAAQ,EAAE,OAAO;aAClB;SACF,CAAC,CAAC;IACL,CAAC;;AApCH,4BAqCC;AAnCQ,YAAE,GAAG,WAAW,CAAC"}

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

@@ -0,0 +1,5 @@
+import Analytics from './analytics';
+export declare type Developer = {
+    analytics: Analytics;
+};
+export { Analytics };

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

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const analytics_1 = __importDefault(require("./analytics"));
+exports.Analytics = analytics_1.default;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/restful/developer/index.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAOhC,oBAPG,mBAAS,CAOH"}

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

@@ -0,0 +1,63 @@
+import Api from '../';
+import Auth from '../../auth';
+import { IEBayApiRequest } from '../../request';
+import { AppConfig } from '../../types';
+export declare const defaultApiHeaders: Record<string, string>;
+export declare type ApiConfig = {
+    subdomain?: string;
+    useIaf?: boolean;
+    apiVersion?: string;
+    basePath?: string;
+    schema?: string;
+    sandbox?: boolean;
+    tld?: string;
+    headers?: Record<string, string>;
+};
+export declare type ApiRequest = {
+    method: keyof IEBayApiRequest;
+    url: string;
+    config?: any;
+    data?: any;
+};
+export interface IRestful {
+    new (config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: ApiConfig): Restful;
+    id: string;
+}
+export default abstract class Restful extends Api {
+    readonly apiConfig: Required<ApiConfig>;
+    constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth, apiConfig?: ApiConfig);
+    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<ApiConfig>): string;
+    getApiConfig(): Required<ApiConfig>;
+    get baseUrl(): string;
+    /**
+     * Create a new instances of it self with specified api config.
+     * @param apiConfig
+     */
+    api(apiConfig: ApiConfig): this;
+    /**
+     * Use "apix" subdomain
+     */
+    get apix(): this;
+    /**
+     * Use "apiz" subdomain
+     */
+    get apiz(): this;
+    get(url: string, config?: any, apiConfig?: ApiConfig): Promise<any>;
+    delete(url: string, config?: any, apiConfig?: ApiConfig): Promise<any>;
+    post(url: string, data?: any, config?: any, apiConfig?: ApiConfig): Promise<any>;
+    put(url: string, data?: any, config?: any, apiConfig?: ApiConfig): Promise<any>;
+    get additionalHeaders(): any;
+    enrichRequestConfig(config?: any, apiConfig?: Required<ApiConfig>): Promise<any>;
+    private doRequest;
+    private shouldRefreshToken;
+    private request;
+}

package/lib/api/restful/index.js

@@ -0,0 +1,165 @@
+"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 __1 = __importDefault(require("../"));
+const errors_1 = require("../../errors");
+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 __1.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: {}
+        };
+    }
+    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 = {
+            ...exports.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 === errors_1.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
+            return await this.req[method](endpoint, ...args);
+        }
+        catch (ex) {
+            (0, errors_1.handleEBayError)(ex);
+        }
+    }
+}
+exports.default = Restful;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/restful/index.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAsB;AAEtB,yCAAqE;AAIxD,QAAA,iBAAiB,GAA2B;IACvD,cAAc,EAAE,kBAAkB;IAClC,eAAe,EAAE,UAAU;IAC3B,aAAa;IACb,GAAG,CAAC,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC;QAClC,iBAAiB,EAAE,kBAAkB;KACtC,CAAC,CAAC,CAAC,EAAE,CAAC;CACR,CAAC;AAEF,MAAM,iBAAiB,GAA2B;IAChD,aAAa,EAAE,yBAAyB;IACxC,UAAU,EAAE,qBAAqB;IACjC,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,kBAAkB;CACpC,CAAC;AA0BF,MAA8B,OAAQ,SAAQ,WAAG;IAI/C,YACE,MAAiB,EACjB,GAAqB,EACrB,IAAW,EACX,YAAuB,EAAE;QAEzB,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAEzB,IAAI,CAAC,SAAS,GAAG;YACf,GAAG,IAAI,CAAC,YAAY,EAAE;YACtB,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAgB,EAAE,GAAW;QAC3F,OAAO,GAAG,MAAM,GAAG,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC;IACpE,CAAC;IAID;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAM;QACR,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,YAAY,CAAC,EAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAsB;QAC9F,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,UAAU,GAAG,QAAQ,CAAC;IACzF,CAAC;IAEM,YAAY;QACjB,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,cAAc;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,GAAG,EAAE,UAAU;YACf,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,SAAoB;QAC7B,aAAa;QACb,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,MAAM,EAAC,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,MAAM,EAAC,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,SAAc,EAAE,EAAE,SAAqB;QACnE,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAC,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,SAAc,EAAE,EAAE,SAAqB;QACtE,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAC,EAAE,SAAS,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,IAAU,EAAE,SAAc,EAAE,EAAE,SAAqB;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,EAAE,SAAS,CAAC,CAAC;IACxE,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,IAAU,EAAE,SAAc,EAAE,EAAE,SAAqB;QAC/E,OAAO,IAAI,CAAC,SAAS,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAC,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;YACnC,aAAa;aACZ,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC;aACtD,MAAM,CAAC,CAAC,OAAY,EAAE,GAAG,EAAE,EAAE;YAC5B,aAAa;YACb,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnD,OAAO,OAAO,CAAC;QACjB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,SAAc,EAAE,EAAE,YAAiC,IAAI,CAAC,SAAS;QAChG,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,GAAG,yBAAiB;YACpB,GAAG,IAAI,CAAC,iBAAiB;YACzB,GAAG,UAAU;YACb,GAAG,SAAS,CAAC,OAAO;SACrB,CAAC;QAEF,OAAO;YACL,GAAG,MAAM;YACT,OAAO,EAAE;gBACP,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;gBACzB,GAAG,OAAO;aACX;SACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,OAAmB,EAAE,SAAqB;QAChE,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;SAC/C;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAClC,8BAA8B;gBAC9B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;aACzE;YAED,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAEO,kBAAkB,CAAC,KAAU;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,+BAAsB,CAAC,IAAI,EAAE;YAC9C,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,KAAK,gBAAgB,CAAC;IAC1F,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,UAAsB,EACtB,YAAuB,IAAI,CAAC,SAAS,EACrC,YAAY,GAAG,KAAK;QAEpB,MAAM,EAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAC,GAAG,UAAU,CAAC;QAE/C,MAAM,MAAM,GAAwB,EAAC,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,SAAS,EAAC,CAAC;QACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;QAEjD,IAAI;YACF,IAAI,YAAY,EAAE;gBAChB,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;aACvC;YAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAEtE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;YAC5F,aAAa;YACb,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;SAClD;QAAC,OAAO,EAAE,EAAE;YACX,IAAA,wBAAe,EAAC,EAAE,CAAC,CAAC;SACrB;IACH,CAAC;CACF;AAtLD,0BAsLC"}

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

@@ -0,0 +1,57 @@
+import Restful from '../../';
+import { CancellationSearchParams, ConfirmRefundRequest, CreateCancelRequest, RejectCancelRequest } from '../../../../types';
+/**
+ * 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>;
+}

package/lib/api/restful/postOrder/cancellation/index.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * Post-Order Cancellation API
+ */
+class Cancellation extends __1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Seller approves a cancellation request
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be approved.
+     */
+    approveCancellationRequest(cancelId) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/approve`);
+    }
+    /**
+     * 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) {
+        return this.post(`/cancellation/check_eligibility`, {
+            legacyOrderId
+        });
+    }
+    /**
+     * 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, payload) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/confirm`, payload);
+    }
+    /**
+     * Request or perform an order cancellation.
+     *
+     * @param payload the CreateCancelRequest
+     */
+    createCancellation(payload) {
+        return this.post(`/cancellation`, payload);
+    }
+    /**
+     * 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, fieldGroups) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.get(`/cancellation/${cancelId}`, {
+            params: {
+                fieldgroups: fieldGroups
+            }
+        });
+    }
+    /**
+     * 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, payload) {
+        cancelId = encodeURIComponent(cancelId);
+        return this.post(`/cancellation/${cancelId}/reject`, payload);
+    }
+    /**
+     * Search for cancellations.
+     *
+     * @param params the SearchParams
+     */
+    search(params) {
+        return this.get(`/cancellation/search`, {
+            params: {
+                params
+            }
+        });
+    }
+}
+exports.default = Cancellation;
+Cancellation.id = 'Cancellation';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/postOrder/cancellation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/postOrder/cancellation/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAQ7B;;GAEG;AACH,MAAqB,YAAa,SAAQ,WAAO;IAI/C,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,QAAgB;QAChD,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,QAAQ,UAAU,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,4BAA4B,CAAC,aAAqB;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAClD,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,QAAgB,EAAE,OAA8B;QAC3E,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,OAA4B;QACpD,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,QAAgB,EAAE,WAAoB;QAC3D,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,QAAQ,EAAE,EAAE;YAC3C,MAAM,EAAE;gBACN,WAAW,EAAE,WAAW;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,yBAAyB,CAAC,QAAgB,EAAE,OAA6B;QAC9E,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,QAAQ,SAAS,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAgC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtC,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;;AA5FH,+BA6FC;AA3FQ,eAAE,GAAG,cAAc,CAAC"}

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

@@ -0,0 +1,63 @@
+import Restful from '../../';
+import { AppealRequest, BuyerCloseCaseRequest, CaseSearchParams, ReturnAddressRequest, Text } from '../../../../types';
+/**
+ * Post-Order Case Management API
+ */
+export default class Case extends Restful {
+    static id: string;
+    get basePath(): string;
+    get useIaf(): boolean;
+    /**
+     * Buyer or seller appeals a case decision.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the AppealRequest
+     */
+    appealCaseDecision(caseId: string, payload?: AppealRequest): Promise<any>;
+    /**
+     * Check the eligibility of an order cancellation.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the BuyerCloseCaseRequest
+     */
+    closeCase(caseId: string, payload: BuyerCloseCaseRequest): Promise<any>;
+    /**
+     * Retrieve the details related to a specific case.
+     *
+     * @param caseId The unique identifier of a case.
+     */
+    getCase(caseId: string): Promise<any>;
+    /**
+     * Seller issues a refund for a case.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the CaseVoluntaryRefundRequest (Text)
+     */
+    issueCaseRefund(caseId: string, payload?: Text): Promise<any>;
+    /**
+     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
+     * seller.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
+     *     'USPS'.
+     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
+     */
+    provideReturnShipmentInfo(caseId: string, { shippingCarrierName, trackingNumber }: {
+        shippingCarrierName: string;
+        trackingNumber: string;
+    }): Promise<any>;
+    /**
+     * Seller provides a return address to the buyer.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the ReturnAddressRequest
+     */
+    providesReturnAddress(cancelId: string, payload?: ReturnAddressRequest): Promise<any>;
+    /**
+     * This call is used to search for cases using multiple filter types.
+     *
+     * @param params the SearchParams
+     */
+    search(params: CaseSearchParams): Promise<any>;
+}

package/lib/api/restful/postOrder/case/index.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = __importDefault(require("../../"));
+/**
+ * Post-Order Case Management API
+ */
+class Case extends __1.default {
+    get basePath() {
+        return '/post-order/v2';
+    }
+    get useIaf() {
+        return true;
+    }
+    /**
+     * Buyer or seller appeals a case decision.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the AppealRequest
+     */
+    appealCaseDecision(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/appeal`, payload);
+    }
+    /**
+     * Check the eligibility of an order cancellation.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the BuyerCloseCaseRequest
+     */
+    closeCase(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/close`, payload);
+    }
+    /**
+     * Retrieve the details related to a specific case.
+     *
+     * @param caseId The unique identifier of a case.
+     */
+    getCase(caseId) {
+        const id = encodeURIComponent(caseId);
+        return this.get(`/casemanagement/${id}`);
+    }
+    /**
+     * Seller issues a refund for a case.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param payload the CaseVoluntaryRefundRequest (Text)
+     */
+    issueCaseRefund(caseId, payload) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/issue_refund`, payload);
+    }
+    /**
+     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
+     * seller.
+     *
+     * @param caseId The unique identifier of a case.
+     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
+     *     'USPS'.
+     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
+     */
+    provideReturnShipmentInfo(caseId, { shippingCarrierName, trackingNumber }) {
+        const id = encodeURIComponent(caseId);
+        return this.post(`/casemanagement/${id}/provide_shipment_info`, {
+            shippingCarrierName,
+            trackingNumber
+        });
+    }
+    /**
+     * Seller provides a return address to the buyer.
+     *
+     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
+     * @param payload the ReturnAddressRequest
+     */
+    providesReturnAddress(cancelId, payload) {
+        const id = encodeURIComponent(cancelId);
+        return this.post(`/casemanagement/${id}/provide_return_address`, payload);
+    }
+    /**
+     * This call is used to search for cases using multiple filter types.
+     *
+     * @param params the SearchParams
+     */
+    search(params) {
+        return this.get(`/casemanagement/search`, {
+            params: {
+                params
+            }
+        });
+    }
+}
+exports.default = Case;
+Case.id = 'Case';
+//# sourceMappingURL=index.js.map

package/lib/api/restful/postOrder/case/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/postOrder/case/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAG7B;;GAEG;AACH,MAAqB,IAAK,SAAQ,WAAO;IAIvC,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,MAAc,EAAE,OAAuB;QAC/D,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,MAAc,EAAE,OAA8B;QAC7D,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,MAAc;QAC3B,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,MAAc,EAAE,OAAc;QACnD,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACI,yBAAyB,CAAC,MAAc,EAAE,EAAC,mBAAmB,EAAE,cAAc,EAC5B;QACvD,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,wBAAwB,EAAE;YAC9D,mBAAmB;YACnB,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,QAAgB,EAAE,OAA8B;QAC3E,MAAM,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAwB;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE;YACxC,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;;AA/FH,uBAgGC;AA9FQ,OAAE,GAAG,MAAM,CAAC"}

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

@@ -0,0 +1,11 @@
+import Cancellation from './cancellation';
+import Case from './case';
+import Inquiry from './inquiry';
+import Return from './return';
+export declare type PostOrder = {
+    cancellation: Cancellation;
+    case: Case;
+    inquiry: Inquiry;
+    return: Return;
+};
+export { Cancellation, Case, Inquiry, Return };