import { type Agent } from "./_shims/index.js"; import * as Core from "./core.js"; import * as Errors from "./error.js"; import * as Uploads from "./uploads.js"; import * as API from "./resources/index.js"; import { Lookup, LookupLookupParams, LookupLookupResponse } from "./resources/lookup.js"; import { Notify, NotifyGetSubscriptionConfigResponse, NotifyGetSubscriptionPhoneNumberResponse, NotifyListSubscriptionConfigsParams, NotifyListSubscriptionConfigsResponse, NotifyListSubscriptionPhoneNumberEventsParams, NotifyListSubscriptionPhoneNumberEventsResponse, NotifyListSubscriptionPhoneNumbersParams, NotifyListSubscriptionPhoneNumbersResponse, NotifySendBatchParams, NotifySendBatchResponse, NotifySendParams, NotifySendResponse } from "./resources/notify.js"; import { Transactional, TransactionalSendParams, TransactionalSendResponse } from "./resources/transactional.js"; import { Verification, VerificationCheckParams, VerificationCheckResponse, VerificationCreateParams, VerificationCreateResponse } from "./resources/verification.js"; import { VerificationManagement, VerificationManagementDeletePhoneNumberParams, VerificationManagementDeletePhoneNumberResponse, VerificationManagementListPhoneNumbersResponse, VerificationManagementListSenderIDsResponse, VerificationManagementSetPhoneNumberParams, VerificationManagementSetPhoneNumberResponse, VerificationManagementSubmitSenderIDParams, VerificationManagementSubmitSenderIDResponse } from "./resources/verification-management.js"; import { Watch, WatchPredictParams, WatchPredictResponse, WatchSendEventsParams, WatchSendEventsResponse, WatchSendFeedbacksParams, WatchSendFeedbacksResponse } from "./resources/watch.js"; export interface ClientOptions { /** * Bearer token for authorizing API requests. */ apiToken?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['PRELUDE_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. * * @unit milliseconds */ timeout?: number | undefined; /** * 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 | undefined; /** * 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 | undefined; /** * 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 | undefined; /** * 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 | undefined; } /** * API Client for interfacing with the Prelude API. */ export declare class Prelude extends Core.APIClient { #private; apiToken: string; private _options; /** * API Client for interfacing with the Prelude API. * * @param {string | undefined} [opts.apiToken=process.env['API_TOKEN'] ?? undefined] * @param {string} [opts.baseURL=process.env['PRELUDE_BASE_URL'] ?? https://api.prelude.dev] - 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, apiToken, ...opts }?: ClientOptions); lookup: API.Lookup; notify: API.Notify; transactional: API.Transactional; verification: API.Verification; verificationManagement: API.VerificationManagement; watch: API.Watch; protected defaultQuery(): Core.DefaultQuery | undefined; protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected stringifyQuery(query: Record): string; static Prelude: typeof Prelude; static DEFAULT_TIMEOUT: number; static PreludeError: typeof Errors.PreludeError; 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 namespace Prelude { export type RequestOptions = Core.RequestOptions; export { Lookup as Lookup, type LookupLookupResponse as LookupLookupResponse, type LookupLookupParams as LookupLookupParams, }; export { Notify as Notify, type NotifyGetSubscriptionConfigResponse as NotifyGetSubscriptionConfigResponse, type NotifyGetSubscriptionPhoneNumberResponse as NotifyGetSubscriptionPhoneNumberResponse, type NotifyListSubscriptionConfigsResponse as NotifyListSubscriptionConfigsResponse, type NotifyListSubscriptionPhoneNumberEventsResponse as NotifyListSubscriptionPhoneNumberEventsResponse, type NotifyListSubscriptionPhoneNumbersResponse as NotifyListSubscriptionPhoneNumbersResponse, type NotifySendResponse as NotifySendResponse, type NotifySendBatchResponse as NotifySendBatchResponse, type NotifyListSubscriptionConfigsParams as NotifyListSubscriptionConfigsParams, type NotifyListSubscriptionPhoneNumberEventsParams as NotifyListSubscriptionPhoneNumberEventsParams, type NotifyListSubscriptionPhoneNumbersParams as NotifyListSubscriptionPhoneNumbersParams, type NotifySendParams as NotifySendParams, type NotifySendBatchParams as NotifySendBatchParams, }; export { Transactional as Transactional, type TransactionalSendResponse as TransactionalSendResponse, type TransactionalSendParams as TransactionalSendParams, }; export { Verification as Verification, type VerificationCreateResponse as VerificationCreateResponse, type VerificationCheckResponse as VerificationCheckResponse, type VerificationCreateParams as VerificationCreateParams, type VerificationCheckParams as VerificationCheckParams, }; export { VerificationManagement as VerificationManagement, type VerificationManagementDeletePhoneNumberResponse as VerificationManagementDeletePhoneNumberResponse, type VerificationManagementListPhoneNumbersResponse as VerificationManagementListPhoneNumbersResponse, type VerificationManagementListSenderIDsResponse as VerificationManagementListSenderIDsResponse, type VerificationManagementSetPhoneNumberResponse as VerificationManagementSetPhoneNumberResponse, type VerificationManagementSubmitSenderIDResponse as VerificationManagementSubmitSenderIDResponse, type VerificationManagementDeletePhoneNumberParams as VerificationManagementDeletePhoneNumberParams, type VerificationManagementSetPhoneNumberParams as VerificationManagementSetPhoneNumberParams, type VerificationManagementSubmitSenderIDParams as VerificationManagementSubmitSenderIDParams, }; export { Watch as Watch, type WatchPredictResponse as WatchPredictResponse, type WatchSendEventsResponse as WatchSendEventsResponse, type WatchSendFeedbacksResponse as WatchSendFeedbacksResponse, type WatchPredictParams as WatchPredictParams, type WatchSendEventsParams as WatchSendEventsParams, type WatchSendFeedbacksParams as WatchSendFeedbacksParams, }; } export { toFile, fileFromPath } from "./uploads.js"; export { PreludeError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js"; export default Prelude; //# sourceMappingURL=index.d.ts.map