agentphone 1.0.5 → 1.0.7

package/reference.md

@@ -150,7 +150,7 @@ await client.agentSignup.agentVerify({
 <dl>
 <dd>
 
-Return available voices from the call provider (Retell).
+Return available voices for voice calls.
 </dd>
 </dl>
 </dd>
@@ -2425,6 +2425,75 @@ await client.conversations.getConversationMessages({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendTypingIndicator</a>({ ...params }) -> AgentPhone.SendTypingResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Show a typing indicator in the conversation (iMessage only).
+
+Best-effort: providers may silently drop the indicator if the chat hasn't
+had recent activity, the recipient isn't on iMessage, or it's a group chat.
+Indicators auto-expire after a few seconds — no "stop typing" call needed.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversations.sendTypingIndicator({
+    conversation_id: "conversation_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentPhone.SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ConversationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2706,6 +2775,82 @@ await client.calls.getCall({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">getCallRecording</a>({ ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the audio file (WAV format) for a completed call.
+
+This is a public endpoint -- no authentication is required. The call ID acts as the access token. The `recordingUrl` field in the call response already contains this URL when recording is enabled.
+
+Recording must be enabled on your account via `POST /credits/recording/enable` ($5/mo add-on). Returns `404` if the call doesn't exist or has no recording.
+
+**Response:** Binary audio file (`audio/wav`), auto-downloads with filename `recording-{call_id}.wav`.
+
+**Notes:**
+- Recording is available shortly after a call completes
+- Check `recordingAvailable: true` in the call response before fetching
+- The URL can be shared or embedded directly since it requires no authentication
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.calls.getCallRecording({
+    call_id: "call_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentPhone.GetCallRecordingV1CallsCallIdRecordingGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CallsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3104,6 +3249,128 @@ await client.usage.getMonthlyUsage();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsageByNumber</a>() -> AgentPhone.NumberUsageResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get usage statistics broken down by phone number, with linked agent info.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.usage.getUsageByNumber();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `UsageClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsageByAgent</a>({ ...params }) -> AgentPhone.AgentUsageResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get usage broken down by agent for the current calendar week, month, or year.
+Includes message count, completed call count, and total call seconds per agent.
+Calls/messages with no agent attached are bucketed as "Unassigned".
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.usage.getUsageByAgent({
+    period: "week"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentPhone.GetUsageByAgentV1UsageByAgentGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `UsageClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3122,6 +3389,24 @@ await client.usage.getMonthlyUsage();
 <dd>
 
 Send an outbound message (SMS or iMessage) via the provider assigned to the number.
+
+Supports single attachments via `media_url` or multiple attachments via `media_urls`. You may use one or the other, but not both.
+
+### Carousel / multi-image (iMessage)
+
+To send a carousel of images on iMessage, pass 2-20 URLs in `media_urls`. Requirements:
+- Each URL must be a **publicly accessible HTTPS link** to an image (JPEG, PNG, GIF, etc.)
+- Minimum 2 URLs, maximum 20
+- `body` must be omitted or empty (text cannot be sent alongside a carousel)
+- Only supported on iMessage-capable lines
+
+### Single attachment
+
+Pass a single URL in `media_url`. The URL must be publicly accessible. Works across all channels.
+
+### Multi-attachment (iMessage)
+
+Some iMessage lines support multiple attachments (images and other file types) via `media_urls`. No minimum count; `body` can be included alongside attachments.
 </dd>
 </dl>
 </dd>