bam-ticketing-sdk/dist/src/bamgregator/service.d.ts

SDK for B.A.M Ticketing API

import { AxiosInstance } from 'axios';
import { HealthStatus, ListInfo } from '../common/types';
import { Categories, ExternalEvent, ExternalEventsInfo, ExternalEventsQuery, ListEventsQuery, ProviderSpecificId } from './types';
import { Event, ListCategoryQuery } from 'src/event';
export declare class BAMgregatorService {
    readonly client: AxiosInstance;
    readonly version: string;
    constructor(client: AxiosInstance, version: string);
    /**
     * Returns true if the service is reachable
     *
     * @returns Services' online status
     */
    health(): Promise<HealthStatus>;
    /**
     * Returns a list of active events.
     *
     * @param req.q String value for text-based search on event
     * @param req.start_at Date range where the event start_at field is filtered
     * @param req.include_occurrences If true, in case of recurring events it includes occurrences
     * @param req.with Field selector query attribute
     * @returns
     */
    listEvents(req?: ListEventsQuery): Promise<ListInfo<Event>>;
    /**
     * Returns a list of external events.
     *
     * @param req.sort String value for sorting external events
     * @param req.query Textual query to find products that match the query
     * @param req.lat Filters the result set by latitude. Requires lng to be set as well
     * @param req.lng Filters the result set by longitude. Requires lat to be set as well
     * @param req.max_distance Maximum distance in km from the lat/lng coordinates
     * @param req.page Number of the page to retrieve
     * @param req.page_size Number of items per page. Default value is 10
     * @param req.near_ip When set, events near the IP address will be returned. Overrides lat/lng
     * @param req.near_me When set, events near the callers IP address will be returned. Overrides lat/lng and near_ip
     */
    listExternalEvents(req?: ExternalEventsQuery): Promise<ExternalEventsInfo[]>;
    /**
     * Returns queried external event
     *
     * @param req.id External event ID
     * @param req.provider The name of the external provider
     */
    getExternalEvent(req: ProviderSpecificId): Promise<ExternalEvent>;
    /**
     * Returns available categories
     */
    listCategories(req?: ListCategoryQuery): Promise<Categories>;
}
//# sourceMappingURL=service.d.ts.map