ebay-api 8.5.0 → 8.6.0

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

@@ -1,38 +1,12 @@
 import { SellFeedParams } from '../../../../types/index.js';
 import { operations } from '../../../../types/restful/specs/sell_feed_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * 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 implements OpenApi<operations> {
     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 searches for multiple tasks of a specific feed type, and includes date filters and pagination.
-     */
     getInventoryTasks({ feedType, scheduleId, lookBackDays, dateRange, limit, offset }?: {
         feedType?: string;
         scheduleId?: string;
@@ -41,132 +15,23 @@ export default class Feed extends Restful implements OpenApi<operations> {
         limit?: number;
         offset?: number;
     }): Promise<any>;
-    /**
-     * This method creates an inventory-related download task for a specified feed type with optional filter criteria.
-     */
     createInventoryTask(data: any): Promise<any>;
-    /**
-     * This method retrieves the task details and status of the specified inventory-related task.
-     * @param taskId The ID of the task.
-     */
     getInventoryTask(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

@@ -5,23 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_js_1 = require("../../../../request.js");
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * 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 index_js_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: {
@@ -34,26 +21,13 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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 searches for multiple tasks of a specific feed type, and includes date filters and pagination.
-     */
     getInventoryTasks({ feedType, scheduleId, lookBackDays, dateRange, limit, offset } = {}) {
         return this.get('/inventory_task', {
             params: {
@@ -66,27 +40,13 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * This method creates an inventory-related download task for a specified feed type with optional filter criteria.
-     */
     createInventoryTask(data) {
         return this.post('/inventory_task', data);
     }
-    /**
-     * This method retrieves the task details and status of the specified inventory-related task.
-     * @param taskId The ID of the task.
-     */
     getInventoryTask(taskId) {
         taskId = encodeURIComponent(taskId);
         return this.get(`/inventory_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: {
@@ -96,67 +56,29 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -166,16 +88,6 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -188,63 +100,27 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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_js_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: {
@@ -256,12 +132,6 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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: {
@@ -269,11 +139,6 @@ class Feed extends index_js_1.default {
             }
         });
     }
-    /**
-     * 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}`);

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

@@ -1,79 +1,28 @@
 import { operations } from '../../../../types/restful/specs/sell_finances_v1_oas3.js';
 import Restful, { OpenApi } from '../../index.js';
-/**
- * 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 implements OpenApi<operations> {
     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.
-     * @param sort Allows sorting by payouts date in descending order with '-payoutDate' (default) and ascending with 'payoutDate'
-     */
     getPayouts({ filter, limit, offset, sort, }?: {
         filter?: string;
         limit?: number;
         offset?: number;
         sort?: 'payoutDate' | '-payoutDate';
     }): 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.
-     * @param sort Allows sorting by transaction date in descending order with '-transactionDate' (default) and ascending with 'transactionDate'
-     */
     getTransactions({ filter, limit, offset, sort }?: {
         filter?: string;
         limit?: number;
         offset?: number;
         sort?: 'transactionDate' | '-transactionDate';
     }): 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

@@ -4,12 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = __importDefault(require("../../index.js"));
-/**
- * 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 index_js_1.default {
     get basePath() {
         return '/sell/finances/v1';
@@ -17,26 +11,10 @@ class Finances extends index_js_1.default {
     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.
-     * @param sort Allows sorting by payouts date in descending order with '-payoutDate' (default) and ascending with 'payoutDate'
-     */
     getPayouts({ filter, limit, offset, sort, } = {}) {
         return this.get(`/payout`, {
             params: {
@@ -47,24 +25,9 @@ class Finances extends index_js_1.default {
             },
         });
     }
-    /**
-     *  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.
-     * @param sort Allows sorting by transaction date in descending order with '-transactionDate' (default) and ascending with 'transactionDate'
-     */
     getTransactions({ filter, limit, offset, sort } = {}) {
         return this.get(`/transaction`, {
             params: {
@@ -75,12 +38,6 @@ class Finances extends index_js_1.default {
             },
         });
     }
-    /**
-     * 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: {
@@ -88,18 +45,10 @@ class Finances extends index_js_1.default {
             },
         });
     }
-    /**
-     * 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`);
     }