phonic 0.32.2 → 0.32.4

package/dist/cjs/api/types/ConversationExtraction.d.ts

@@ -1,13 +1,9 @@
 export interface ConversationExtraction {
     /** The extraction ID. */
     id: string;
-    /** The conversation ID. */
-    conversation_id?: string | undefined;
     schema: ConversationExtraction.Schema;
     /** The extracted data. */
     result: Record<string, unknown>;
-    /** Error message if extraction failed. */
-    error: string | null;
     /** When the extraction was created. */
     created_at: string;
 }
@@ -15,5 +11,7 @@ export declare namespace ConversationExtraction {
     interface Schema {
         id: string;
         name: string;
+        /** Whether the extraction schema has been deleted. */
+        isDeleted: boolean;
     }
 }

package/dist/cjs/api/types/ConversationItem.d.ts

@@ -5,10 +5,12 @@ export interface ConversationItem {
     item_idx: number;
     /** Who spoke in this turn. */
     role: ConversationItem.Role;
-    /** Live transcript of this turn. */
-    live_transcript: string;
+    /** Live transcript of this turn. `null` when the turn has been redacted. */
+    live_transcript: string | null;
     /** Post-call processed transcript. */
     post_call_transcript: string | null;
+    /** The redacted transcript of this turn. `null` when the turn is not redacted. */
+    redacted_transcript?: (string | null) | undefined;
     /** Duration of this turn in milliseconds. */
     duration_ms: number;
     /** When this turn started. */

package/dist/cjs/api/types/CreateAgentRequest.d.ts

@@ -2,6 +2,8 @@ import type * as Phonic from "../index.js";
 export interface CreateAgentRequest {
     /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
     name: string;
+    /** URL-friendly agent slug. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
+    slug?: string | undefined;
     /** When set to `null`, the agent will not be associated with a phone number. When set to `"assign-automatically"`, the agent will be assigned a random phone number. When set to `"custom"`, you must provide `custom_phone_numbers`. */
     phone_number?: (CreateAgentRequest.PhoneNumber | null) | undefined;
     /** The custom phone number to use for the agent in E.164 format (e.g., +1234567890). This field is deprecated. Use `custom_phone_numbers` instead. */
@@ -42,6 +44,12 @@ export interface CreateAgentRequest {
     no_input_poke_text?: string | undefined;
     /** Seconds of silence before ending the conversation. */
     no_input_end_conversation_sec?: number | undefined;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean | undefined;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number | undefined;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
     /** ISO 639-1 language code that sets the agent's default language to recognize and speak. Welcome message and no input poke text should be in this language. */
     default_language?: Phonic.LanguageCode | undefined;
     /** Array of additional ISO 639-1 language codes that the agent should be able to recognize and speak. Should not include `default_language`. */

package/dist/cjs/api/types/DataRetentionPolicy.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Controls how long transcripts and audio recordings are retained before deletion.
+ * When `zero_data_retention` is `true`, nothing is retained and `transcripts`/`audio_recordings` are omitted.
+ */
+export type DataRetentionPolicy = 
+/**
+ * Zero data retention mode. No transcripts or audio recordings are retained. */
+{
+    zero_data_retention: true;
+}
+/**
+ * Standard data retention with configurable deletion windows. */
+ | {
+    zero_data_retention: false;
+    transcripts: {
+        delete_after_hours: number | null;
+    };
+    audio_recordings: {
+        delete_after_hours: number | null;
+    };
+};

package/dist/cjs/api/types/DataRetentionPolicy.js

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

package/dist/cjs/api/types/DtmfPayload.d.ts

@@ -2,4 +2,6 @@ export interface DtmfPayload {
     type: "dtmf";
     /** DTMF digits to play */
     digits: string;
+    /** Optional latency-breakdown metrics for the message, expressed as named millisecond durations. */
+    timings?: Record<string, number> | undefined;
 }

package/dist/cjs/api/types/ExtractionField.d.ts

@@ -3,8 +3,8 @@ export interface ExtractionField {
     name: string;
     /** The field type. */
     type: ExtractionField.Type;
-    /** Description of the field. */
-    description?: (string | null) | undefined;
+    /** Description of the field. May be null, but the property must be present. */
+    description: string | null;
 }
 export declare namespace ExtractionField {
     /** The field type. */

package/dist/cjs/api/types/OutboundCallConfig.d.ts

@@ -47,6 +47,28 @@ export interface OutboundCallConfig {
     tools?: OutboundCallConfig.Tools.Item[] | undefined;
     /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE NUMBER]`) and bleeped from audio recordings after the conversation ends. */
     enable_redaction?: boolean | undefined;
+    /** The speech-to-speech model to use. */
+    model?: "merritt" | undefined;
+    /** The audio speed of the agent. */
+    audio_speed?: number | undefined;
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    background_noise?: (OutboundCallConfig.BackgroundNoise | null) | undefined;
+    /** The background noise level of the agent. */
+    background_noise_level?: number | undefined;
+    /** Array of MCP server names to use. */
+    mcp_servers?: string[] | undefined;
+    /** Array of task objects with `name` and `description` fields. */
+    tasks?: Phonic.Task[] | undefined;
+    /** Pool of phone numbers used for outbound calls. */
+    outbound_number_pool?: (Phonic.OutboundNumberPool | null) | undefined;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean | undefined;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number | undefined;
+    /** When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options. */
+    configuration_endpoint?: (OutboundCallConfig.ConfigurationEndpoint | null) | undefined;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
 }
 export declare namespace OutboundCallConfig {
     /** If `"auto"`, each user audio is automatically identified for the language to respond in. If `"request"`, user must request to change language (recommended). If `"initial"` the first turn user audio determines the language for the rest of the conversation. */
@@ -70,4 +92,22 @@ export declare namespace OutboundCallConfig {
          * Custom tool */
          | string;
     }
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    const BackgroundNoise: {
+        readonly Office: "office";
+        readonly CallCenter: "call-center";
+        readonly CoffeeShop: "coffee-shop";
+    };
+    type BackgroundNoise = (typeof BackgroundNoise)[keyof typeof BackgroundNoise];
+    /**
+     * When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options.
+     */
+    interface ConfigurationEndpoint {
+        /** URL to call */
+        url: string;
+        /** Object of key-value pairs. */
+        headers?: Record<string, string> | undefined;
+        /** Timeout in milliseconds for the endpoint call. */
+        timeout_ms?: number | undefined;
+    }
 }

package/dist/cjs/api/types/OutboundCallConfig.js

@@ -10,4 +10,10 @@ var OutboundCallConfig;
         Request: "request",
         Initial: "initial",
     };
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    OutboundCallConfig.BackgroundNoise = {
+        Office: "office",
+        CallCenter: "call-center",
+        CoffeeShop: "coffee-shop",
+    };
 })(OutboundCallConfig || (exports.OutboundCallConfig = OutboundCallConfig = {}));

package/dist/cjs/api/types/OutboundNumberPool.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Pool of phone numbers used for outbound calls.
+ */
+export interface OutboundNumberPool {
+    /** E.164 formatted phone numbers available for outbound calls. */
+    active: string[];
+    /** E.164 formatted phone numbers that are blocked from being used. */
+    blocked: string[];
+}

package/dist/cjs/api/types/OutboundNumberPool.js

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

package/dist/cjs/api/types/Tool.d.ts

@@ -10,7 +10,7 @@ export interface Tool {
     /** The type of tool. */
     type: Tool.Type;
     /** Mode of operation - sync waits for response, async continues without waiting. */
-    execution_mode: Tool.ExecutionMode;
+    execution_mode?: Tool.ExecutionMode | undefined;
     /** Array of parameter definitions for the tool. */
     parameters: Phonic.ToolParameter[];
     /** HTTP method for webhook tools. */
@@ -43,6 +43,8 @@ export interface Tool {
     allow_tool_chaining?: boolean | undefined;
     /** The agent doesn't typically wait for the response of async custom_websocket tools. When true, makes the agent wait for a response, not call other tools and inform the user of the result. Only available for async custom_websocket tools. */
     wait_for_response?: boolean | undefined;
+    /** The static context returned to the agent. Only present for custom_context tools. */
+    context?: string | undefined;
 }
 export declare namespace Tool {
     interface Project {

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

@@ -1,5 +1,7 @@
 export * from "./AddSystemMessagePayload.js";
 export * from "./Agent.js";
+export * from "./AgentIntegration.js";
+export * from "./ApiKeyWithSecret.js";
 export * from "./AssistantChoseNotToRespondPayload.js";
 export * from "./AssistantEndedConversationPayload.js";
 export * from "./AssistantFinishedSpeakingPayload.js";
@@ -15,6 +17,7 @@ export * from "./ConversationAnalysis.js";
 export * from "./ConversationCreatedPayload.js";
 export * from "./ConversationEval.js";
 export * from "./ConversationEvalPrompt.js";
+export * from "./ConversationEvalPromptInfo.js";
 export * from "./ConversationEvaluation.js";
 export * from "./ConversationEvaluationResult.js";
 export * from "./ConversationExtraction.js";
@@ -23,6 +26,7 @@ export * from "./ConversationsListResponseConversation.js";
 export * from "./ConversationsListResponseConversations.js";
 export * from "./ConversationsListResponseConversationsPagination.js";
 export * from "./CreateAgentRequest.js";
+export * from "./DataRetentionPolicy.js";
 export * from "./DtmfPayload.js";
 export * from "./Error_.js";
 export * from "./ErrorPayload.js";
@@ -40,6 +44,7 @@ export * from "./OpenAiTool.js";
 export * from "./OutboundCallConfig.js";
 export * from "./OutboundCallInitiatedResponse.js";
 export * from "./OutboundDryRunResponse.js";
+export * from "./OutboundNumberPool.js";
 export * from "./Project.js";
 export * from "./ReadyToStartConversationPayload.js";
 export * from "./ReplayConversationItemResponse.js";

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

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AddSystemMessagePayload.js"), exports);
 __exportStar(require("./Agent.js"), exports);
+__exportStar(require("./AgentIntegration.js"), exports);
+__exportStar(require("./ApiKeyWithSecret.js"), exports);
 __exportStar(require("./AssistantChoseNotToRespondPayload.js"), exports);
 __exportStar(require("./AssistantEndedConversationPayload.js"), exports);
 __exportStar(require("./AssistantFinishedSpeakingPayload.js"), exports);
@@ -31,6 +33,7 @@ __exportStar(require("./ConversationAnalysis.js"), exports);
 __exportStar(require("./ConversationCreatedPayload.js"), exports);
 __exportStar(require("./ConversationEval.js"), exports);
 __exportStar(require("./ConversationEvalPrompt.js"), exports);
+__exportStar(require("./ConversationEvalPromptInfo.js"), exports);
 __exportStar(require("./ConversationEvaluation.js"), exports);
 __exportStar(require("./ConversationEvaluationResult.js"), exports);
 __exportStar(require("./ConversationExtraction.js"), exports);
@@ -39,6 +42,7 @@ __exportStar(require("./ConversationsListResponseConversation.js"), exports);
 __exportStar(require("./ConversationsListResponseConversations.js"), exports);
 __exportStar(require("./ConversationsListResponseConversationsPagination.js"), exports);
 __exportStar(require("./CreateAgentRequest.js"), exports);
+__exportStar(require("./DataRetentionPolicy.js"), exports);
 __exportStar(require("./DtmfPayload.js"), exports);
 __exportStar(require("./Error_.js"), exports);
 __exportStar(require("./ErrorPayload.js"), exports);
@@ -56,6 +60,7 @@ __exportStar(require("./OpenAiTool.js"), exports);
 __exportStar(require("./OutboundCallConfig.js"), exports);
 __exportStar(require("./OutboundCallInitiatedResponse.js"), exports);
 __exportStar(require("./OutboundDryRunResponse.js"), exports);
+__exportStar(require("./OutboundNumberPool.js"), exports);
 __exportStar(require("./Project.js"), exports);
 __exportStar(require("./ReadyToStartConversationPayload.js"), exports);
 __exportStar(require("./ReplayConversationItemResponse.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.32.2";
+export declare const SDK_VERSION = "0.32.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.32.2";
+exports.SDK_VERSION = "0.32.4";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "phonic",
-        "X-Fern-SDK-Version": "0.32.2",
-        "User-Agent": "phonic/0.32.2",
+        "X-Fern-SDK-Version": "0.32.4",
+        "User-Agent": "phonic/0.32.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/esm/Client.d.mts

@@ -1,4 +1,5 @@
 import { AgentsClient } from "./api/resources/agents/client/Client.mjs";
+import { ApiKeysClient } from "./api/resources/apiKeys/client/Client.mjs";
 import { AuthClient } from "./api/resources/auth/client/Client.mjs";
 import { ConversationItemsClient } from "./api/resources/conversationItems/client/Client.mjs";
 import { ConversationsClient } from "./api/resources/conversations/client/Client.mjs";
@@ -27,6 +28,7 @@ export declare namespace PhonicClient {
 export declare class PhonicClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PhonicClient.Options>;
     protected _agents: AgentsClient | undefined;
+    protected _apiKeys: ApiKeysClient | undefined;
     protected _tools: ToolsClient | undefined;
     protected _extractionSchemas: ExtractionSchemasClient | undefined;
     protected _tts: TtsClient | undefined;
@@ -38,6 +40,7 @@ export declare class PhonicClient {
     protected _workspace: WorkspaceClient | undefined;
     constructor(options?: PhonicClient.Options);
     get agents(): AgentsClient;
+    get apiKeys(): ApiKeysClient;
     get tools(): ToolsClient;
     get extractionSchemas(): ExtractionSchemasClient;
     get tts(): TtsClient;

package/dist/esm/Client.mjs

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { AgentsClient } from "./api/resources/agents/client/Client.mjs";
+import { ApiKeysClient } from "./api/resources/apiKeys/client/Client.mjs";
 import { AuthClient } from "./api/resources/auth/client/Client.mjs";
 import { ConversationItemsClient } from "./api/resources/conversationItems/client/Client.mjs";
 import { ConversationsClient } from "./api/resources/conversations/client/Client.mjs";
@@ -29,6 +30,10 @@ export class PhonicClient {
         var _a;
         return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new AgentsClient(this._options)));
     }
+    get apiKeys() {
+        var _a;
+        return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new ApiKeysClient(this._options)));
+    }
     get tools() {
         var _a;
         return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new ToolsClient(this._options)));

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

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as Phonic from "../index.mjs";
+export declare class TooManyRequestsError extends errors.PhonicError {
+    constructor(body: Phonic.BasicError, rawResponse?: core.RawResponse);
+}

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

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class TooManyRequestsError extends errors.PhonicError {
+    constructor(body, rawResponse) {
+        super({
+            message: "TooManyRequestsError",
+            statusCode: 429,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

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

@@ -4,5 +4,6 @@ export * from "./ForbiddenError.mjs";
 export * from "./GatewayTimeoutError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";
+export * from "./TooManyRequestsError.mjs";
 export * from "./UnauthorizedError.mjs";
 export * from "./UnprocessableEntityError.mjs";

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

@@ -4,5 +4,6 @@ export * from "./ForbiddenError.mjs";
 export * from "./GatewayTimeoutError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";
+export * from "./TooManyRequestsError.mjs";
 export * from "./UnauthorizedError.mjs";
 export * from "./UnprocessableEntityError.mjs";

package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.d.mts

@@ -49,6 +49,8 @@ export interface AgentsCreateRequest {
     project?: string;
     /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
     name: string;
+    /** URL-friendly agent slug. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
+    slug?: string;
     /** When set to `null`, the agent will not be associated with a phone number. When set to `"assign-automatically"`, the agent will be assigned a random phone number. When set to `"custom"`, you must provide `custom_phone_numbers`. */
     phone_number?: Phonic.CreateAgentRequest.PhoneNumber | null;
     /** The custom phone number to use for the agent in E.164 format (e.g., +1234567890). This field is deprecated. Use `custom_phone_numbers` instead. */
@@ -89,6 +91,12 @@ export interface AgentsCreateRequest {
     no_input_poke_text?: string;
     /** Seconds of silence before ending the conversation. */
     no_input_end_conversation_sec?: number;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy;
     /** ISO 639-1 language code that sets the agent's default language to recognize and speak. Welcome message and no input poke text should be in this language. */
     default_language?: Phonic.LanguageCode;
     /** Array of additional ISO 639-1 language codes that the agent should be able to recognize and speak. Should not include `default_language`. */

package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts

@@ -49,6 +49,8 @@ export interface UpdateAgentRequest {
     project?: string;
     /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
     name?: string;
+    /** URL-friendly agent slug. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
+    slug?: string;
     /** When set to `null`, the agent will not be associated with a phone number anymore. When set to `"assign-automatically"`, the agent will be assigned a random phone number if it doesn't have one yet. If the agent already has a phone number, `"assign-automatically"` has no effect. When set to `"custom"`, you must provide `custom_phone_numbers`. */
     phone_number?: UpdateAgentRequest.PhoneNumber | null;
     /** The custom phone number to use for the agent in E.164 format (e.g., +1234567890). This field is deprecated. Use `custom_phone_numbers` instead. */
@@ -89,6 +91,18 @@ export interface UpdateAgentRequest {
     no_input_poke_text?: string;
     /** Seconds of silence before ending the conversation. */
     no_input_end_conversation_sec?: number;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy;
+    /** Pool of phone numbers used for outbound calls. Set to `null` to remove the pool. */
+    outbound_number_pool?: Phonic.OutboundNumberPool | null;
+    /** Array of procedure IDs associated with the agent. */
+    procedure_ids?: string[];
+    /** Array of third-party integrations enabled for the agent. */
+    integrations?: Phonic.AgentIntegration[];
     /** ISO 639-1 language code that sets the agent's default language to recognize and speak. Welcome message and no input poke text should be in this language. */
     default_language?: Phonic.LanguageCode;
     /** Array of additional ISO 639-1 language codes that the agent should be able to recognize and speak. Should not include `default_language`. */

package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.d.mts

@@ -47,4 +47,10 @@ import type * as Phonic from "../../../../index.mjs";
 export interface UpsertAgentRequest extends Phonic.CreateAgentRequest {
     /** The name of the project containing the agent. */
     project?: string;
+    /** Pool of phone numbers used for outbound calls. Set to `null` to remove the pool. */
+    outbound_number_pool?: Phonic.OutboundNumberPool | null;
+    /** Array of procedure IDs associated with the agent. */
+    procedure_ids?: string[];
+    /** Array of third-party integrations enabled for the agent. */
+    integrations?: Phonic.AgentIntegration[];
 }

package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.d.mts

@@ -1,4 +1,9 @@
+import type * as Phonic from "../../../index.mjs";
 export interface AgentsUpdateResponse {
     /** Whether the agent was updated successfully. */
     success: boolean;
+    /** The version number of the agent after the update. */
+    version_number: number;
+    /** The updated agent. */
+    agent: Phonic.Agent;
 }

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

@@ -0,0 +1,79 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Phonic from "../../../index.mjs";
+export declare namespace ApiKeysClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ApiKeysClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
+    constructor(options?: ApiKeysClient.Options);
+    /**
+     * Creates a new API key in the workspace.
+     *
+     * @param {Phonic.CreateApiKeyRequest} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.apiKeys.create({
+     *         name: "production-key"
+     *     })
+     */
+    create(request: Phonic.CreateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<Phonic.ApiKeyWithSecret>;
+    private __create;
+    /**
+     * Deletes an API key.
+     *
+     * @param {string} id - The ID of the API key to delete.
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.apiKeys.delete("id")
+     */
+    delete(id: string, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<Phonic.ApiKeysDeleteResponse>;
+    private __delete;
+    /**
+     * Updates an API key.
+     *
+     * @param {string} id - The ID of the API key to update.
+     * @param {Phonic.UpdateApiKeyRequest} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.apiKeys.update("id", {
+     *         name: "renamed-key"
+     *     })
+     */
+    update(id: string, request: Phonic.UpdateApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<Phonic.ApiKeysUpdateResponse>;
+    private __update;
+    /**
+     * Rotates an API key, generating a new secret and invalidating the old one.
+     *
+     * @param {string} id - The ID of the API key to rotate.
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.NotFoundError}
+     * @throws {@link Phonic.InternalServerError}
+     *
+     * @example
+     *     await client.apiKeys.rotate("id")
+     */
+    rotate(id: string, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<Phonic.ApiKeyWithSecret>;
+    private __rotate;
+}