phonic 0.30.3 → 0.30.4

package/README.md

@@ -3,7 +3,7 @@
 [![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](https://img.shields.io/npm/v/phonic)](https://www.npmjs.com/package/phonic)
 
-The Phonic TypeScript library provides convenient access to the Phonic API from TypeScript.
+The Phonic TypeScript library provides convenient access to the Phonic APIs from TypeScript.
 
 ## Installation
 

package/dist/cjs/Client.js

@@ -50,8 +50,8 @@ class PhonicClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phonic",
-                "X-Fern-SDK-Version": "0.30.3",
-                "User-Agent": "phonic/0.30.3",
+                "X-Fern-SDK-Version": "0.30.4",
+                "User-Agent": "phonic/0.30.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.30.3";
+export declare const SDK_VERSION = "0.30.4";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.30.3";
+exports.SDK_VERSION = "0.30.4";

package/dist/esm/Client.d.mts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments.mjs";
+import * as core from "./core/index.mjs";
+import { Agents } from "./api/resources/agents/client/Client.mjs";
+import { Tools } from "./api/resources/tools/client/Client.mjs";
+import { ExtractionSchemas } from "./api/resources/extractionSchemas/client/Client.mjs";
+import { Voices } from "./api/resources/voices/client/Client.mjs";
+import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Projects } from "./api/resources/projects/client/Client.mjs";
+export declare namespace PhonicClient {
+    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 | undefined> | 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 | undefined> | undefined>;
+    }
+}
+export declare class PhonicClient {
+    protected readonly _options: PhonicClient.Options;
+    protected _agents: Agents | undefined;
+    protected _tools: Tools | undefined;
+    protected _extractionSchemas: ExtractionSchemas | undefined;
+    protected _voices: Voices | undefined;
+    protected _conversations: Conversations | undefined;
+    protected _projects: Projects | undefined;
+    constructor(_options?: PhonicClient.Options);
+    get agents(): Agents;
+    get tools(): Tools;
+    get extractionSchemas(): ExtractionSchemas;
+    get voices(): Voices;
+    get conversations(): Conversations;
+    get projects(): Projects;
+}

package/dist/esm/Client.mjs

@@ -0,0 +1,47 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "./core/index.mjs";
+import { mergeHeaders } from "./core/headers.mjs";
+import { Agents } from "./api/resources/agents/client/Client.mjs";
+import { Tools } from "./api/resources/tools/client/Client.mjs";
+import { ExtractionSchemas } from "./api/resources/extractionSchemas/client/Client.mjs";
+import { Voices } from "./api/resources/voices/client/Client.mjs";
+import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Projects } from "./api/resources/projects/client/Client.mjs";
+export class PhonicClient {
+    constructor(_options = {}) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "phonic",
+                "X-Fern-SDK-Version": "0.30.4",
+                "User-Agent": "phonic/0.30.4",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get agents() {
+        var _a;
+        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Agents(this._options)));
+    }
+    get tools() {
+        var _a;
+        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Tools(this._options)));
+    }
+    get extractionSchemas() {
+        var _a;
+        return ((_a = this._extractionSchemas) !== null && _a !== void 0 ? _a : (this._extractionSchemas = new ExtractionSchemas(this._options)));
+    }
+    get voices() {
+        var _a;
+        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Voices(this._options)));
+    }
+    get conversations() {
+        var _a;
+        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Conversations(this._options)));
+    }
+    get projects() {
+        var _a;
+        return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new Projects(this._options)));
+    }
+}

package/dist/esm/api/errors/BadRequestError.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class BadRequestError extends errors.PhonicError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/BadRequestError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class BadRequestError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}

package/dist/esm/api/errors/ConflictError.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class ConflictError extends errors.PhonicError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/ConflictError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class ConflictError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ConflictError",
+            statusCode: 409,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ConflictError.prototype);
+    }
+}

package/dist/esm/api/errors/ForbiddenError.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class ForbiddenError extends errors.PhonicError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/ForbiddenError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class ForbiddenError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}

package/dist/esm/api/errors/GatewayTimeoutError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as Phonic from "../index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class GatewayTimeoutError extends errors.PhonicError {
+    constructor(body: Phonic.Error_, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/GatewayTimeoutError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class GatewayTimeoutError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "GatewayTimeoutError",
+            statusCode: 504,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, GatewayTimeoutError.prototype);
+    }
+}

package/dist/esm/api/errors/InternalServerError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as Phonic from "../index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class InternalServerError extends errors.PhonicError {
+    constructor(body: Phonic.BasicError, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/InternalServerError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class InternalServerError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}

package/dist/esm/api/errors/NotFoundError.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class NotFoundError extends errors.PhonicError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/NotFoundError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class NotFoundError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}

package/dist/esm/api/errors/UnauthorizedError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as Phonic from "../index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class UnauthorizedError extends errors.PhonicError {
+    constructor(body: Phonic.BasicError, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/UnauthorizedError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class UnauthorizedError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+    }
+}

package/dist/esm/api/errors/index.d.mts

@@ -0,0 +1,7 @@
+export * from "./NotFoundError.mjs";
+export * from "./InternalServerError.mjs";
+export * from "./BadRequestError.mjs";
+export * from "./UnauthorizedError.mjs";
+export * from "./ForbiddenError.mjs";
+export * from "./ConflictError.mjs";
+export * from "./GatewayTimeoutError.mjs";

package/dist/esm/api/errors/index.mjs

@@ -0,0 +1,7 @@
+export * from "./NotFoundError.mjs";
+export * from "./InternalServerError.mjs";
+export * from "./BadRequestError.mjs";
+export * from "./UnauthorizedError.mjs";
+export * from "./ForbiddenError.mjs";
+export * from "./ConflictError.mjs";
+export * from "./GatewayTimeoutError.mjs";

package/dist/esm/api/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./resources/index.mjs";
+export * from "./types/index.mjs";
+export * from "./errors/index.mjs";
+export * from "./types/overrides.mjs";

package/dist/esm/api/index.mjs

@@ -0,0 +1,4 @@
+export * from "./resources/index.mjs";
+export * from "./types/index.mjs";
+export * from "./errors/index.mjs";
+export * from "./types/overrides.mjs";

package/dist/esm/api/resources/agents/client/Client.d.mts

@@ -0,0 +1,208 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Phonic from "../../../index.mjs";
+export declare namespace Agents {
+    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 | undefined> | 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 | undefined> | undefined>;
+    }
+}
+export declare class Agents {
+    protected readonly _options: Agents.Options;
+    constructor(_options?: Agents.Options);
+    /**
+     * Returns all agents in a project.
+     *
+     * @param {Phonic.AgentsListRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.agents.list()
+     */
+    list(request?: Phonic.AgentsListRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsListResponse>;
+    private __list;
+    /**
+     * Creates a new agent in a project.
+     *
+     * @param {Phonic.AgentsCreateRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.agents.create({
+     *         project: "main",
+     *         body: {
+     *             name: "support-agent",
+     *             phone_number: "assign-automatically",
+     *             timezone: "America/Los_Angeles",
+     *             voice_id: "grant",
+     *             audio_speed: 1,
+     *             welcome_message: "Hi {{customer_name}}. How can I help you today?",
+     *             system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
+     *             template_variables: {
+     *                 "customer_name": {},
+     *                 "subject": {
+     *                     default_value: "Chess"
+     *                 }
+     *             },
+     *             tools: ["keypad_input"],
+     *             no_input_poke_sec: 30,
+     *             no_input_poke_text: "Are you still there?",
+     *             boosted_keywords: ["Load ID", "dispatch"],
+     *             configuration_endpoint: {
+     *                 url: "https://api.example.com/config",
+     *                 headers: {
+     *                     "Authorization": "Bearer token123"
+     *                 },
+     *                 timeout_ms: 7000
+     *             }
+     *         }
+     *     })
+     */
+    create(request: Phonic.AgentsCreateRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsCreateResponse>;
+    private __create;
+    /**
+     * Upserts an agent by name. If an agent with the same name already exists, it will be updated. Otherwise, it will be created.
+     *
+     * @param {Phonic.UpsertAgentRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.NotFoundError}
+     *
+     * @example
+     *     await client.agents.upsert({
+     *         project: "main",
+     *         name: "support-agent",
+     *         phone_number: "assign-automatically",
+     *         timezone: "America/Los_Angeles",
+     *         voice_id: "grant",
+     *         audio_speed: 1,
+     *         welcome_message: "Hi {{customer_name}}. How can I help you today?",
+     *         system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
+     *         template_variables: {
+     *             "customer_name": {},
+     *             "subject": {
+     *                 default_value: "Chess"
+     *             }
+     *         },
+     *         tools: ["keypad_input"],
+     *         no_input_poke_sec: 30,
+     *         no_input_poke_text: "Are you still there?",
+     *         boosted_keywords: ["Load ID", "dispatch"],
+     *         configuration_endpoint: {
+     *             url: "https://api.example.com/config",
+     *             headers: {
+     *                 "Authorization": "Bearer token123"
+     *             },
+     *             timeout_ms: 7000
+     *         }
+     *     })
+     */
+    upsert(request: Phonic.UpsertAgentRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsUpsertResponse>;
+    private __upsert;
+    /**
+     * Returns an agent by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the agent to get.
+     * @param {Phonic.AgentsGetRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     *
+     * @example
+     *     await client.agents.get("nameOrId", {
+     *         project: "main"
+     *     })
+     */
+    get(nameOrId: string, request?: Phonic.AgentsGetRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsGetResponse>;
+    private __get;
+    /**
+     * Deletes an agent by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the agent to delete.
+     * @param {Phonic.AgentsDeleteRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     *
+     * @example
+     *     await client.agents.delete("nameOrId", {
+     *         project: "main"
+     *     })
+     */
+    delete(nameOrId: string, request?: Phonic.AgentsDeleteRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsDeleteResponse>;
+    private __delete;
+    /**
+     * Updates an agent by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the agent to update.
+     * @param {Phonic.UpdateAgentRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     *
+     * @example
+     *     await client.agents.update("nameOrId", {
+     *         project: "main",
+     *         name: "updated-support-agent",
+     *         phone_number: "assign-automatically",
+     *         timezone: "America/Los_Angeles",
+     *         voice_id: "grant",
+     *         audio_speed: 1,
+     *         welcome_message: "Hi {{customer_name}}. How can I help you today?",
+     *         system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
+     *         template_variables: {
+     *             "customer_name": {},
+     *             "subject": {
+     *                 default_value: "Chess"
+     *             }
+     *         },
+     *         tools: ["keypad_input"],
+     *         no_input_poke_sec: 30,
+     *         no_input_poke_text: "Are you still there?",
+     *         boosted_keywords: ["Load ID", "dispatch"],
+     *         configuration_endpoint: {
+     *             url: "https://api.example.com/config",
+     *             headers: {
+     *                 "Authorization": "Bearer token123"
+     *             },
+     *             timeout_ms: 7000
+     *         }
+     *     })
+     */
+    update(nameOrId: string, request?: Phonic.UpdateAgentRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Phonic.AgentsUpdateResponse>;
+    private __update;
+    protected _getAuthorizationHeader(): Promise<string>;
+}