import { APIResource } from "../../core/resource.js";
import * as CompanyAPI from "../company/company.js";
import * as DocumentAPI from "./document.js";
import { Document, DocumentGetTextResponse, DocumentRetrieveResponse, QuartrDocument } from "./document.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
/**
 * Direct access to Quartr events and IR documents by ID.
 */
export declare class Quartr extends APIResource {
    document: DocumentAPI.Document;
    /**
     * List all available Quartr document types.
     *
     * Returns the full set of document types that can be used to filter documents via
     * the `type_ids` parameter.
     */
    listDocumentTypes(options?: RequestOptions): APIPromise<QuartrListDocumentTypesResponse>;
    /**
     * List all available Quartr event types.
     *
     * Returns the full set of event types used to categorize Quartr events.
     */
    listEventTypes(options?: RequestOptions): APIPromise<QuartrListEventTypesResponse>;
    /**
     * Retrieve a Quartr event by its ID, including the parent company and all
     * associated documents (e.g. transcript, slides, press release).
     */
    retrieveEvent(eventID: number, options?: RequestOptions): APIPromise<QuartrRetrieveEventResponse>;
}
/**
 * An investor relations event from Quartr (e.g. earnings call, investor day).
 */
export interface QuartrEvent {
    /**
     * The unique Quartr event identifier.
     */
    id: number;
    /**
     * URL to the event's page on Quartr.
     */
    backlink_url: string;
    /**
     * The Quartr company ID that hosted this event.
     */
    company_id: number;
    /**
     * When the event was first added.
     */
    created_at: string;
    /**
     * The date and time of the event.
     */
    date: string;
    /**
     * The fiscal period this event relates to (e.g. 'Q1', 'Q2', 'FY').
     */
    fiscal_period: string | null;
    /**
     * The fiscal year this event relates to, if applicable.
     */
    fiscal_year: number | null;
    /**
     * The title of the event (e.g. 'Q3 2024 Earnings Call').
     */
    title: string;
    /**
     * The event type identifier (e.g. 1 for earnings calls). Use the
     * `quartr_list_event_types` endpoint for the full mapping.
     */
    type_id: number;
    /**
     * When the event record was last updated.
     */
    updated_at: string;
}
export type QuartrListDocumentTypesResponse = Array<QuartrListDocumentTypesResponse.QuartrListDocumentTypesResponseItem>;
export declare namespace QuartrListDocumentTypesResponse {
    /**
     * A Quartr document type.
     */
    interface QuartrListDocumentTypesResponseItem {
        /**
         * The unique identifier of the document type.
         */
        id: number;
        /**
         * The category this document type belongs to.
         */
        category: string;
        /**
         * A description of the document type.
         */
        description: string;
        /**
         * The SEC form type, if applicable.
         */
        form: string | null;
        /**
         * The name of the document type.
         */
        name: string;
    }
}
export type QuartrListEventTypesResponse = Array<QuartrListEventTypesResponse.QuartrListEventTypesResponseItem>;
export declare namespace QuartrListEventTypesResponse {
    /**
     * A Quartr event type.
     */
    interface QuartrListEventTypesResponseItem {
        /**
         * The unique identifier of the event type.
         */
        id: number;
        /**
         * The name of the event type.
         */
        name: string;
        /**
         * The parent category of the event type.
         */
        parent: string | null;
    }
}
/**
 * A Quartr event with its parent company and all associated documents.
 */
export interface QuartrRetrieveEventResponse extends QuartrEvent {
    /**
     * The company that hosted this event.
     */
    company: CompanyAPI.QuartrCompanyResource;
    /**
     * All documents associated with this event.
     */
    documents: Array<DocumentAPI.QuartrDocument>;
}
export declare namespace Quartr {
    export { type QuartrEvent as QuartrEvent, type QuartrListDocumentTypesResponse as QuartrListDocumentTypesResponse, type QuartrListEventTypesResponse as QuartrListEventTypesResponse, type QuartrRetrieveEventResponse as QuartrRetrieveEventResponse, };
    export { Document as Document, type QuartrDocument as QuartrDocument, type DocumentRetrieveResponse as DocumentRetrieveResponse, type DocumentGetTextResponse as DocumentGetTextResponse, };
}
//# sourceMappingURL=quartr.d.ts.map