agentphone 1.0.4 → 1.0.6

package/reference.md

@@ -1,4 +1,142 @@
 # Reference
+## AgentSignup
+<details><summary><code>client.agentSignup.<a href="/src/api/resources/agentSignup/client/Client.ts">agentSignUp</a>({ ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Kick off agent self-signup.
+
+Sends a 6-digit OTP to the human's email. Nothing is provisioned server-side
+until /v0/agent/verify is called with the code.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentSignup.agentSignUp({
+    human_email: "human_email"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentPhone.AgentSignUpRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentSignupClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agentSignup.<a href="/src/api/resources/agentSignup/client/Client.ts">agentVerify</a>({ ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Verify the OTP and atomically provision everything.
+
+Creates: User + Project (+ mirrored Account) + starter hosted Agent + Twilio number
++ first-month charge + API key. Returns the key once — agents must save it.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentSignup.agentVerify({
+    verification_id: "verification_id",
+    otp_code: "otp_code"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AgentPhone.AgentVerifyRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentSignupClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 ## Agents
 <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listVoices</a>() -> unknown</code></summary>
 <dl>
@@ -2287,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>
@@ -2568,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>
@@ -2966,6 +3249,61 @@ 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>