phonic 0.32.11 → 0.32.12

package/dist/esm/api/resources/externalStoragePolicies/types/index.mjs

@@ -0,0 +1,5 @@
+export * from "./ExternalStoragePoliciesCreateResponse.mjs";
+export * from "./ExternalStoragePoliciesDeleteResponse.mjs";
+export * from "./ExternalStoragePoliciesGetResponse.mjs";
+export * from "./ExternalStoragePoliciesListResponse.mjs";
+export * from "./ExternalStoragePoliciesUpdateResponse.mjs";

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

@@ -12,6 +12,9 @@ export * as conversationItems from "./conversationItems/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
+export * from "./externalStoragePolicies/client/requests/index.mjs";
+export * as externalStoragePolicies from "./externalStoragePolicies/index.mjs";
+export * from "./externalStoragePolicies/types/index.mjs";
 export * from "./extractionSchemas/client/requests/index.mjs";
 export * as extractionSchemas from "./extractionSchemas/index.mjs";
 export * from "./extractionSchemas/types/index.mjs";

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

@@ -12,6 +12,9 @@ export * as conversationItems from "./conversationItems/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
+export * from "./externalStoragePolicies/client/requests/index.mjs";
+export * as externalStoragePolicies from "./externalStoragePolicies/index.mjs";
+export * from "./externalStoragePolicies/types/index.mjs";
 export * from "./extractionSchemas/client/requests/index.mjs";
 export * as extractionSchemas from "./extractionSchemas/index.mjs";
 export * from "./extractionSchemas/types/index.mjs";

package/dist/esm/api/resources/tools/client/requests/CreateToolRequest.d.mts

@@ -119,7 +119,7 @@ export interface CreateToolRequest {
     parameters?: Phonic.ToolParameter[];
     /** Required for webhook tools. HTTP method for the webhook endpoint. */
     endpoint_method?: CreateToolRequest.EndpointMethod;
-    /** Required for webhook tools. */
+    /** Required for webhook tools. Must be a publicly routable HTTPS URL without embedded credentials. */
     endpoint_url?: string;
     /** Optional headers for webhook tools. */
     endpoint_headers?: Record<string, string>;

package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.d.mts

@@ -30,6 +30,7 @@ export interface UpdateToolRequest {
     parameters?: Phonic.ToolParameter[];
     /** HTTP method for webhook tools. When changing this value, all parameters must include explicit `location` values. */
     endpoint_method?: UpdateToolRequest.EndpointMethod;
+    /** URL for webhook tools. Must be a publicly routable HTTPS URL without embedded credentials. */
     endpoint_url?: string;
     /** Headers for webhook tools. Set to null to clear existing headers. */
     endpoint_headers?: Record<string, string | null> | null;

package/dist/esm/api/types/Agent.d.mts

@@ -64,6 +64,8 @@ export interface Agent {
     boosted_keywords: string[];
     /** Names of observability integrations enabled for the agent. Each must be one of the supported providers. */
     observability_integrations?: "braintrust"[] | undefined;
+    /** Name of the external storage policy that conversation artifacts are delivered to. `null` when the agent doesn't deliver artifacts to external storage. */
+    external_storage_policy?: (string | null) | undefined;
     /** Array of `{ word, pronunciation }` entries. Words must be unique. */
     pronunciation_dictionary: Agent.PronunciationDictionary.Item[];
     /** Minimum number of words required to interrupt the assistant. */

package/dist/esm/api/types/ConfigOptions.d.mts

@@ -75,6 +75,8 @@ export interface ConfigOptions {
     mcp_servers?: string[] | undefined;
     /** Names of observability integrations to enable for the conversation. Each must be one of the supported providers. */
     observability_integrations?: "braintrust"[] | undefined;
+    /** Name of an external storage policy in the same project that conversation artifacts are delivered to. Requires `data_retention_policy.zero_data_retention` to be `true` and cannot be combined with `enable_redaction`. Set to `null` to disable external delivery. */
+    external_storage_policy?: (string | null) | undefined;
     /** Tasks the assistant should accomplish during the conversation. */
     tasks?: ConfigOptions.Tasks.Item[] | undefined;
     /** Pool of phone numbers to use as the caller ID for outbound calls. */
@@ -161,7 +163,7 @@ export declare namespace ConfigOptions {
      * When not `null`, the agent will call this endpoint to get configuration options for the conversation.
      */
     interface ConfigurationEndpoint {
-        /** URL to call. */
+        /** URL to call. Must be a publicly routable HTTPS URL without embedded credentials. */
         url: string;
         /** Object of key-value pairs sent as headers when calling the endpoint. */
         headers?: Record<string, string> | undefined;

package/dist/esm/api/types/CreateAgentRequest.d.mts

@@ -92,6 +92,8 @@ export interface CreateAgentRequest {
     mcp_server_ids?: string[] | undefined;
     /** Names of observability integrations to enable for the agent. Each must be one of the supported providers. */
     observability_integrations?: "braintrust"[] | undefined;
+    /** Name of an external storage policy in the same project that conversation artifacts are delivered to. Requires zero data retention and cannot be combined with `enable_redaction`. */
+    external_storage_policy?: (string | null) | undefined;
 }
 export declare namespace CreateAgentRequest {
     const PhoneNumber: {
@@ -152,7 +154,7 @@ export declare namespace CreateAgentRequest {
      * 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 to call. Must be a publicly routable HTTPS URL without embedded credentials. */
         url: string;
         /** Object of key-value pairs. */
         headers?: Record<string, string> | undefined;

package/dist/esm/api/types/ExternalStoragePolicy.d.mts

@@ -0,0 +1,30 @@
+/**
+ * An S3-compatible destination that conversation artifacts are delivered to.
+ */
+export interface ExternalStoragePolicy {
+    /** The ID of the external storage policy. */
+    id: string;
+    /** The name of the external storage policy. Agents reference the policy by this name. */
+    name: string;
+    /** The S3-compatible endpoint URL that artifacts are uploaded to. */
+    endpoint_url: string;
+    /** The bucket that artifacts are uploaded to. */
+    bucket: string;
+    /** The region of the bucket. `null` when the endpoint doesn't require a region. */
+    region: string | null;
+    /** Prefix prepended to every object key. `null` when objects are written at the bucket root. */
+    key_prefix: string | null;
+    /** How bucket names are addressed in requests to the endpoint. */
+    addressing_style: ExternalStoragePolicy.AddressingStyle;
+    /** Number of agents currently referencing this external storage policy. */
+    agent_count: number;
+}
+export declare namespace ExternalStoragePolicy {
+    /** How bucket names are addressed in requests to the endpoint. */
+    const AddressingStyle: {
+        readonly Auto: "auto";
+        readonly Virtual: "virtual";
+        readonly Path: "path";
+    };
+    type AddressingStyle = (typeof AddressingStyle)[keyof typeof AddressingStyle];
+}

package/dist/esm/api/types/ExternalStoragePolicy.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ExternalStoragePolicy;
+(function (ExternalStoragePolicy) {
+    /** How bucket names are addressed in requests to the endpoint. */
+    ExternalStoragePolicy.AddressingStyle = {
+        Auto: "auto",
+        Virtual: "virtual",
+        Path: "path",
+    };
+})(ExternalStoragePolicy || (ExternalStoragePolicy = {}));

package/dist/esm/api/types/OutboundCallConfig.d.mts

@@ -113,7 +113,7 @@ export declare namespace OutboundCallConfig {
      * 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 to call. Must be a publicly routable HTTPS URL without embedded credentials. */
         url: string;
         /** Object of key-value pairs. */
         headers?: Record<string, string> | undefined;

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

@@ -33,6 +33,7 @@ export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
+export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
 export * from "./GenerateReplyPayload.mjs";

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

@@ -33,6 +33,7 @@ export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
+export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
 export * from "./GenerateReplyPayload.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.32.11";
+export declare const SDK_VERSION = "0.32.12";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.32.11";
+export const SDK_VERSION = "0.32.12";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "phonic",
-    "version": "0.32.11",
+    "version": "0.32.12",
     "private": false,
     "repository": {
         "type": "git",
@@ -45,6 +45,17 @@
             },
             "default": "./dist/cjs/api/resources/tools/exports.js"
         },
+        "./externalStoragePolicies": {
+            "import": {
+                "types": "./dist/esm/api/resources/externalStoragePolicies/exports.d.mts",
+                "default": "./dist/esm/api/resources/externalStoragePolicies/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/externalStoragePolicies/exports.d.ts",
+                "default": "./dist/cjs/api/resources/externalStoragePolicies/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/externalStoragePolicies/exports.js"
+        },
         "./extractionSchemas": {
             "import": {
                 "types": "./dist/esm/api/resources/extractionSchemas/exports.d.mts",

package/reference.md

@@ -557,6 +557,9 @@ Adds a custom phone number to an agent. The user must configure their SIP trunk
 
 ```typescript
 await client.agents.addCustomPhoneNumber("nameOrId", {
+    "X-Sip-Address": "X-Sip-Address",
+    "X-Sip-Auth-Username": "X-Sip-Auth-Username",
+    "X-Sip-Auth-Password": "X-Sip-Auth-Password",
     project: "main",
     phone_number: "+15551234567",
     configuration_endpoint: {
@@ -1130,6 +1133,366 @@ await client.tools.update("nameOrId", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## ExternalStoragePolicies
+<details><summary><code>client.externalStoragePolicies.<a href="/src/api/resources/externalStoragePolicies/client/Client.ts">list</a>({ ...params }) -> Phonic.ExternalStoragePoliciesListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns all external storage policies in a project.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalStoragePolicies.list({
+    project: "main"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Phonic.ExternalStoragePoliciesListRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalStoragePoliciesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.externalStoragePolicies.<a href="/src/api/resources/externalStoragePolicies/client/Client.ts">create</a>({ ...params }) -> Phonic.ExternalStoragePoliciesCreateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new external storage policy in a project. Agents referencing the policy deliver their conversation artifacts to the configured S3-compatible bucket.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalStoragePolicies.create({
+    project: "main",
+    name: "conversation_archive",
+    endpoint_url: "https://storage.example.com",
+    bucket: "conversation-audio",
+    region: "us-east-1",
+    key_prefix: "phonic/conversations",
+    addressing_style: "auto",
+    access_key_id: "AKIAIOSFODNN7EXAMPLE",
+    secret_access_key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Phonic.CreateExternalStoragePolicyRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalStoragePoliciesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.externalStoragePolicies.<a href="/src/api/resources/externalStoragePolicies/client/Client.ts">get</a>(nameOrId, { ...params }) -> Phonic.ExternalStoragePoliciesGetResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns an external storage policy by name or ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalStoragePolicies.get("nameOrId", {
+    project: "main"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**nameOrId:** `string` — The name or the ID of the external storage policy to get.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Phonic.ExternalStoragePoliciesGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalStoragePoliciesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.externalStoragePolicies.<a href="/src/api/resources/externalStoragePolicies/client/Client.ts">delete</a>(nameOrId, { ...params }) -> Phonic.ExternalStoragePoliciesDeleteResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an external storage policy by name or ID. The policy must not be referenced by any agent.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalStoragePolicies.delete("nameOrId", {
+    project: "main"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**nameOrId:** `string` — The name or the ID of the external storage policy to delete.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Phonic.ExternalStoragePoliciesDeleteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalStoragePoliciesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.externalStoragePolicies.<a href="/src/api/resources/externalStoragePolicies/client/Client.ts">update</a>(nameOrId, { ...params }) -> Phonic.ExternalStoragePoliciesUpdateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an external storage policy by name or ID. Credentials can only be rotated by providing both `access_key_id` and `secret_access_key`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.externalStoragePolicies.update("nameOrId", {
+    project: "main",
+    bucket: "conversation-audio-archive",
+    key_prefix: "phonic/archive"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**nameOrId:** `string` — The name or the ID of the external storage policy to update.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Phonic.UpdateExternalStoragePolicyRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExternalStoragePoliciesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>