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 Pagination from "./core/pagination.js"; import { type BodyCursorPageParams, BodyCursorPageResponse, type CursorPageParams, CursorPageResponse, type CursorPageWithoutLimitParams, CursorPageWithoutLimitResponse } from "./core/pagination.js"; import * as Uploads from "./core/uploads.js"; import * as API from "./resources/index.js"; import { APIPromise } from "./core/api-promise.js"; import { V1 } from "./resources/v1/v1.js"; import { V2 } from "./resources/v2/v2.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['METRONOME_BEARER_TOKEN']. */ bearerToken?: string | undefined; /** * Defaults to process.env['METRONOME_WEBHOOK_SECRET']. */ webhookSecret?: string | null | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['METRONOME_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['METRONOME_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 Metronome API. */ export declare class Metronome { #private; bearerToken: string; webhookSecret: string | null; 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 Metronome API. * * @param {string | undefined} [opts.bearerToken=process.env['METRONOME_BEARER_TOKEN'] ?? undefined] * @param {string | null | undefined} [opts.webhookSecret=process.env['METRONOME_WEBHOOK_SECRET'] ?? null] * @param {string} [opts.baseURL=process.env['METRONOME_BASE_URL'] ?? https://api.metronome.com] - 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, bearerToken, webhookSecret, ...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: object | 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; getAPIList = Pagination.AbstractPage>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue): Pagination.PagePromise; requestAPIList = Pagination.AbstractPage>(Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue): Pagination.PagePromise; 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 _makeAbort; private buildBody; static Metronome: typeof Metronome; static DEFAULT_TIMEOUT: number; static MetronomeError: typeof Errors.MetronomeError; 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; webhooks: API.Webhooks; v2: API.V2; v1: API.V1; } export declare namespace Metronome { export type RequestOptions = Opts.RequestOptions; export import CursorPage = Pagination.CursorPage; export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse }; export import BodyCursorPage = Pagination.BodyCursorPage; export { type BodyCursorPageParams as BodyCursorPageParams, type BodyCursorPageResponse as BodyCursorPageResponse, }; export import CursorPageWithoutLimit = Pagination.CursorPageWithoutLimit; export { type CursorPageWithoutLimitParams as CursorPageWithoutLimitParams, type CursorPageWithoutLimitResponse as CursorPageWithoutLimitResponse, }; export { V2 as V2 }; export { V1 as V1 }; export type BalanceFilter = API.BalanceFilter; export type BaseThresholdCommit = API.BaseThresholdCommit; export type BaseUsageFilter = API.BaseUsageFilter; export type Commit = API.Commit; export type CommitHierarchyConfiguration = API.CommitHierarchyConfiguration; export type CommitRate = API.CommitRate; export type CommitSpecifier = API.CommitSpecifier; export type CommitSpecifierInput = API.CommitSpecifierInput; export type Contract = API.Contract; export type ContractV2 = API.ContractV2; export type ContractWithoutAmendments = API.ContractWithoutAmendments; export type Credit = API.Credit; export type CreditTypeData = API.CreditTypeData; export type Discount = API.Discount; export type EventTypeFilter = API.EventTypeFilter; export type HierarchyConfiguration = API.HierarchyConfiguration; export type ID = API.ID; export type Override = API.Override; export type OverrideTier = API.OverrideTier; export type OverwriteRate = API.OverwriteRate; export type PaymentGateConfig = API.PaymentGateConfig; export type PaymentGateConfigV2 = API.PaymentGateConfigV2; export type PrepaidBalanceThresholdConfiguration = API.PrepaidBalanceThresholdConfiguration; export type PrepaidBalanceThresholdConfigurationV2 = API.PrepaidBalanceThresholdConfigurationV2; export type PropertyFilter = API.PropertyFilter; export type ProService = API.ProService; export type Rate = API.Rate; export type RecurringCommitSubscriptionConfig = API.RecurringCommitSubscriptionConfig; export type ScheduledCharge = API.ScheduledCharge; export type ScheduleDuration = API.ScheduleDuration; export type SchedulePointInTime = API.SchedulePointInTime; export type SpendThresholdConfiguration = API.SpendThresholdConfiguration; export type SpendThresholdConfigurationV2 = API.SpendThresholdConfigurationV2; export type Subscription = API.Subscription; export type Tier = API.Tier; export type UpdateBaseThresholdCommit = API.UpdateBaseThresholdCommit; } //# sourceMappingURL=client.d.ts.map