agentphone 1.0.11 → 1.0.12

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>
@@ -3584,8 +3446,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,72 +3459,23 @@ await client.usage.getUsageByAgent({
 <dl>
 <dd>
 
-Exchange a one-time connect code and redirect to Supabase OAuth.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.integrations.supabaseConnect({
-    code: "code"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `AgentPhone.SupabaseConnectIntegrationsSupabaseConnectGetRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `IntegrationsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
+Send an outbound message (SMS or iMessage) via the provider assigned to the number.
 
-</dd>
-</dl>
-</details>
+Attach media by passing public HTTPS URLs in `media_urls`.
 
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseConnectCode</a>() -> unknown</code></summary>
-<dl>
-<dd>
+### Single attachment
 
-#### 📝 Description
+Pass a single-item array in `media_urls`. The URL must be publicly accessible.
 
-<dl>
-<dd>
+### Carousel / multi-image (iMessage)
 
-<dl>
-<dd>
+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
 
-Create a short-lived one-time code for initiating the Supabase OAuth flow.
+> **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>
@@ -3677,7 +3490,11 @@ Create a short-lived one-time code for initiating the Supabase OAuth flow.
 <dd>
 
 ```typescript
-await client.integrations.supabaseConnectCode();
+await client.messages.sendMessage({
+    agent_id: "agent_id",
+    to_number: "to_number",
+    body: "body"
+});
 
 ```
 </dd>
@@ -3693,48 +3510,15 @@ await client.integrations.supabaseConnectCode();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.SendMessageRequest` 
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseStatus</a>() -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
 
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-```typescript
-await client.integrations.supabaseStatus();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**requestOptions:** `MessagesClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3746,7 +3530,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.messages.<a href="/src/api/resources/messages/client/Client.ts">sendReaction</a>({ ...params }) -> AgentPhone.SendReactionResponse</code></summary>
 <dl>
 <dd>
 
@@ -3758,7 +3542,11 @@ await client.integrations.supabaseStatus();
 <dl>
 <dd>
 
-Get a valid Supabase access token, auto-refreshing if expired.
+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>
@@ -3773,7 +3561,10 @@ Get a valid Supabase access token, auto-refreshing if expired.
 <dd>
 
 ```typescript
-await client.integrations.supabaseToken();
+await client.messages.sendReaction({
+    message_id: "message_id",
+    reaction: "love"
+});
 
 ```
 </dd>
@@ -3789,48 +3580,15 @@ await client.integrations.supabaseToken();
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**request:** `AgentPhone.SendReactionRequest` 
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">supabaseDisconnect</a>() -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.integrations.supabaseDisconnect();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
 
 <dl>
 <dd>
 
-**requestOptions:** `IntegrationsClient.RequestOptions` 
+**requestOptions:** `MessagesClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3842,8 +3600,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>
+## ContactCards
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">getContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
 <dl>
 <dd>
 
@@ -3855,23 +3613,7 @@ await client.integrations.supabaseDisconnect();
 <dl>
 <dd>
 
-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://..."]`.
+Fetch the iMessage contact card set on this number.
 </dd>
 </dl>
 </dd>
@@ -3886,10 +3628,8 @@ 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.contactCards.getContactCard({
+    number_id: "number_id"
 });
 
 ```
@@ -3906,7 +3646,7 @@ await client.messages.sendMessage({
 <dl>
 <dd>
 
-**request:** `AgentPhone.SendMessageRequest` 
+**request:** `AgentPhone.GetContactCardV1NumbersNumberIdContactCardGetRequest` 
     
 </dd>
 </dl>
@@ -3914,7 +3654,7 @@ await client.messages.sendMessage({
 <dl>
 <dd>
 
-**requestOptions:** `MessagesClient.RequestOptions` 
+**requestOptions:** `ContactCardsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3926,7 +3666,7 @@ 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>
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">putContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
 <dl>
 <dd>
 
@@ -3938,11 +3678,7 @@ await client.messages.sendMessage({
 <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.
+Create or replace the iMessage contact card on this number.
 </dd>
 </dl>
 </dd>
@@ -3957,9 +3693,11 @@ returns a clear error.
 <dd>
 
 ```typescript
-await client.messages.sendReaction({
-    message_id: "message_id",
-    reaction: "love"
+await client.contactCards.putContactCard({
+    number_id: "number_id",
+    firstName: "firstName",
+    lastName: "lastName",
+    avatarUrl: "avatarUrl"
 });
 
 ```
@@ -3976,7 +3714,7 @@ await client.messages.sendReaction({
 <dl>
 <dd>
 
-**request:** `AgentPhone.SendReactionRequest` 
+**request:** `AgentPhone.ContactCardWriteRequest` 
     
 </dd>
 </dl>
@@ -3984,7 +3722,7 @@ await client.messages.sendReaction({
 <dl>
 <dd>
 
-**requestOptions:** `MessagesClient.RequestOptions` 
+**requestOptions:** `ContactCardsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -3996,8 +3734,7 @@ 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>
+<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">deleteContactCard</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
 
@@ -4009,7 +3746,7 @@ await client.messages.sendReaction({
 <dl>
 <dd>
 
-Fetch the iMessage contact card set on this number.
+Remove the iMessage contact card from this number.
 </dd>
 </dl>
 </dd>
@@ -4024,7 +3761,7 @@ Fetch the iMessage contact card set on this number.
 <dd>
 
 ```typescript
-await client.contactCards.getContactCard({
+await client.contactCards.deleteContactCard({
     number_id: "number_id"
 });
 
@@ -4042,7 +3779,7 @@ await client.contactCards.getContactCard({
 <dl>
 <dd>
 
-**request:** `AgentPhone.GetContactCardV1NumbersNumberIdContactCardGetRequest` 
+**request:** `AgentPhone.DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest` 
     
 </dd>
 </dl>
@@ -4062,7 +3799,8 @@ 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>
+## Registration
+<details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">registerA2P</a>({ ...params }) -> AgentPhone.RegistrationResponse</code></summary>
 <dl>
 <dd>
 
@@ -4074,75 +3812,30 @@ await client.contactCards.getContactCard({
 <dl>
 <dd>
 
-Create or replace the iMessage contact card on this number.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.contactCards.putContactCard({
-    number_id: "number_id",
-    firstName: "firstName",
-    lastName: "lastName",
-    avatarUrl: "avatarUrl"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
+Submit an A2P 10DLC registration to enable outbound SMS on your account.
 
-**request:** `AgentPhone.ContactCardWriteRequest` 
-    
-</dd>
-</dl>
+US carriers require 10DLC registration before your AI agent can send text messages. This endpoint accepts both `sole_proprietor` and `standard_brand` registration types.
 
-<dl>
-<dd>
-
-**requestOptions:** `ContactCardsClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
+### How it works
 
+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
 
-</dd>
-</dl>
-</details>
+### Registration types
 
-<details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">deleteContactCard</a>({ ...params }) -> void</code></summary>
-<dl>
-<dd>
+- **`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`.
 
-#### 📝 Description
+### Opt-in image
 
-<dl>
-<dd>
+`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.
 
-<dl>
-<dd>
+### Re-submitting
 
-Remove the iMessage contact card from this number.
+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>
@@ -4157,8 +3850,18 @@ Remove the iMessage contact card from this number.
 <dd>
 
 ```typescript
-await client.contactCards.deleteContactCard({
-    number_id: "number_id"
+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"
 });
 
 ```
@@ -4175,7 +3878,7 @@ await client.contactCards.deleteContactCard({
 <dl>
 <dd>
 
-**request:** `AgentPhone.DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest` 
+**request:** `AgentPhone.RegistrationRequest` 
     
 </dd>
 </dl>
@@ -4183,7 +3886,7 @@ await client.contactCards.deleteContactCard({
 <dl>
 <dd>
 
-**requestOptions:** `ContactCardsClient.RequestOptions` 
+**requestOptions:** `RegistrationClient.RequestOptions` 
     
 </dd>
 </dl>