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 { Account, AccountListResponse } from "./resources/account.js"; import { Auth, AuthCreateParams, AuthCreateResponse, AuthRetrieveResponse } from "./resources/auth.js"; import { AuthorCreateParams, AuthorCreateResponse, AuthorDeleteResponse, AuthorListParams, AuthorListResponse, AuthorRetrieveResponse, AuthorUpdateParams, AuthorUpdateResponse, Authors } from "./resources/authors.js"; import { Content, ContentSubmitParams, ContentSubmitResponse } from "./resources/content.js"; import { ActionCreateParams, ActionCreateResponse, ActionDeleteResponse, ActionListParams, ActionListResponse, ActionRetrieveResponse, ActionUpdateParams, ActionUpdateResponse, Actions } from "./resources/actions/actions.js"; import { Queue, QueueGetStatsParams, QueueGetStatsResponse, QueueRetrieveResponse } from "./resources/queue/queue.js"; import { Wordlist, WordlistGetEmbeddingStatusResponse, WordlistListResponse, WordlistRetrieveResponse, WordlistUpdateParams, WordlistUpdateResponse } from "./resources/wordlist/wordlist.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"; import { webhooks } from "./lib/webhooks.js"; export interface ClientOptions { /** * Defaults to process.env['MODAPI_SECRET_KEY']. */ secretKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['MODERATION_API_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; /** * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. * Only set this option to `true` if you understand the risks and have appropriate mitigations in place. */ dangerouslyAllowBrowser?: boolean | undefined; /** * Set the log level. * * Defaults to process.env['MODERATION_API_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 Moderation API API. */ export declare class ModerationAPI { #private; secretKey: string; baseURL: string; maxRetries: number; timeout: number; logger: Logger; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Moderation API API. * * @param {string | undefined} [opts.secretKey=process.env['MODAPI_SECRET_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['MODERATION_API_BASE_URL'] ?? https://api.moderationapi.com/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 {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. * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. */ constructor({ baseURL, secretKey, ...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 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 ModerationAPI: typeof ModerationAPI; static DEFAULT_TIMEOUT: number; static ModerationAPIError: typeof Errors.ModerationAPIError; 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; authors: API.Authors; queue: API.Queue; actions: API.Actions; content: API.Content; account: API.Account; auth: API.Auth; wordlist: API.Wordlist; static webhooks: typeof webhooks; webhooks: typeof webhooks; } export declare namespace ModerationAPI { export type RequestOptions = Opts.RequestOptions; export { Authors as Authors, type AuthorCreateResponse as AuthorCreateResponse, type AuthorRetrieveResponse as AuthorRetrieveResponse, type AuthorUpdateResponse as AuthorUpdateResponse, type AuthorListResponse as AuthorListResponse, type AuthorDeleteResponse as AuthorDeleteResponse, type AuthorCreateParams as AuthorCreateParams, type AuthorUpdateParams as AuthorUpdateParams, type AuthorListParams as AuthorListParams, }; export { Queue as Queue, type QueueRetrieveResponse as QueueRetrieveResponse, type QueueGetStatsResponse as QueueGetStatsResponse, type QueueGetStatsParams as QueueGetStatsParams, }; export { Actions as Actions, type ActionCreateResponse as ActionCreateResponse, type ActionRetrieveResponse as ActionRetrieveResponse, type ActionUpdateResponse as ActionUpdateResponse, type ActionListResponse as ActionListResponse, type ActionDeleteResponse as ActionDeleteResponse, type ActionCreateParams as ActionCreateParams, type ActionUpdateParams as ActionUpdateParams, type ActionListParams as ActionListParams, }; export { Content as Content, type ContentSubmitResponse as ContentSubmitResponse, type ContentSubmitParams as ContentSubmitParams, }; export { Account as Account, type AccountListResponse as AccountListResponse }; export { Auth as Auth, type AuthCreateResponse as AuthCreateResponse, type AuthRetrieveResponse as AuthRetrieveResponse, type AuthCreateParams as AuthCreateParams, }; export { Wordlist as Wordlist, type WordlistRetrieveResponse as WordlistRetrieveResponse, type WordlistUpdateResponse as WordlistUpdateResponse, type WordlistListResponse as WordlistListResponse, type WordlistGetEmbeddingStatusResponse as WordlistGetEmbeddingStatusResponse, type WordlistUpdateParams as WordlistUpdateParams, }; } //# sourceMappingURL=client.d.ts.map