@vansite/ts-sharetribe-flex-sdk/dist/types/endpoints/integrationApi/Events.d.ts

This is a TypeScript SDK for Sharetribe Flex API. It reduces the complexity of the API and provides a more user-friendly interface.

/**
 * @fileoverview Provides the Events class for querying event data in the Sharetribe Integration API.
 * This class allows querying events related to bookings or other entities in a Sharetribe marketplace.
 *
 * For more details, refer to the Integration API documentation:
 * https://www.sharetribe.com/api-reference/integration.html#events
 */
import { AxiosResponse } from "axios";
import IntegrationApi from "./index";
import { EventQueryParameter, EventsResponse } from "../../types/integration/events";
/**
 * Class representing the Events API.
 *
 * The Events API provides access to event data, such as booking events, allowing integration with external systems.
 */
declare class Events {
    private readonly endpoint;
    private readonly axios;
    private readonly headers;
    /**
     * Creates an instance of the Events class.
     *
     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
     */
    constructor(api: IntegrationApi);
    /**
     * Queries event data based on the specified parameters.
     *
     * @template P
     * @param {P & EventQueryParameter} params - Query parameters to filter events.
     * @returns {Promise<EventsResponse<'query'>>} - A promise resolving to the event query response.
     *
     * @example
     * const response = await integrationSdk.events.query({
     *  startAfterSequenceId: 'event-sequence-id',
     *  createdAtStart: '2021-01-01T00:00:00Z',
     *  resourceId: 'resource-id',
     *  relatedResourceId: 'related-resource-id',
     *  eventTypes: ['eventType1', 'eventType2'],
     * });
     *
     * // Access the list of events
     * const eventsList = response.data;
     */
    query<P extends EventQueryParameter>(params: P): Promise<AxiosResponse<EventsResponse<"query">>>;
}
export default Events;
//# sourceMappingURL=Events.d.ts.map