import * as Errors from "./error.js"; import * as Uploads from "./uploads.js"; import { type Agent } from "./_shims/index.js"; import * as Core from "./core.js"; import * as API from "./resources/index.js"; export interface ClientOptions { /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['ENDEX_FACTSET_GLOBAL_FILINGS_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. */ timeout?: number; /** * An HTTP agent used to manage HTTP(S) connections. * * If not provided, an agent will be constructed by default in the Node.js environment, * otherwise no agent is used. */ httpAgent?: Agent; /** * Specify a custom `fetch` function implementation. * * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is * defined globally. */ fetch?: Core.Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `undefined` or `null` in request options. */ defaultHeaders?: Core.Headers; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Core.DefaultQuery; } /** * API Client for interfacing with the Endex Factset Global Filings API. */ export declare class EndexFactsetGlobalFilings extends Core.APIClient { private _options; /** * API Client for interfacing with the Endex Factset Global Filings API. * * @param {string} [opts.baseURL=process.env['ENDEX_FACTSET_GLOBAL_FILINGS_BASE_URL'] ?? https://api.factset.com/global-filings/v1] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, ...opts }?: ClientOptions); filingsDocuments: API.FilingsDocuments; reference: API.Reference; protected defaultQuery(): Core.DefaultQuery | undefined; protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected stringifyQuery(query: Record): string; static EndexFactsetGlobalFilings: typeof EndexFactsetGlobalFilings; static DEFAULT_TIMEOUT: number; static EndexFactsetGlobalFilingsError: typeof Errors.EndexFactsetGlobalFilingsError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static toFile: typeof Uploads.toFile; static fileFromPath: typeof Uploads.fileFromPath; } export declare const EndexFactsetGlobalFilingsError: typeof Errors.EndexFactsetGlobalFilingsError, APIError: typeof Errors.APIError, APIConnectionError: typeof Errors.APIConnectionError, APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError, APIUserAbortError: typeof Errors.APIUserAbortError, NotFoundError: typeof Errors.NotFoundError, ConflictError: typeof Errors.ConflictError, RateLimitError: typeof Errors.RateLimitError, BadRequestError: typeof Errors.BadRequestError, AuthenticationError: typeof Errors.AuthenticationError, InternalServerError: typeof Errors.InternalServerError, PermissionDeniedError: typeof Errors.PermissionDeniedError, UnprocessableEntityError: typeof Errors.UnprocessableEntityError; export import toFile = Uploads.toFile; export import fileFromPath = Uploads.fileFromPath; export declare namespace EndexFactsetGlobalFilings { export import RequestOptions = Core.RequestOptions; export import FilingsDocuments = API.FilingsDocuments; export import InvestmentResearch = API.InvestmentResearch; export import ResponseCount = API.ResponseCount; export import FilingsDocumentCountParams = API.FilingsDocumentCountParams; export import FilingsDocumentSearchParams = API.FilingsDocumentSearchParams; export import Reference = API.Reference; } export default EndexFactsetGlobalFilings; //# sourceMappingURL=index.d.ts.map