UNPKG

phonic

Version:

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPhonic-Co%2Fphonic-node) [![npm shield](htt

66 lines (65 loc) 2.69 kB
/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments.js"; import * as core from "../../../../core/index.js"; import * as Phonic from "../../../index.js"; export declare namespace Voices { interface Options { environment?: core.Supplier<environments.PhonicEnvironment | environments.PhonicEnvironmentUrls>; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier<string>; apiKey?: core.Supplier<core.BearerToken | undefined>; /** Additional headers to include in requests. */ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>; fetcher?: core.FetchFunction; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Additional query string parameters to include in the request. */ queryParams?: Record<string, unknown>; /** Additional headers to include in the request. */ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>; } } export declare class Voices { protected readonly _options: Voices.Options; constructor(_options?: Voices.Options); /** * Returns all available voices for a model. * * @param {Phonic.VoicesListRequest} request * @param {Voices.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.BadRequestError} * @throws {@link Phonic.UnauthorizedError} * @throws {@link Phonic.InternalServerError} * * @example * await client.voices.list({ * model: "merritt" * }) */ list(request: Phonic.VoicesListRequest, requestOptions?: Voices.RequestOptions): core.HttpResponsePromise<Phonic.VoicesListResponse>; private __list; /** * Returns a voice by ID. * * @param {string} id - The ID of the voice to get. * @param {Voices.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Phonic.UnauthorizedError} * @throws {@link Phonic.NotFoundError} * * @example * await client.voices.get("id") */ get(id: string, requestOptions?: Voices.RequestOptions): core.HttpResponsePromise<Phonic.VoicesGetResponse>; private __get; protected _getAuthorizationHeader(): Promise<string | undefined>; }