import type { RequestInit, RequestInfo } from "./internal/builtin-types.js"; import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js"; export type { Logger, LogLevel } from "./internal/utils/log.js"; import * as Opts from "./internal/request-options.js"; import * as Errors from "./core/error.js"; import * as Uploads from "./core/uploads.js"; import * as API from "./resources/index.js"; import { APIPromise } from "./core/api-promise.js"; import { Campaign, CampaignCreateParams, CampaignInput, CampaignListParams, CampaignListResponse, CampaignRetrieveResponse, CampaignSendTestParams, CampaignUpdateParams, CampaignUpdateStatusParams, Campaigns } from "./resources/campaigns.js"; import { Health, HealthCheckResponse } from "./resources/health.js"; import { Import, ImportCreateSubscribersParams } from "./resources/import.js"; import { List, ListCreateParams, ListCreateResponse, ListInput, ListListParams, ListListResponse, ListRetrieveResponse, ListUpdateParams, Lists } from "./resources/lists.js"; import { Media, MediaListResponse, MediaUploadParams } from "./resources/media.js"; import { SettingUpdateParams, Settings } from "./resources/settings.js"; import { Subscriber, SubscriberBulkUpdateListsParams, SubscriberCreateParams, SubscriberCreateResponse, SubscriberInput, SubscriberListParams, SubscriberListResponse, SubscriberRetrieveResponse, SubscriberUpdateParams, Subscribers } from "./resources/subscribers.js"; import { TemplateCreateParams, TemplateInput, TemplateListResponse, TemplateUpdateParams, Templates } from "./resources/templates.js"; import { type Fetch } from "./internal/builtin-types.js"; import { HeadersLike, NullableHeaders } from "./internal/headers.js"; import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js"; import { type LogLevel, type Logger } from "./internal/utils/log.js"; export interface ClientOptions { /** * Defaults to process.env['LISTMONK_PATIENT_HJ6V_USERNAME']. */ username?: string | null | undefined; /** * Defaults to process.env['LISTMONK_PATIENT_HJ6V_PASSWORD']. */ password?: string | null | undefined; /** * Defaults to process.env['LISTMONK_PATIENT_HJ6V_API_KEY']. */ apiKey?: string | null | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['LISTMONK_PATIENT_HJ6V_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; /** * Additional `RequestInit` options to be passed to `fetch` calls. * Properties will be overridden by per-request `fetchOptions`. */ fetchOptions?: MergedRequestInit | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we expect that `fetch` is defined globally. */ fetch?: 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 `null` in request options. */ defaultHeaders?: HeadersLike | 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?: Record | undefined; /** * Set the log level. * * Defaults to process.env['LISTMONK_PATIENT_HJ6V_LOG'] or 'warn' if it isn't set. */ logLevel?: LogLevel | undefined; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined; } /** * API Client for interfacing with the Listmonk Patient Hj6v API. */ export declare class ListmonkPatientHj6v { #private; username: string | null; password: string | null; apiKey: string | null; baseURL: string; maxRetries: number; timeout: number; logger: Logger | undefined; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Listmonk Patient Hj6v API. * * @param {string | null | undefined} [opts.username=process.env['LISTMONK_PATIENT_HJ6V_USERNAME'] ?? null] * @param {string | null | undefined} [opts.password=process.env['LISTMONK_PATIENT_HJ6V_PASSWORD'] ?? null] * @param {string | null | undefined} [opts.apiKey=process.env['LISTMONK_PATIENT_HJ6V_API_KEY'] ?? null] * @param {string} [opts.baseURL=process.env['LISTMONK_PATIENT_HJ6V_BASE_URL'] ?? http://localhost:8086/api] - 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 {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls. * @param {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 {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Record} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, username, password, apiKey, ...opts }?: ClientOptions); /** * Create a new client instance re-using the same options given to the current client with optional overriding. */ withOptions(options: Partial): this; protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; protected authHeaders(opts: FinalRequestOptions): Promise; protected basicAuth(opts: FinalRequestOptions): Promise; protected apiKeyAuth(opts: FinalRequestOptions): Promise; protected stringifyQuery(query: Record): string; private getUserAgent; protected defaultIdempotencyKey(): string; protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError; buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string; /** * Used as a callback for mutating the given `FinalRequestOptions` object. */ protected prepareOptions(options: FinalRequestOptions): Promise; /** * Used as a callback for mutating the given `RequestInit` object. * * This is useful for cases where you want to add certain headers based off of * the request properties, e.g. `method` or `url`. */ protected prepareRequest(request: RequestInit, { url, options }: { url: string; options: FinalRequestOptions; }): Promise; get(path: string, opts?: PromiseOrValue): APIPromise; post(path: string, opts?: PromiseOrValue): APIPromise; patch(path: string, opts?: PromiseOrValue): APIPromise; put(path: string, opts?: PromiseOrValue): APIPromise; delete(path: string, opts?: PromiseOrValue): APIPromise; private methodRequest; request(options: PromiseOrValue, remainingRetries?: number | null): APIPromise; private makeRequest; fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise; private shouldRetry; private retryRequest; private calculateDefaultRetryTimeoutMillis; buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): Promise<{ req: FinalizedRequestInit; url: string; timeout: number; }>; private buildHeaders; private buildBody; static ListmonkPatientHj6v: typeof ListmonkPatientHj6v; static DEFAULT_TIMEOUT: number; static ListmonkPatientHj6vError: typeof Errors.ListmonkPatientHj6vError; 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; lists: API.Lists; subscribers: API.Subscribers; campaigns: API.Campaigns; templates: API.Templates; import: API.Import; media: API.Media; settings: API.Settings; health: API.Health; } export declare namespace ListmonkPatientHj6v { export type RequestOptions = Opts.RequestOptions; export { Lists as Lists, type List as List, type ListInput as ListInput, type ListCreateResponse as ListCreateResponse, type ListRetrieveResponse as ListRetrieveResponse, type ListListResponse as ListListResponse, type ListCreateParams as ListCreateParams, type ListUpdateParams as ListUpdateParams, type ListListParams as ListListParams, }; export { Subscribers as Subscribers, type Subscriber as Subscriber, type SubscriberInput as SubscriberInput, type SubscriberCreateResponse as SubscriberCreateResponse, type SubscriberRetrieveResponse as SubscriberRetrieveResponse, type SubscriberListResponse as SubscriberListResponse, type SubscriberCreateParams as SubscriberCreateParams, type SubscriberUpdateParams as SubscriberUpdateParams, type SubscriberListParams as SubscriberListParams, type SubscriberBulkUpdateListsParams as SubscriberBulkUpdateListsParams, }; export { Campaigns as Campaigns, type Campaign as Campaign, type CampaignInput as CampaignInput, type CampaignRetrieveResponse as CampaignRetrieveResponse, type CampaignListResponse as CampaignListResponse, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignSendTestParams as CampaignSendTestParams, type CampaignUpdateStatusParams as CampaignUpdateStatusParams, }; export { Templates as Templates, type TemplateInput as TemplateInput, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateUpdateParams as TemplateUpdateParams, }; export { Import as Import, type ImportCreateSubscribersParams as ImportCreateSubscribersParams }; export { Media as Media, type MediaListResponse as MediaListResponse, type MediaUploadParams as MediaUploadParams, }; export { Settings as Settings, type SettingUpdateParams as SettingUpdateParams }; export { Health as Health, type HealthCheckResponse as HealthCheckResponse }; } //# sourceMappingURL=client.d.ts.map