ebay-api 1.13.5 → 6.1.0

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

@@ -0,0 +1,151 @@
+import Restful from '../../';
+import { SellFeedParams } from '../../../../types';
+/**
+ * The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.
+ */
+export default class Feed extends Restful {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method returns the details and status for an array of order tasks based on a specified feed_type or scheduled_id.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the order task.
+     */
+    getOrderTasks({ dateRange, feedType, limit, lookBackDays, offset, scheduleId }?: SellFeedParams): Promise<any>;
+    /**
+     * This method creates an order download task with filter criteria for the order report.
+     *
+     * @param data The CreateOrderTaskRequest
+     */
+    createOrderTask(data: any): Promise<any>;
+    /**
+     * This method retrieves the task details and status of the specified task.
+     *
+     * @param taskId The ID of the task. This ID is generated when the task was created by the createOrderTask method.
+     */
+    getOrderTask(taskId: string): Promise<any>;
+    /**
+     * This method retrieves an array containing the details and status of all schedules based on the specified feed_type.
+     *
+     * @param feedType The feedType associated with the schedule.
+     * @param limit The maximum number of schedules that can be returned on each page of the paginated response.
+     * @param offset The number of schedules to skip in the result set before returning the first schedule in the paginated response.
+     */
+    getSchedules({ feedType, limit, offset, }?: SellFeedParams): Promise<any>;
+    /**
+     * This method creates a schedule, which is a subscription to the specified schedule template.
+     *
+     * @params data The CreateUserScheduleRequest
+     */
+    createSchedule(data: any): Promise<any>;
+    /**
+     * This method retrieves schedule details and status of the specified schedule.
+     *
+     * @param scheduleId The ID of the schedule for which to retrieve the details.
+     */
+    getSchedule(scheduleId: string): Promise<any>;
+    /**
+     * This method updates an existing schedule.
+     *
+     * @param scheduleId The ID of the schedule to update.
+     * @param data The UpdateUserScheduleRequest.
+     */
+    updateSchedule(scheduleId: string, data?: any): Promise<any>;
+    /**
+     * This method deletes an existing schedule.
+     *
+     * @param scheduleId The schedule_id of the schedule to delete.
+     */
+    deleteSchedule(scheduleId: string): Promise<any>;
+    /**
+     * This method downloads the latest result file generated by the schedule.
+     *
+     * @param scheduleId The ID of the schedule for which to retrieve the latest result file.
+     */
+    getLatestResultFile(scheduleId: string): Promise<any>;
+    /**
+     * This method downloads the latest result file generated by the schedule.
+     *
+     * @param scheduleTemplateId The ID of the template to retrieve.
+     */
+    getScheduleTemplate(scheduleTemplateId: string): Promise<any>;
+    /**
+     * This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type.
+     *
+     * @param feedType The feedType associated with the schedule.
+     * @param limit The maximum number of schedules that can be returned on each page of the paginated response.
+     * @param offset The number of schedules to skip in the result set before returning the first schedule in the paginated response.
+     */
+    getScheduleTemplates({ feedType, limit, offset, }?: SellFeedParams): Promise<any>;
+    /**
+     * This method returns the details and status for an array of tasks based on a specified feed_type or scheduledId.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the task.
+     */
+    getTasks({ dateRange, feedType, limit, lookBackDays, offset, scheduleId }?: SellFeedParams): Promise<any>;
+    /**
+     * This method creates an upload task or a download task without filter criteria.
+     *
+     * @param data The CreateTaskRequest.
+     */
+    createTask(data: any): Promise<any>;
+    /**
+     * This method downloads the file previously uploaded using uploadFile.
+     *
+     * @param taskId The task ID associated with the file to be downloaded.
+     */
+    getInputFile(taskId: string): Promise<any>;
+    /**
+     * This method retrieves the generated file that is associated with the specified task ID.
+     *
+     * @param taskId The task ID associated with the file to be downloaded.
+     */
+    getResultFile(taskId: string): Promise<any>;
+    /**
+     * This method retrieves the details and status of the specified task.
+     *
+     * @param taskId The ID of the task.
+     */
+    getTask(taskId: string): Promise<any>;
+    /**
+     * This method associates the specified file with the specified task ID and uploads the input file.
+     *
+     * @param taskId The task_id associated with the file that will be uploaded.
+     * @param data FormDataContentDisposition.
+     */
+    uploadFile(taskId: string, data?: any): Promise<any>;
+    /**
+     * Use this method to return an array of customer service metric tasks.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the task.
+     */
+    getCustomerServiceMetricTasks({ dateRange, feedType, limit, lookBackDays, offset, }?: SellFeedParams): Promise<any>;
+    /**
+     * Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report.
+     *
+     * @params acceptLanguage Use this header to specify the natural language in which the authenticated user desires the response.
+     * @params data The CreateServiceMetricsTaskRequest
+     */
+    createCustomerServiceMetricTask(acceptLanguage: string, data: any): Promise<any>;
+    /**
+     * Use this method to retrieve customer service metric task details for the specified task.
+     *
+     * @param taskId Use this path parameter to specify the task ID value for the customer service metric task to retrieve.
+     */
+    getCustomerServiceMetricTask(taskId: string): Promise<any>;
+}

package/lib/api/restful/sell/feed/index.js

@@ -0,0 +1,255 @@
+"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("../../"));
+const request_1 = require("../../../../request");
+/**
+ * The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.
+ */
+class Feed extends __1.default {
+    get basePath() {
+        return '/sell/feed/v1';
+    }
+    /**
+     * This method returns the details and status for an array of order tasks based on a specified feed_type or scheduled_id.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the order task.
+     */
+    getOrderTasks({ dateRange, feedType, limit, lookBackDays, offset, scheduleId } = {}) {
+        return this.get(`/order_task`, {
+            params: {
+                date_range: dateRange,
+                feed_type: feedType,
+                limit,
+                look_back_days: lookBackDays,
+                offset,
+                schedule_id: scheduleId
+            }
+        });
+    }
+    /**
+     * This method creates an order download task with filter criteria for the order report.
+     *
+     * @param data The CreateOrderTaskRequest
+     */
+    createOrderTask(data) {
+        return this.post(`/order_task`, data);
+    }
+    /**
+     * This method retrieves the task details and status of the specified task.
+     *
+     * @param taskId The ID of the task. This ID is generated when the task was created by the createOrderTask method.
+     */
+    getOrderTask(taskId) {
+        taskId = encodeURIComponent(taskId);
+        return this.get(`/order_task/${taskId}`);
+    }
+    /**
+     * This method retrieves an array containing the details and status of all schedules based on the specified feed_type.
+     *
+     * @param feedType The feedType associated with the schedule.
+     * @param limit The maximum number of schedules that can be returned on each page of the paginated response.
+     * @param offset The number of schedules to skip in the result set before returning the first schedule in the paginated response.
+     */
+    getSchedules({ feedType, limit, offset, } = {}) {
+        return this.get(`/schedule`, {
+            params: {
+                feed_type: feedType,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method creates a schedule, which is a subscription to the specified schedule template.
+     *
+     * @params data The CreateUserScheduleRequest
+     */
+    createSchedule(data) {
+        return this.post(`/schedule`, data);
+    }
+    /**
+     * This method retrieves schedule details and status of the specified schedule.
+     *
+     * @param scheduleId The ID of the schedule for which to retrieve the details.
+     */
+    getSchedule(scheduleId) {
+        scheduleId = encodeURIComponent(scheduleId);
+        return this.get(`/schedule/${scheduleId}`);
+    }
+    /**
+     * This method updates an existing schedule.
+     *
+     * @param scheduleId The ID of the schedule to update.
+     * @param data The UpdateUserScheduleRequest.
+     */
+    updateSchedule(scheduleId, data) {
+        scheduleId = encodeURIComponent(scheduleId);
+        return this.put(`/schedule/${scheduleId}`, data);
+    }
+    /**
+     * This method deletes an existing schedule.
+     *
+     * @param scheduleId The schedule_id of the schedule to delete.
+     */
+    deleteSchedule(scheduleId) {
+        scheduleId = encodeURIComponent(scheduleId);
+        return this.delete(`/schedule/${scheduleId}`);
+    }
+    /**
+     * This method downloads the latest result file generated by the schedule.
+     *
+     * @param scheduleId The ID of the schedule for which to retrieve the latest result file.
+     */
+    getLatestResultFile(scheduleId) {
+        scheduleId = encodeURIComponent(scheduleId);
+        return this.get(`/schedule/${scheduleId}/download_result_file`);
+    }
+    /**
+     * This method downloads the latest result file generated by the schedule.
+     *
+     * @param scheduleTemplateId The ID of the template to retrieve.
+     */
+    getScheduleTemplate(scheduleTemplateId) {
+        scheduleTemplateId = encodeURIComponent(scheduleTemplateId);
+        return this.get(`/schedule_template/${scheduleTemplateId}`);
+    }
+    /**
+     * This method retrieves an array containing the details and status of all schedule templates based on the specified feed_type.
+     *
+     * @param feedType The feedType associated with the schedule.
+     * @param limit The maximum number of schedules that can be returned on each page of the paginated response.
+     * @param offset The number of schedules to skip in the result set before returning the first schedule in the paginated response.
+     */
+    getScheduleTemplates({ feedType, limit, offset, } = {}) {
+        return this.get(`/schedule_template`, {
+            params: {
+                feed_type: feedType,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     * This method returns the details and status for an array of tasks based on a specified feed_type or scheduledId.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the task.
+     */
+    getTasks({ dateRange, feedType, limit, lookBackDays, offset, scheduleId } = {}) {
+        return this.get(`/task`, {
+            params: {
+                date_range: dateRange,
+                feed_type: feedType,
+                limit,
+                look_back_days: lookBackDays,
+                offset,
+                schedule_id: scheduleId
+            }
+        });
+    }
+    /**
+     * This method creates an upload task or a download task without filter criteria.
+     *
+     * @param data The CreateTaskRequest.
+     */
+    createTask(data) {
+        return this.post(`/task`, data);
+    }
+    /**
+     * This method downloads the file previously uploaded using uploadFile.
+     *
+     * @param taskId The task ID associated with the file to be downloaded.
+     */
+    getInputFile(taskId) {
+        taskId = encodeURIComponent(taskId);
+        return this.get(`/task/${taskId}/download_input_file`);
+    }
+    /**
+     * This method retrieves the generated file that is associated with the specified task ID.
+     *
+     * @param taskId The task ID associated with the file to be downloaded.
+     */
+    getResultFile(taskId) {
+        taskId = encodeURIComponent(taskId);
+        return this.get(`/task/${taskId}/download_result_file`);
+    }
+    /**
+     * This method retrieves the details and status of the specified task.
+     *
+     * @param taskId The ID of the task.
+     */
+    getTask(taskId) {
+        taskId = encodeURIComponent(taskId);
+        return this.get(`/task/${taskId}`);
+    }
+    /**
+     * This method associates the specified file with the specified task ID and uploads the input file.
+     *
+     * @param taskId The task_id associated with the file that will be uploaded.
+     * @param data FormDataContentDisposition.
+     */
+    uploadFile(taskId, data) {
+        taskId = encodeURIComponent(taskId);
+        return this.post(`/task/${taskId}/upload_file`, data, {
+            headers: request_1.multipartHeader,
+        });
+    }
+    /**
+     * Use this method to return an array of customer service metric tasks.
+     *
+     * @param dateRange The order tasks creation date range.
+     * @param feedType The feed type associated with the task.
+     * @param limit The maximum number of order tasks that can be returned on each page of the paginated response.
+     * @param lookBackDays The number of previous days in which to search for tasks. Do not use with the date_range parameter.
+     * @param offset The number of order tasks to skip in the result set before returning the first order in the paginated response.
+     * @param scheduleId The schedule ID associated with the task.
+     */
+    getCustomerServiceMetricTasks({ dateRange, feedType, limit, lookBackDays, offset, } = {}) {
+        return this.get(`/customer_service_metric_task`, {
+            params: {
+                date_range: dateRange,
+                feed_type: feedType,
+                limit,
+                look_back_days: lookBackDays,
+                offset,
+            }
+        });
+    }
+    /**
+     * Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report.
+     *
+     * @params acceptLanguage Use this header to specify the natural language in which the authenticated user desires the response.
+     * @params data The CreateServiceMetricsTaskRequest
+     */
+    createCustomerServiceMetricTask(acceptLanguage, data) {
+        return this.post(`/customer_service_metric_task`, data, {
+            headers: {
+                'accept-language': acceptLanguage
+            }
+        });
+    }
+    /**
+     * Use this method to retrieve customer service metric task details for the specified task.
+     *
+     * @param taskId Use this path parameter to specify the task ID value for the customer service metric task to retrieve.
+     */
+    getCustomerServiceMetricTask(taskId) {
+        taskId = encodeURIComponent(taskId);
+        return this.get(`/customer_service_metric_task/${taskId}`);
+    }
+}
+exports.default = Feed;
+Feed.id = 'Feed';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/feed/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAC7B,iDAAoD;AAGpD;;GAEG;AACH,MAAqB,IAAK,SAAQ,WAAO;IAIvC,IAAI,QAAQ;QACV,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACI,aAAa,CAAC,EACE,SAAS,EACT,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,MAAM,EACN,UAAU,KACQ,EAAE;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE;YAC7B,MAAM,EAAE;gBACN,UAAU,EAAE,SAAS;gBACrB,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,cAAc,EAAE,YAAY;gBAC5B,MAAM;gBACN,WAAW,EAAE,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,IAAS;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,MAAc;QAChC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAC,EACE,QAAQ,EACR,KAAK,EACL,MAAM,MACY,EAAE;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;YAC3B,MAAM,EAAE;gBACN,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAS;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,UAAkB;QACnC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAkB,EAAE,IAAU;QAClD,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,UAAU,EAAE,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,UAAkB;QACtC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,UAAU,uBAAuB,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,kBAA0B;QACnD,kBAAkB,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,kBAAkB,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,EACE,QAAQ,EACR,KAAK,EACL,MAAM,MACY,EAAE;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE;YACpC,MAAM,EAAE;gBACN,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,QAAQ,CAAC,EACE,SAAS,EACT,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,MAAM,EACN,UAAU,KACQ,EAAE;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;YACvB,MAAM,EAAE;gBACN,UAAU,EAAE,SAAS;gBACrB,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,cAAc,EAAE,YAAY;gBAC5B,MAAM;gBACN,WAAW,EAAE,UAAU;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,IAAS;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,MAAc;QAChC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,MAAM,sBAAsB,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,MAAc;QACjC,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,MAAM,uBAAuB,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,MAAc;QAC3B,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,MAAM,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,MAAc,EAAE,IAAU;QAC1C,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,MAAM,cAAc,EAAE,IAAI,EAAE;YACpD,OAAO,EAAE,yBAAe;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,6BAA6B,CAAC,EACE,SAAS,EACT,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,MAAM,MACY,EAAE;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE;YAC/C,MAAM,EAAE;gBACN,UAAU,EAAE,SAAS;gBACrB,SAAS,EAAE,QAAQ;gBACnB,KAAK;gBACL,cAAc,EAAE,YAAY;gBAC5B,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,+BAA+B,CAAC,cAAsB,EAAE,IAAS;QACtE,OAAO,IAAI,CAAC,IAAI,CAAC,+BAA+B,EAAE,IAAI,EAAE;YACtD,OAAO,EAAE;gBACP,iBAAiB,EAAE,cAAc;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,4BAA4B,CAAC,MAAc;QAChD,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,iCAAiC,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;;AApSH,uBAqSC;AAnSQ,OAAE,GAAG,MAAM,CAAC"}

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

@@ -0,0 +1,74 @@
+import Restful from '../../';
+/**
+ * The Finances API is used by sellers in eBay's managed payments program to retrieve seller payout information.
+ *
+ * https://api.ebay.com/oauth/api_scope/sell.finances
+ *
+ */
+export default class Finances extends Restful {
+    static id: string;
+    get basePath(): string;
+    get subdomain(): string;
+    /**
+     * Use this call to retrieve the details of a specific seller payout.
+     *
+     * @param payoutId The unique identifier of the payout.
+     */
+    getPayout(payoutId: string): Promise<any>;
+    /**
+     * Use this call to search for and retrieve one or more payout based on their payout date,
+     * or payout status using the filter parameter.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
+     *     call.
+     * @param limit The number of payouts to return per page of the result set.
+     * @param offset Specifies the number of payouts to skip in the result set before returning the first payout in the
+     *     paginated response.
+     */
+    getPayouts({ filter, limit, offset, }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *  Search for and retrieve the details of multiple payouts.
+     *  *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
+     *     call.
+     */
+    getPayoutSummary({ filter, }?: {
+        filter?: string;
+    }): Promise<any>;
+    /**
+     * Retrieve details of one or more monetary transactions.
+     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
+     *     call.
+     * @param limit The number of transaction to return per page of the result set.
+     * @param offset Specifies the number of payouts to skip in the result set before returning the first transaction in the
+     *     paginated response.
+     */
+    getTransactions({ filter, limit, offset, }?: {
+        filter?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     * Retrieve total counts and values of the seller's order sales, seller credits, buyer refunds, and payment holds.
+     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
+     *     call.
+     * @param limit The number of transaction to return per page of the result set.
+     */
+    getTransactionSummary({ filter, }?: {
+        filter?: string;
+    }): Promise<any>;
+    /**
+     * Retrieve detailed information on a TRANSFER transaction type.
+     *
+     * @param transferId The unique identifier of the transfer.
+     */
+    getTransfer(transferId: string): Promise<any>;
+    /**
+     *  Retrieve all pending funds that have not yet been distributed through a seller payout.
+     */
+    getSellerFundsSummary(): Promise<any>;
+}

package/lib/api/restful/sell/finances/index.js

@@ -0,0 +1,105 @@
+"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("../../"));
+/**
+ * The Finances API is used by sellers in eBay's managed payments program to retrieve seller payout information.
+ *
+ * https://api.ebay.com/oauth/api_scope/sell.finances
+ *
+ */
+class Finances extends __1.default {
+    get basePath() {
+        return '/sell/finances/v1';
+    }
+    get subdomain() {
+        return 'apiz';
+    }
+    /**
+     * Use this call to retrieve the details of a specific seller payout.
+     *
+     * @param payoutId The unique identifier of the payout.
+     */
+    getPayout(payoutId) {
+        payoutId = encodeURIComponent(payoutId);
+        return this.get(`/payout/${payoutId}`);
+    }
+    /**
+     * Use this call to search for and retrieve one or more payout based on their payout date,
+     * or payout status using the filter parameter.
+     *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
+     *     call.
+     * @param limit The number of payouts to return per page of the result set.
+     * @param offset Specifies the number of payouts to skip in the result set before returning the first payout in the
+     *     paginated response.
+     */
+    getPayouts({ filter, limit, offset, } = {}) {
+        return this.get(`/payout`, {
+            params: {
+                filter,
+                limit,
+                offset,
+            },
+        });
+    }
+    /**
+     *  Search for and retrieve the details of multiple payouts.
+     *  *
+     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
+     *     call.
+     */
+    getPayoutSummary({ filter, } = {}) {
+        return this.get(`/payout_summary`, { params: { filter } });
+    }
+    /**
+     * Retrieve details of one or more monetary transactions.
+     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
+     *     call.
+     * @param limit The number of transaction to return per page of the result set.
+     * @param offset Specifies the number of payouts to skip in the result set before returning the first transaction in the
+     *     paginated response.
+     */
+    getTransactions({ filter, limit, offset, } = {}) {
+        return this.get(`/transaction`, {
+            params: {
+                filter,
+                limit,
+                offset,
+            },
+        });
+    }
+    /**
+     * Retrieve total counts and values of the seller's order sales, seller credits, buyer refunds, and payment holds.
+     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
+     *     call.
+     * @param limit The number of transaction to return per page of the result set.
+     */
+    getTransactionSummary({ filter, } = {}) {
+        return this.get(`/transaction_summary`, {
+            params: {
+                filter,
+            },
+        });
+    }
+    /**
+     * Retrieve detailed information on a TRANSFER transaction type.
+     *
+     * @param transferId The unique identifier of the transfer.
+     */
+    getTransfer(transferId) {
+        transferId = encodeURIComponent(transferId);
+        return this.get(`/transfer/${transferId}`);
+    }
+    /**
+     *  Retrieve all pending funds that have not yet been distributed through a seller payout.
+     */
+    getSellerFundsSummary() {
+        return this.get(`/seller_funds_summary`);
+    }
+}
+exports.default = Finances;
+Finances.id = 'Finances';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/restful/sell/finances/index.ts"],"names":[],"mappings":";;;;;AAAA,+CAA6B;AAE7B;;;;;GAKG;AACH,MAAqB,QAAS,SAAQ,WAAO;IAI3C,IAAI,QAAQ;QACV,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,QAAgB;QAC/B,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;OASG;IACI,UAAU,CAAC,EACE,MAAM,EACN,KAAK,EACL,MAAM,MAKtB,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;YACzB,MAAM,EAAE;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,EACE,MAAM,MAG5B,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,MAAM,EAAE,EAAC,MAAM,EAAC,EAAC,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,EACE,MAAM,EACN,KAAK,EACL,MAAM,MAK3B,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,EACE,MAAM,MAGjC,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtC,MAAM,EAAE;gBACN,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,UAAkB;QACnC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;;AA3HH,2BA4HC;AA1HQ,WAAE,GAAG,UAAU,CAAC"}