ebay-api
Version:
eBay API for Node and Browser
56 lines (55 loc) • 2.69 kB
TypeScript
import Restful from '../../index.js';
/**
* This API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
*/
export default class Deal extends Restful {
static id: string;
get basePath(): string;
/**
* This method retrieves a paginated set of deal items.
*
* @param categoryIds The unique identifier of the eBay category for the search.
* @param commissionable A filter for commissionable deals. Restriction: This filter is currently only supported for the US marketplace.
* @param deliveryCountry A filter for items that can be shipped to the specified country.
* @param limit The maximum number of items, from the current result set, returned on a single page.
* @param offset The number of items that will be skipped in the result set.
*/
getDealItems({ categoryIds, commissionable, deliveryCountry, limit, offset }: {
categoryIds?: string;
commissionable?: string;
deliveryCountry?: string;
limit?: string;
offset?: string;
}): Promise<any>;
/**
* This method retrieves the details for an eBay event.
*
* @param eventId The unique identifier for the eBay event.
*/
getEvent(eventId: string): Promise<any>;
/**
* This method returns paginated results containing all eBay events for the specified marketplace.
*
* @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
* @param offset The number of items that will be skipped in the result set.
*/
getEvents({ limit, offset }: {
limit?: string;
offset?: string;
}): Promise<any>;
/**
* This method returns paginated results containing all eBay events for the specified marketplace.
*
* @param eventIds The unique identifiers for the eBay events. Maximum Value: 1
* @param categoryIds The unique identifier of the eBay category for the search. Maximum Value: 1
* @param deliveryCountry A filter for items that can be shipped to the specified country.
* @param limit The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
* @param offset The number of items that will be skipped in the result set.
*/
getEventItems(eventIds: string, { categoryIds, deliveryCountry, limit, offset }?: {
categoryIds?: string;
deliveryCountry?: string;
limit?: string;
offset?: string;
}): Promise<any>;
}