agentphone 1.0.11 → 1.0.13

package/reference.md

@@ -1,142 +1,4 @@
 # 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 + phone 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>
@@ -1067,7 +929,7 @@ await client.numbers.deleteNumber({
 </details>
 
 ## Webhooks
-<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>() -> AgentPhone.WebhookResponse | null</code></summary>
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>({ ...params }) -> AgentPhone.WebhookResponse | null</code></summary>
 <dl>
 <dd>
 
@@ -1110,6 +972,14 @@ await client.webhooks.getWebhook();
 <dl>
 <dd>
 
+**request:** `AgentPhone.GetWebhookV1WebhooksGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `WebhooksClient.RequestOptions` 
     
 </dd>
@@ -1156,7 +1026,9 @@ Set to 0 to disable history in webhooks.
 
 ```typescript
 await client.webhooks.createOrUpdateWebhook({
-    url: "url"
+    body: {
+        url: "url"
+    }
 });
 
 ```
@@ -1173,7 +1045,7 @@ await client.webhooks.createOrUpdateWebhook({
 <dl>
 <dd>
 
-**request:** `AgentPhone.WebhookCreateRequest` 
+**request:** `AgentPhone.CreateOrUpdateWebhookV1WebhooksPostRequest` 
     
 </dd>
 </dl>
@@ -2444,9 +2316,11 @@ await client.conversations.getConversationMessages({
 
 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.
+Works for both 1:1 and group chats: a group id is itself a valid typing
+target, so every participant sees the indicator. Best-effort: the
+indicator may be silently dropped if the chat has no recent activity, the
+recipient isn't on iMessage, or it's RCS-routed (RCS carries no composing
+state). Auto-expires after a few seconds; no "stop typing" call needed.
 </dd>
 </dl>
 </dd>
@@ -3584,8 +3458,8 @@ await client.usage.getUsageByAgent({
 </dl>
 </details>
 
-## Integrations
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseConnect</a>({ ...params }) -> unknown</code></summary>
+## Messages
+<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendMessage</a>({ ...params }) -> AgentPhone.SendMessageResponse</code></summary>
 <dl>
 <dd>
 
@@ -3597,7 +3471,23 @@ await client.usage.getUsageByAgent({
 <dl>
 <dd>
 
-Exchange a one-time connect code and redirect to Supabase OAuth.
+Send an outbound message (SMS or iMessage) via the provider assigned to the number.
+
+Attach media by passing public HTTPS URLs in `media_urls`.
+
+### Single attachment
+
+Pass a single-item array in `media_urls`. The URL must be publicly accessible.
+
+### 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
+
+> **Deprecation notice:** The `media_url` field (singular) is deprecated and will be removed in a future version. Use `media_urls` (array) instead — even for a single attachment, pass it as `media_urls: ["https://..."]`.
 </dd>
 </dl>
 </dd>
@@ -3612,8 +3502,10 @@ Exchange a one-time connect code and redirect to Supabase OAuth.
 <dd>
 
 ```typescript
-await client.integrations.supabaseConnect({
-    code: "code"
+await client.messages.sendMessage({
+    agent_id: "agent_id",
+    to_number: "to_number",
+    body: "body"
 });
 
 ```
@@ -3630,7 +3522,7 @@ await client.integrations.supabaseConnect({
 <dl>
 <dd>
 
-**request:** `AgentPhone.SupabaseConnectIntegrationsSupabaseConnectGetRequest` 
+**request:** `AgentPhone.SendMessageRequest` 
     
 </dd>
 </dl>
@@ -3638,7 +3530,7 @@ await client.integrations.supabaseConnect({
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**requestOptions:** `MessagesClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3650,7 +3542,7 @@ await client.integrations.supabaseConnect({
 </dl>
 </details>
 
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseConnectCode</a>() -> unknown</code></summary>
+<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendReaction</a>({ ...params }) -> AgentPhone.SendReactionResponse</code></summary>
 <dl>
 <dd>
 
@@ -3662,7 +3554,11 @@ await client.integrations.supabaseConnect({
 <dl>
 <dd>
 
-Create a short-lived one-time code for initiating the Supabase OAuth flow.
+Send a tapback reaction to a message (iMessage only).
+
+Reactions are available only for iMessage messages. Attempting to react
+to an SMS message or another channel that does not support tapbacks
+returns a clear error.
 </dd>
 </dl>
 </dd>
@@ -3677,7 +3573,10 @@ Create a short-lived one-time code for initiating the Supabase OAuth flow.
 <dd>
 
 ```typescript
-await client.integrations.supabaseConnectCode();
+await client.messages.sendReaction({
+    message_id: "message_id",
+    reaction: "love"
+});
 
 ```
 </dd>
@@ -3693,7 +3592,15 @@ await client.integrations.supabaseConnectCode();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.SendReactionRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MessagesClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3705,10 +3612,25 @@ await client.integrations.supabaseConnectCode();
 </dl>
 </details>
 
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseStatus</a>() -> unknown</code></summary>
+## ContactCards
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">getContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetch the iMessage contact card set on this number.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -3718,7 +3640,9 @@ await client.integrations.supabaseConnectCode();
 <dd>
 
 ```typescript
-await client.integrations.supabaseStatus();
+await client.contactCards.getContactCard({
+    number_id: "number_id"
+});
 
 ```
 </dd>
@@ -3734,7 +3658,15 @@ await client.integrations.supabaseStatus();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.GetContactCardV1NumbersNumberIdContactCardGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ContactCardsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3746,7 +3678,7 @@ await client.integrations.supabaseStatus();
 </dl>
 </details>
 
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseToken</a>() -> unknown</code></summary>
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">putContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
 <dl>
 <dd>
 
@@ -3758,7 +3690,7 @@ await client.integrations.supabaseStatus();
 <dl>
 <dd>
 
-Get a valid Supabase access token, auto-refreshing if expired.
+Create or replace the iMessage contact card on this number.
 </dd>
 </dl>
 </dd>
@@ -3773,7 +3705,12 @@ Get a valid Supabase access token, auto-refreshing if expired.
 <dd>
 
 ```typescript
-await client.integrations.supabaseToken();
+await client.contactCards.putContactCard({
+    number_id: "number_id",
+    firstName: "firstName",
+    lastName: "lastName",
+    avatarUrl: "avatarUrl"
+});
 
 ```
 </dd>
@@ -3789,7 +3726,15 @@ await client.integrations.supabaseToken();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.ContactCardWriteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ContactCardsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3801,10 +3746,24 @@ await client.integrations.supabaseToken();
 </dl>
 </details>
 
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseDisconnect</a>() -> unknown</code></summary>
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">deleteContactCard</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Remove the iMessage contact card from this number.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -3814,7 +3773,9 @@ await client.integrations.supabaseToken();
 <dd>
 
 ```typescript
-await client.integrations.supabaseDisconnect();
+await client.contactCards.deleteContactCard({
+    number_id: "number_id"
+});
 
 ```
 </dd>
@@ -3830,7 +3791,15 @@ await client.integrations.supabaseDisconnect();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ContactCardsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3842,8 +3811,8 @@ await client.integrations.supabaseDisconnect();
 </dl>
 </details>
 
-## Messages
-<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendMessage</a>({ ...params }) -> AgentPhone.SendMessageResponse</code></summary>
+## Registration
+<details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">registerA2P</a>({ ...params }) -> AgentPhone.RegistrationResponse</code></summary>
 <dl>
 <dd>
 
@@ -3855,23 +3824,30 @@ await client.integrations.supabaseDisconnect();
 <dl>
 <dd>
 
-Send an outbound message (SMS or iMessage) via the provider assigned to the number.
+Submit an A2P 10DLC registration to enable outbound SMS on your account.
 
-Attach media by passing public HTTPS URLs in `media_urls`.
+US carriers require 10DLC registration before your AI agent can send text messages. This endpoint accepts both `sole_proprietor` and `standard_brand` registration types.
 
-### Single attachment
+### How it works
 
-Pass a single-item array in `media_urls`. The URL must be publicly accessible.
+1. Submit your registration details via this endpoint
+2. We validate your submission and flag any issues (RED = blocked, YELLOW = warning)
+3. On success, you receive a Stripe payment URL to pay the one-time registration fee
+4. After payment, we submit your registration to the carriers on your behalf
+5. Carrier approval typically takes 7-10 business days
 
-### Carousel / multi-image (iMessage)
+### Registration types
 
-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
+- **`sole_proprietor`** — For individuals or small businesses. Simpler requirements, fewer fields.
+- **`standard_brand`** — For established businesses. Requires `business_name`, `privacy_policy_url`, `terms_of_service_url`, `sample_message_1`, and `sample_message_2`.
 
-> **Deprecation notice:** The `media_url` field (singular) is deprecated and will be removed in a future version. Use `media_urls` (array) instead — even for a single attachment, pass it as `media_urls: ["https://..."]`.
+### Opt-in image
+
+`opt_in_image_url` must be a publicly accessible HTTPS URL to a screenshot showing how users opt in to receive messages from you (e.g. a consent checkbox on your signup form). Supports PNG, JPG, WEBP, and GIF up to 2MB. Google Drive links (`drive.google.com/file/d/.../view`) are automatically converted if the file is shared publicly.
+
+### Re-submitting
+
+If you've already submitted but haven't completed payment, calling this endpoint again returns the payment URL without re-sending the registration email.
 </dd>
 </dl>
 </dd>
@@ -3886,10 +3862,18 @@ To send a carousel of images on iMessage, pass 2-20 URLs in `media_urls`. Requir
 <dd>
 
 ```typescript
-await client.messages.sendMessage({
-    agent_id: "agent_id",
-    to_number: "to_number",
-    body: "body"
+await client.registration.registerA2P({
+    registration_type: "registration_type",
+    first_name: "first_name",
+    last_name: "last_name",
+    email: "email",
+    phone_number: "phone_number",
+    street_address: "street_address",
+    city: "city",
+    state: "state",
+    zip_code: "zip_code",
+    use_case_description: "use_case_description",
+    opt_in_image_url: "opt_in_image_url"
 });
 
 ```
@@ -3906,7 +3890,7 @@ await client.messages.sendMessage({
 <dl>
 <dd>
 
-**request:** `AgentPhone.SendMessageRequest` 
+**request:** `AgentPhone.RegistrationRequest` 
     
 </dd>
 </dl>
@@ -3914,7 +3898,7 @@ await client.messages.sendMessage({
 <dl>
 <dd>
 
-**requestOptions:** `MessagesClient.RequestOptions` 
+**requestOptions:** `RegistrationClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3926,28 +3910,11 @@ await client.messages.sendMessage({
 </dl>
 </details>
 
-<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendReaction</a>({ ...params }) -> AgentPhone.SendReactionResponse</code></summary>
+## SubAccounts
+<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>() -> unknown</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Send a tapback reaction to a message (iMessage only).
-
-Reactions are available only for iMessage messages. Attempting to react
-to an SMS message or another channel that does not support tapbacks
-returns a clear error.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -3957,10 +3924,7 @@ returns a clear error.
 <dd>
 
 ```typescript
-await client.messages.sendReaction({
-    message_id: "message_id",
-    reaction: "love"
-});
+await client.subAccounts.listSubAccounts();
 
 ```
 </dd>
@@ -3976,15 +3940,7 @@ await client.messages.sendReaction({
 <dl>
 <dd>
 
-**request:** `AgentPhone.SendReactionRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MessagesClient.RequestOptions` 
+**requestOptions:** `SubAccountsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3996,25 +3952,10 @@ await client.messages.sendReaction({
 </dl>
 </details>
 
-## ContactCards
-<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">getContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
+<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">createSubAccount</a>({ ...params }) -> unknown</code></summary>
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-Fetch the iMessage contact card set on this number.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -4024,8 +3965,8 @@ Fetch the iMessage contact card set on this number.
 <dd>
 
 ```typescript
-await client.contactCards.getContactCard({
-    number_id: "number_id"
+await client.subAccounts.createSubAccount({
+    name: "name"
 });
 
 ```
@@ -4042,7 +3983,7 @@ await client.contactCards.getContactCard({
 <dl>
 <dd>
 
-**request:** `AgentPhone.GetContactCardV1NumbersNumberIdContactCardGetRequest` 
+**request:** `AgentPhone.CreateSubAccountRequest` 
     
 </dd>
 </dl>
@@ -4050,7 +3991,7 @@ await client.contactCards.getContactCard({
 <dl>
 <dd>
 
-**requestOptions:** `ContactCardsClient.RequestOptions` 
+**requestOptions:** `SubAccountsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -4062,24 +4003,10 @@ await client.contactCards.getContactCard({
 </dl>
 </details>
 
-<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">putContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">deleteSubAccount</a>({ ...params }) -> unknown</code></summary>
 <dl>
 <dd>
 
-Create or replace the iMessage contact card on this number.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -4089,11 +4016,8 @@ Create or replace the iMessage contact card on this number.
 <dd>
 
 ```typescript
-await client.contactCards.putContactCard({
-    number_id: "number_id",
-    firstName: "firstName",
-    lastName: "lastName",
-    avatarUrl: "avatarUrl"
+await client.subAccounts.deleteSubAccount({
+    sub_account_id: "sub_account_id"
 });
 
 ```
@@ -4110,7 +4034,7 @@ await client.contactCards.putContactCard({
 <dl>
 <dd>
 
-**request:** `AgentPhone.ContactCardWriteRequest` 
+**request:** `AgentPhone.DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest` 
     
 </dd>
 </dl>
@@ -4118,7 +4042,7 @@ await client.contactCards.putContactCard({
 <dl>
 <dd>
 
-**requestOptions:** `ContactCardsClient.RequestOptions` 
+**requestOptions:** `SubAccountsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -4130,24 +4054,10 @@ await client.contactCards.putContactCard({
 </dl>
 </details>
 
-<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">deleteContactCard</a>({ ...params }) -> void</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">updateSubAccount</a>({ ...params }) -> unknown</code></summary>
 <dl>
 <dd>
 
-Remove the iMessage contact card from this number.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -4157,8 +4067,9 @@ Remove the iMessage contact card from this number.
 <dd>
 
 ```typescript
-await client.contactCards.deleteContactCard({
-    number_id: "number_id"
+await client.subAccounts.updateSubAccount({
+    sub_account_id: "sub_account_id",
+    name: "name"
 });
 
 ```
@@ -4175,7 +4086,7 @@ await client.contactCards.deleteContactCard({
 <dl>
 <dd>
 
-**request:** `AgentPhone.DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest` 
+**request:** `AgentPhone.UpdateSubAccountRequest` 
     
 </dd>
 </dl>
@@ -4183,7 +4094,7 @@ await client.contactCards.deleteContactCard({
 <dl>
 <dd>
 
-**requestOptions:** `ContactCardsClient.RequestOptions` 
+**requestOptions:** `SubAccountsClient.RequestOptions` 
     
 </dd>
 </dl>