phonic 0.29.1 → 0.30.0-rc2

package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasDeleteRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ExtractionSchemasGetRequest {
+    /**
+     * The name of the project containing the extraction schema. Only used when `nameOrId` is a name.
+     */
+    project?: string;
+}

package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ExtractionSchemasListRequest {
+    /**
+     * The name of the project to list extraction schemas for.
+     */
+    project?: string;
+}

package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         name: "Updated appointment details",
+ *         prompt: "Updated extraction instructions. Dates should be in `9 Apr 2025` format.",
+ *         fields: [{
+ *                 name: "Date",
+ *                 type: "string",
+ *                 description: "The date of the appointment"
+ *             }, {
+ *                 name: "Time",
+ *                 type: "string",
+ *                 description: "The time of the appointment"
+ *             }]
+ *     }
+ */
+export interface UpdateExtractionSchemaRequest {
+    /**
+     * The name of the project containing the extraction schema. Only used when `nameOrId` is a name.
+     */
+    project?: string;
+    /** A name for the extraction schema. */
+    name?: string;
+    /** Instructions for how to extract data from conversations. */
+    prompt?: string;
+    /** Array of field definitions. */
+    fields?: Phonic.ExtractionField[];
+}

package/dist/cjs/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/client/requests/index.d.ts

@@ -0,0 +1,5 @@
+export { type ExtractionSchemasListRequest } from "./ExtractionSchemasListRequest.js";
+export { type CreateExtractionSchemaRequest } from "./CreateExtractionSchemaRequest.js";
+export { type ExtractionSchemasGetRequest } from "./ExtractionSchemasGetRequest.js";
+export { type ExtractionSchemasDeleteRequest } from "./ExtractionSchemasDeleteRequest.js";
+export { type UpdateExtractionSchemaRequest } from "./UpdateExtractionSchemaRequest.js";

package/dist/cjs/api/resources/extractionSchemas/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types/index.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/extractionSchemas/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExtractionSchemasCreateResponse {
+    /** The ID of the created extraction schema. */
+    id: string;
+    /** The name of the created extraction schema. */
+    name: string;
+}

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExtractionSchemasDeleteResponse {
+    /** Whether the extraction schema was deleted successfully. */
+    success: boolean;
+}

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.js";
+export interface ExtractionSchemasGetResponse {
+    extraction_schema: Phonic.ExtractionSchema;
+}

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.js";
+export interface ExtractionSchemasListResponse {
+    extraction_schemas: Phonic.ExtractionSchema[];
+}

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExtractionSchemasUpdateResponse {
+    /** Whether the extraction schema was updated successfully. */
+    success: boolean;
+}

package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/extractionSchemas/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./ExtractionSchemasListResponse.js";
+export * from "./ExtractionSchemasCreateResponse.js";
+export * from "./ExtractionSchemasGetResponse.js";
+export * from "./ExtractionSchemasDeleteResponse.js";
+export * from "./ExtractionSchemasUpdateResponse.js";

package/dist/cjs/api/resources/extractionSchemas/types/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ExtractionSchemasListResponse.js"), exports);
+__exportStar(require("./ExtractionSchemasCreateResponse.js"), exports);
+__exportStar(require("./ExtractionSchemasGetResponse.js"), exports);
+__exportStar(require("./ExtractionSchemasDeleteResponse.js"), exports);
+__exportStar(require("./ExtractionSchemasUpdateResponse.js"), exports);

package/dist/cjs/api/resources/index.d.ts

@@ -0,0 +1,18 @@
+export * as agents from "./agents/index.js";
+export * from "./agents/types/index.js";
+export * as tools from "./tools/index.js";
+export * from "./tools/types/index.js";
+export * as extractionSchemas from "./extractionSchemas/index.js";
+export * from "./extractionSchemas/types/index.js";
+export * as voices from "./voices/index.js";
+export * from "./voices/types/index.js";
+export * as conversations from "./conversations/index.js";
+export * from "./conversations/types/index.js";
+export * as projects from "./projects/index.js";
+export * from "./projects/types/index.js";
+export * from "./agents/client/requests/index.js";
+export * from "./tools/client/requests/index.js";
+export * from "./extractionSchemas/client/requests/index.js";
+export * from "./voices/client/requests/index.js";
+export * from "./conversations/client/requests/index.js";
+export * from "./projects/client/requests/index.js";

package/dist/cjs/api/resources/index.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projects = exports.conversations = exports.voices = exports.extractionSchemas = exports.tools = exports.agents = void 0;
+exports.agents = __importStar(require("./agents/index.js"));
+__exportStar(require("./agents/types/index.js"), exports);
+exports.tools = __importStar(require("./tools/index.js"));
+__exportStar(require("./tools/types/index.js"), exports);
+exports.extractionSchemas = __importStar(require("./extractionSchemas/index.js"));
+__exportStar(require("./extractionSchemas/types/index.js"), exports);
+exports.voices = __importStar(require("./voices/index.js"));
+__exportStar(require("./voices/types/index.js"), exports);
+exports.conversations = __importStar(require("./conversations/index.js"));
+__exportStar(require("./conversations/types/index.js"), exports);
+exports.projects = __importStar(require("./projects/index.js"));
+__exportStar(require("./projects/types/index.js"), exports);
+__exportStar(require("./agents/client/requests/index.js"), exports);
+__exportStar(require("./tools/client/requests/index.js"), exports);
+__exportStar(require("./extractionSchemas/client/requests/index.js"), exports);
+__exportStar(require("./voices/client/requests/index.js"), exports);
+__exportStar(require("./conversations/client/requests/index.js"), exports);
+__exportStar(require("./projects/client/requests/index.js"), exports);

package/dist/cjs/api/resources/projects/client/Client.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 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 Projects {
+    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 Projects {
+    protected readonly _options: Projects.Options;
+    constructor(_options?: Projects.Options);
+    /**
+     * Returns all projects in a workspace.
+     *
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.list()
+     */
+    list(requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsListResponse>;
+    private __list;
+    /**
+     * Creates a new project in a workspace.
+     *
+     * @param {Phonic.CreateProjectRequest} request
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ConflictError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.create({
+     *         name: "customer-support"
+     *     })
+     */
+    create(request: Phonic.CreateProjectRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsCreateResponse>;
+    private __create;
+    /**
+     * Returns a project by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the project to get.
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.get("nameOrId")
+     */
+    get(nameOrId: string, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsGetResponse>;
+    private __get;
+    /**
+     * Deletes a project by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the project to delete.
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.delete("nameOrId")
+     */
+    delete(nameOrId: string, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsDeleteResponse>;
+    private __delete;
+    /**
+     * Updates a project by name or ID.
+     *
+     * @param {string} nameOrId - The name or the ID of the project to update.
+     * @param {Phonic.UpdateProjectRequest} request
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.ConflictError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.update("nameOrId", {
+     *         name: "updated-customer-support",
+     *         default_agent: "another-agent"
+     *     })
+     */
+    update(nameOrId: string, request?: Phonic.UpdateProjectRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsUpdateResponse>;
+    private __update;
+    /**
+     * Returns all conversation evaluation prompts for a project.
+     *
+     * @param {string} id - The ID of the project.
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.listEvalPrompts("id")
+     */
+    listEvalPrompts(id: string, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsListEvalPromptsResponse>;
+    private __listEvalPrompts;
+    /**
+     * Creates a new conversation evaluation prompt for a project.
+     *
+     * @param {string} id - The ID of the project.
+     * @param {Phonic.CreateConversationEvalPromptRequest} request
+     * @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.ConflictError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.projects.createEvalPrompt("id", {
+     *         name: "test_prompt",
+     *         prompt: "The assistant used the word chocolate in the conversation"
+     *     })
+     */
+    createEvalPrompt(id: string, request: Phonic.CreateConversationEvalPromptRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Phonic.ProjectsCreateEvalPromptResponse>;
+    private __createEvalPrompt;
+    protected _getAuthorizationHeader(): Promise<string>;
+}