rcs-js 2.0.6 → 2.0.7

package/reference.md

@@ -1,7 +1,5 @@
 # Reference
-
 ## Brands
-
 <details><summary><code>client.brands.<a href="/src/api/resources/brands/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.OptionalBrandInfo</code></summary>
 <dl>
 <dd>
@@ -15,7 +13,6 @@
 <dd>
 
 Automatically populate brand information based on partial input data you provide.
-
 </dd>
 </dl>
 </dd>
@@ -34,12 +31,12 @@ await client.brands.autofill({
     additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
     name: "Pinnacle",
     options: {
-        forceReload: true,
+        forceReload: true
     },
-    website: "https://www.pinnacle.sh",
+    website: "https://www.pinnacle.sh"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -53,21 +50,22 @@ await client.brands.autofill({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AutofillBrandParams`
-
+**request:** `Pinnacle.AutofillBrandParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -85,7 +83,6 @@ await client.brands.autofill({
 <dd>
 
 Create a new brand or update an existing brand by with the provided information.
-
 </dd>
 </dl>
 </dd>
@@ -106,7 +103,7 @@ await client.brands.upsert({
         email: "michael.chen@trypinnacle.app",
         name: "Michael Chen",
         phone: "+14155551234",
-        title: "Customer Support Representative",
+        title: "Customer Support Representative"
     },
     dba: "Pinnacle RCS",
     description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
@@ -116,10 +113,11 @@ await client.brands.upsert({
     name: "Pinnacle",
     sector: "TECHNOLOGY",
     type: "PRIVATE_PROFIT",
-    website: "https://www.pinnacle.sh",
+    entityType: "LLC",
+    website: "https://www.pinnacle.sh"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -133,21 +131,22 @@ await client.brands.upsert({
 <dl>
 <dd>
 
-**request:** `Pinnacle.UpsertBrandParams`
-
+**request:** `Pinnacle.UpsertBrandParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -165,7 +164,6 @@ await client.brands.upsert({
 <dd>
 
 Retrieve detailed information for a specific brand in your account by ID.
-
 </dd>
 </dl>
 </dd>
@@ -181,8 +179,8 @@ Retrieve detailed information for a specific brand in your account by ID.
 
 ```typescript
 await client.brands.get("b_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -196,32 +194,33 @@ await client.brands.get("b_1234567890");
 <dl>
 <dd>
 
-**id:** `string`
+**id:** `string` 
 
 The unique identifier of the brand you want to retrieve from your account.
 <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Pinnacle.BrandsGetRequest`
-
+**request:** `Pinnacle.BrandsGetRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -239,7 +238,6 @@ The unique identifier of the brand you want to retrieve from your account.
 <dd>
 
 Submit your brand for review and approval by the compliance team.
-
 </dd>
 </dl>
 </dd>
@@ -255,8 +253,8 @@ Submit your brand for review and approval by the compliance team.
 
 ```typescript
 await client.brands.submit("b_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -270,24 +268,25 @@ await client.brands.submit("b_1234567890");
 <dl>
 <dd>
 
-**brandId:** `string`
+**brandId:** `string` 
 
 The unique identifier of the brand you want to submit for review. <br><br>
 This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -305,7 +304,6 @@ This identifier is a string that always begins with the prefix `b_`, for example
 <dd>
 
 Validate your brand information for compliance and correctness before submission or storage.
-
 </dd>
 </dl>
 </dd>
@@ -326,7 +324,7 @@ await client.brands.validate({
         email: "michael.chen@trypinnacle.app",
         name: "Michael Chen",
         phone: "+14155551234",
-        title: "Customer Support Representative",
+        title: "Customer Support Representative"
     },
     dba: "Pinnacle Messaging",
     description: "Pinnacle is an SMS, MMS, and RCS API for scaling conversations with customers you value.",
@@ -335,10 +333,11 @@ await client.brands.validate({
     name: "Pinnacle",
     sector: "TECHNOLOGY",
     type: "PRIVATE_PROFIT",
-    website: "https://www.pinnacle.sh",
+    entityType: "LLC",
+    website: "https://www.pinnacle.sh"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -352,21 +351,22 @@ await client.brands.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ValidateBrandParams`
-
+**request:** `Pinnacle.ValidateBrandParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -384,7 +384,6 @@ await client.brands.validate({
 <dd>
 
 Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
-
 </dd>
 </dl>
 </dd>
@@ -400,8 +399,8 @@ Submit a brand for external vetting verification to enhance your brand's trust s
 
 ```typescript
 await client.brands.vet("b_1234567890", {});
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -415,39 +414,39 @@ await client.brands.vet("b_1234567890", {});
 <dl>
 <dd>
 
-**brandId:** `string`
+**brandId:** `string` 
 
 The unique identifier of the brand to vet. <br>
 
 This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Pinnacle.VetBrandParams`
-
+**request:** `Pinnacle.VetBrandParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Brands.RequestOptions`
-
+**requestOptions:** `Brands.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Audiences
-
 <details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">get</a>({ ...params }) -> Pinnacle.AudiencesGetResponse</code></summary>
 <dl>
 <dd>
@@ -461,7 +460,6 @@ This identifier is a string that always begins with the prefix `b_`, for example
 <dd>
 
 Retrieve an audience by ID with optional pagination.
-
 </dd>
 </dl>
 </dd>
@@ -477,10 +475,10 @@ Retrieve an audience by ID with optional pagination.
 
 ```typescript
 await client.audiences.get({
-    id: "aud_abc123",
+    id: "aud_abc123"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -494,21 +492,22 @@ await client.audiences.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AudiencesGetRequest`
-
+**request:** `Pinnacle.AudiencesGetRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Audiences.RequestOptions`
-
+**requestOptions:** `Audiences.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -526,7 +525,6 @@ await client.audiences.get({
 <dd>
 
 Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.
-
 </dd>
 </dl>
 </dd>
@@ -543,10 +541,10 @@ Create a new audience with optional initial contacts. Phone numbers that don't e
 ```typescript
 await client.audiences.create({
     name: "Marketing Campaign Q1",
-    description: "Contacts for Q1 marketing push",
+    description: "Contacts for Q1 marketing push"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -560,21 +558,22 @@ await client.audiences.create({
 <dl>
 <dd>
 
-**request:** `Pinnacle.CreateAudienceParams`
-
+**request:** `Pinnacle.CreateAudienceParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Audiences.RequestOptions`
-
+**requestOptions:** `Audiences.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -594,7 +593,6 @@ await client.audiences.create({
 Permanently delete an audience and all its contact associations.
 
 Note: This will NOT delete the contacts themselves, only the audience and its memberships.
-
 </dd>
 </dl>
 </dd>
@@ -610,10 +608,10 @@ Note: This will NOT delete the contacts themselves, only the audience and its me
 
 ```typescript
 await client.audiences.delete({
-    id: "aud_abc123",
+    id: "aud_abc123"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -627,21 +625,22 @@ await client.audiences.delete({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AudiencesDeleteRequest`
-
+**request:** `Pinnacle.AudiencesDeleteRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Audiences.RequestOptions`
-
+**requestOptions:** `Audiences.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -661,7 +660,6 @@ await client.audiences.delete({
 Update audience metadata. This endpoint does NOT modify contacts.
 
 To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove Contacts](/api-reference/audiences/remove-contacts) endpoints.
-
 </dd>
 </dl>
 </dd>
@@ -679,10 +677,10 @@ To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-c
 await client.audiences.update({
     id: "aud_abc123",
     name: "Updated Audience Name",
-    description: "New description",
+    description: "New description"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -696,27 +694,27 @@ await client.audiences.update({
 <dl>
 <dd>
 
-**request:** `Pinnacle.UpdateAudienceParams`
-
+**request:** `Pinnacle.UpdateAudienceParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Audiences.RequestOptions`
-
+**requestOptions:** `Audiences.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Contacts
-
 <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Contact</code></summary>
 <dl>
 <dd>
@@ -730,7 +728,6 @@ await client.audiences.update({
 <dd>
 
 Retrieve contact information for a given number.
-
 </dd>
 </dl>
 </dd>
@@ -746,10 +743,10 @@ Retrieve contact information for a given number.
 
 ```typescript
 await client.contacts.get({
-    id: "co_1234567890",
+    id: "co_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -763,21 +760,22 @@ await client.contacts.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ContactsGetRequest`
-
+**request:** `Pinnacle.ContactsGetRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `Contacts.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -795,7 +793,6 @@ await client.contacts.get({
 <dd>
 
 Create a new contact for a given phone number.
-
 </dd>
 </dl>
 </dd>
@@ -811,10 +808,10 @@ Create a new contact for a given phone number.
 
 ```typescript
 await client.contacts.create({
-    phoneNumber: "phoneNumber",
+    phoneNumber: "phoneNumber"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -828,21 +825,22 @@ await client.contacts.create({
 <dl>
 <dd>
 
-**request:** `Pinnacle.CreateContactParams`
-
+**request:** `Pinnacle.CreateContactParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `Contacts.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -860,7 +858,6 @@ await client.contacts.create({
 <dd>
 
 Update an existing contact.
-
 </dd>
 </dl>
 </dd>
@@ -880,10 +877,10 @@ await client.contacts.update({
     email: "alvaroopedtech@pinnacle.sh",
     name: "Retired Bestie",
     tags: ["friend"],
-    id: "co_1234567890",
+    id: "co_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -897,27 +894,27 @@ await client.contacts.update({
 <dl>
 <dd>
 
-**request:** `Pinnacle.UpdateContactParams`
-
+**request:** `Pinnacle.UpdateContactParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `Contacts.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Conversations
-
 <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Conversation | null</code></summary>
 <dl>
 <dd>
@@ -931,7 +928,6 @@ await client.contacts.update({
 <dd>
 
 Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
-
 </dd>
 </dl>
 </dd>
@@ -947,10 +943,10 @@ Fetch a specific conversation using either its unique identifier or by matching
 
 ```typescript
 await client.conversations.get({
-    id: "conv_1234567890",
+    id: "conv_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -964,21 +960,22 @@ await client.conversations.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.GetConversationParams`
-
+**request:** `Pinnacle.GetConversationParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Conversations.RequestOptions`
-
+**requestOptions:** `Conversations.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -996,7 +993,6 @@ await client.conversations.get({
 <dd>
 
 Retrieves conversations by page with optional filtering based off provided parameters.
-
 </dd>
 </dl>
 </dd>
@@ -1018,10 +1014,10 @@ await client.conversations.list({
     pageIndex: 0,
     pageSize: 20,
     receiver: "+16509231662",
-    sender: "+18445551234",
+    sender: "+18445551234"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1035,21 +1031,22 @@ await client.conversations.list({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ListConversationsParams`
-
+**request:** `Pinnacle.ListConversationsParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Conversations.RequestOptions`
-
+**requestOptions:** `Conversations.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1067,7 +1064,6 @@ await client.conversations.list({
 <dd>
 
 Update the notes associated with a specific conversation.
-
 </dd>
 </dl>
 </dd>
@@ -1084,10 +1080,10 @@ Update the notes associated with a specific conversation.
 ```typescript
 await client.conversations.update({
     id: "conv_1234567890",
-    notes: "Follow-up completed. Customer satisfied with resolution.",
+    notes: "Follow-up completed. Customer satisfied with resolution."
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1101,21 +1097,22 @@ await client.conversations.update({
 <dl>
 <dd>
 
-**request:** `Pinnacle.UpdateConversationParams`
-
+**request:** `Pinnacle.UpdateConversationParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Conversations.RequestOptions`
-
+**requestOptions:** `Conversations.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1133,7 +1130,6 @@ await client.conversations.update({
 <dd>
 
 Retrieve a paginated and filtered list of messages for a specific conversation.
-
 </dd>
 </dl>
 </dd>
@@ -1149,8 +1145,8 @@ Retrieve a paginated and filtered list of messages for a specific conversation.
 
 ```typescript
 await client.conversations.listMessages("id");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1165,34 +1161,34 @@ await client.conversations.listMessages("id");
 <dd>
 
 **id:** `string` — Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Pinnacle.ConversationsListMessagesRequest`
-
+**request:** `Pinnacle.ConversationsListMessagesRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Conversations.RequestOptions`
-
+**requestOptions:** `Conversations.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Messages
-
 <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(id) -> Pinnacle.Message</code></summary>
 <dl>
 <dd>
@@ -1206,7 +1202,6 @@ await client.conversations.listMessages("id");
 <dd>
 
 Retrieve a previously sent message.
-
 </dd>
 </dl>
 </dd>
@@ -1222,8 +1217,8 @@ Retrieve a previously sent message.
 
 ```typescript
 await client.messages.get("msg_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1238,20 +1233,21 @@ await client.messages.get("msg_1234567890");
 <dd>
 
 **id:** `string` — Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Messages.RequestOptions`
-
+**requestOptions:** `Messages.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1269,7 +1265,6 @@ await client.messages.get("msg_1234567890");
 <dd>
 
 Add or remove an emoji reaction to a previously sent message.
-
 </dd>
 </dl>
 </dd>
@@ -1287,12 +1282,12 @@ Add or remove an emoji reaction to a previously sent message.
 await client.messages.react({
     messageId: "msg_1234567890",
     options: {
-        force: true,
+        force: true
     },
-    reaction: "\uD83D\uDC4D",
+    reaction: "\uD83D\uDC4D"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1306,27 +1301,95 @@ await client.messages.react({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ReactMessageParams`
+**request:** `Pinnacle.ReactMessageParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Messages.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">cancel</a>(id) -> Pinnacle.CancelScheduledMessageResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancel a previously scheduled message before it is sent.
+
+Use the `scheduleId` returned from a scheduled send request (SMS, MMS, or RCS) to cancel the message.
+Once cancelled, the scheduled message will stop being sent.
 
+> **Note:** You cannot cancel a message that has already been sent.
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.messages.cancel("msg_sched_1234567890");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
-**requestOptions:** `Messages.RequestOptions`
+**id:** `string` — Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `Messages.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## PhoneNumbers
-
 <details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">search</a>({ ...params }) -> Pinnacle.PhoneNumberDetails[]</code></summary>
 <dl>
 <dd>
@@ -1340,7 +1403,6 @@ await client.messages.react({
 <dd>
 
 Search for available phone numbers that match your exact criteria.
-
 </dd>
 </dl>
 </dd>
@@ -1359,19 +1421,19 @@ await client.phoneNumbers.search({
     features: ["SMS", "MMS"],
     location: {
         city: "New York",
-        nationalDestinationCode: "212",
+        nationalDestinationCode: "212"
     },
     number: {
         contains: "514",
-        startsWith: "45",
+        startsWith: "45"
     },
     options: {
-        limit: 4,
+        limit: 4
     },
-    type: ["LOCAL"],
+    type: ["LOCAL"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1385,21 +1447,22 @@ await client.phoneNumbers.search({
 <dl>
 <dd>
 
-**request:** `Pinnacle.SearchPhoneNumberParams`
-
+**request:** `Pinnacle.SearchPhoneNumberParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `PhoneNumbers.RequestOptions`
-
+**requestOptions:** `PhoneNumbers.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1419,7 +1482,6 @@ await client.phoneNumbers.search({
 Purchase one or more phone numbers found through the [search endpoint](./search). <br>
 
 Billing uses your account credits and the numbers are ready for immediate use.
-
 </dd>
 </dl>
 </dd>
@@ -1435,10 +1497,10 @@ Billing uses your account credits and the numbers are ready for immediate use.
 
 ```typescript
 await client.phoneNumbers.buy({
-    numbers: ["+18559491727"],
+    numbers: ["+18559491727"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1452,21 +1514,22 @@ await client.phoneNumbers.buy({
 <dl>
 <dd>
 
-**request:** `Pinnacle.BuyPhoneNumberParams`
-
+**request:** `Pinnacle.BuyPhoneNumberParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `PhoneNumbers.RequestOptions`
-
+**requestOptions:** `PhoneNumbers.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1484,7 +1547,6 @@ await client.phoneNumbers.buy({
 <dd>
 
 Retrieve information about any phone number.
-
 </dd>
 </dl>
 </dd>
@@ -1505,12 +1567,12 @@ await client.phoneNumbers.get({
     options: {
         risk: true,
         enhanced_contact_info: {
-            context: "This is my friend from JZ. He has done a lot in the crypto space.",
-        },
-    },
+            context: "This is my friend from JZ. He has done a lot in the crypto space."
+        }
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1524,27 +1586,27 @@ await client.phoneNumbers.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RetrievePhoneNumberDetailsParams`
-
+**request:** `Pinnacle.RetrievePhoneNumberDetailsParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `PhoneNumbers.RequestOptions`
-
+**requestOptions:** `PhoneNumbers.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## RCS
-
 <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
 <dl>
 <dd>
@@ -1561,7 +1623,6 @@ Check RCS capabilities for one or more phone numbers.
 
 This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
 on specific phone numbers before sending RCS messages to them.
-
 </dd>
 </dl>
 </dd>
@@ -1577,10 +1638,10 @@ on specific phone numbers before sending RCS messages to them.
 
 ```typescript
 await client.rcs.getCapabilities({
-    phoneNumbers: ["+12345678901", "+19876543210"],
+    phoneNumbers: ["+12345678901", "+19876543210"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1594,21 +1655,22 @@ await client.rcs.getCapabilities({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RcsCapabilitiesQuery`
-
+**request:** `Pinnacle.RcsCapabilitiesQuery` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1628,22 +1690,20 @@ await client.rcs.getCapabilities({
 Whitelist a phone number for testing with your test RCS agent.
 
 ## Overview
-
 During development and testing, RCS agents can only send messages to whitelisted phone numbers.
 Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
 
 ## Verification Process
-
 After whitelisting a number, you'll need to complete verification:
 
 1. Check the test device for message from "RBM Tester Management"
 2. Click the "Make me a tester" button
 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
-    ```
-    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
-    ```
+   ```
+   https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+   ```
 
-> **⚠️ Important: Re-whitelisting Numbers**
+ > **⚠️ Important: Re-whitelisting Numbers**
 >
 > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
 
@@ -1652,7 +1712,6 @@ After whitelisting a number, you'll need to complete verification:
 > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
 > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
 > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
-
 </dd>
 </dl>
 </dd>
@@ -1669,10 +1728,10 @@ After whitelisting a number, you'll need to complete verification:
 ```typescript
 await client.rcs.whitelist({
     agentId: "agent_XXXXXXXXXXXX",
-    phoneNumber: "+12345678901",
+    phoneNumber: "+12345678901"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1686,21 +1745,22 @@ await client.rcs.whitelist({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RcsWhitelistRequest`
-
+**request:** `Pinnacle.RcsWhitelistRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1717,11 +1777,10 @@ await client.rcs.whitelist({
 <dl>
 <dd>
 
-Generate a link for initiating an RCS conversation with your agent.
+Generate a link for initiating an RCS conversation with your agent. 
 
 Users can click these links to start conversations with your RCS agent directly
 from websites, emails, or other applications.
-
 </dd>
 </dl>
 </dd>
@@ -1740,10 +1799,10 @@ await client.rcs.getLink({
     agentId: "agent_XXXXXXXXXXXX",
     testMode: false,
     phoneNumber: "+12345678901",
-    body: "Hello, I need help with my order",
+    body: "Hello, I need help with my order"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1757,27 +1816,27 @@ await client.rcs.getLink({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RcsLinkRequest`
-
+**request:** `Pinnacle.RcsLinkRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Webhooks
-
 <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>({ ...params }) -> Pinnacle.WebhookResult</code></summary>
 <dl>
 <dd>
@@ -1791,7 +1850,6 @@ await client.rcs.getLink({
 <dd>
 
 Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
-
 </dd>
 </dl>
 </dd>
@@ -1807,15 +1865,10 @@ Retrieve all webhook that are set up to receive events for specific URLs or phon
 
 ```typescript
 await client.webhooks.get({
-    identifiers: [
-        "https://www.pinnacle.sh/payment",
-        "+14155678901",
-        "https://www.pinnacle.sh/sms-callback",
-        "+14153456659",
-    ],
+    identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1829,27 +1882,27 @@ await client.webhooks.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.GetWebhookParams`
-
+**request:** `Pinnacle.GetWebhookParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Webhooks.RequestOptions`
-
+**requestOptions:** `Webhooks.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Audiences Contacts
-
 <details><summary><code>client.audiences.contacts.<a href="/src/api/resources/audiences/resources/contacts/client/Client.ts">remove</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
 <dl>
 <dd>
@@ -1866,10 +1919,10 @@ Remove contacts from an existing audience. This operation is idempotent.
 
 - Only removes contacts that exist in the audience
 - Contacts not in the audience are ignored
-  </dd>
-  </dl>
-  </dd>
-  </dl>
+</dd>
+</dl>
+</dd>
+</dl>
 
 #### 🔌 Usage
 
@@ -1882,10 +1935,10 @@ Remove contacts from an existing audience. This operation is idempotent.
 ```typescript
 await client.audiences.contacts.remove({
     id: "aud_abc123",
-    contacts: ["+12125551234", "co_def456"],
+    contacts: ["+12125551234", "co_def456"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1899,21 +1952,22 @@ await client.audiences.contacts.remove({
 <dl>
 <dd>
 
-**request:** `Pinnacle.audiences.RemoveContactsParams`
-
+**request:** `Pinnacle.audiences.RemoveContactsParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `Contacts.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1935,10 +1989,10 @@ Add contacts to an existing audience. This operation is additive and idempotent.
 - Phone numbers that don't exist will be auto-created as contacts
 - Duplicate adds are ignored
 - Contacts already in the audience are ignored
-  </dd>
-  </dl>
-  </dd>
-  </dl>
+</dd>
+</dl>
+</dd>
+</dl>
 
 #### 🔌 Usage
 
@@ -1951,10 +2005,10 @@ Add contacts to an existing audience. This operation is additive and idempotent.
 ```typescript
 await client.audiences.contacts.add({
     id: "aud_abc123",
-    contacts: ["+12125551234", "co_def456", "+13105551234"],
+    contacts: ["+12125551234", "co_def456", "+13105551234"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1968,27 +2022,27 @@ await client.audiences.contacts.add({
 <dl>
 <dd>
 
-**request:** `Pinnacle.audiences.AddContactsParams`
-
+**request:** `Pinnacle.audiences.AddContactsParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `Contacts.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Campaigns Dlc
-
 <details><summary><code>client.campaigns.dlc.<a href="/src/api/resources/campaigns/resources/dlc/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.AutofillDlcCampaignResponse</code></summary>
 <dl>
 <dd>
@@ -2002,7 +2056,6 @@ await client.audiences.contacts.add({
 <dd>
 
 Generate campaign details based off existing campaign and the brand it's connected to.
-
 </dd>
 </dl>
 </dd>
@@ -2019,10 +2072,10 @@ Generate campaign details based off existing campaign and the brand it's connect
 ```typescript
 await client.campaigns.dlc.autofill({
     additionalInfo: "Please autofill missing campaign fields using my brand profile",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2036,21 +2089,22 @@ await client.campaigns.dlc.autofill({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AutofillCampaignParams`
-
+**request:** `Pinnacle.AutofillCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Dlc.RequestOptions`
-
+**requestOptions:** `Dlc.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2068,7 +2122,6 @@ await client.campaigns.dlc.autofill({
 <dd>
 
 Retrieve 10DLC campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2084,8 +2137,8 @@ Retrieve 10DLC campaign.
 
 ```typescript
 await client.campaigns.dlc.get("dlc_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2100,20 +2153,21 @@ await client.campaigns.dlc.get("dlc_1234567890");
 <dd>
 
 **campaignId:** `string` — Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Dlc.RequestOptions`
-
+**requestOptions:** `Dlc.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2131,7 +2185,6 @@ await client.campaigns.dlc.get("dlc_1234567890");
 <dd>
 
 Submit your 10DLC campaign for approval and activation with carriers.
-
 </dd>
 </dl>
 </dd>
@@ -2147,8 +2200,8 @@ Submit your 10DLC campaign for approval and activation with carriers.
 
 ```typescript
 await client.campaigns.dlc.submit("dlc_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2162,24 +2215,25 @@ await client.campaigns.dlc.submit("dlc_1234567890");
 <dl>
 <dd>
 
-**campaignId:** `string`
+**campaignId:** `string` 
 
 Unique identifier of the 10DLC campaign to submit.
 <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Dlc.RequestOptions`
-
+**requestOptions:** `Dlc.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2199,7 +2253,6 @@ Unique identifier of the 10DLC campaign to submit.
 Create a new 10DLC campaign or updates an existing one. <br>
 
 Omit campaignId to create a campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2221,20 +2274,20 @@ await client.campaigns.dlc.upsert({
     keywords: {
         HELP: {
             message: "Reply HELP for assistance, STOP to opt-out",
-            values: ["HELP", "INFO", "SUPPORT"],
+            values: ["HELP", "INFO", "SUPPORT"]
         },
         OPT_IN: {
             message: "Welcome. You are now subscribed to Pinnacle.",
-            values: ["JOIN", "START", "SUBSCRIBE"],
+            values: ["JOIN", "START", "SUBSCRIBE"]
         },
         OPT_OUT: {
             message: "You have been unsubscribed. Reply START to rejoin.",
-            values: ["STOP", "QUIT", "UNSUBSCRIBE"],
-        },
+            values: ["STOP", "QUIT", "UNSUBSCRIBE"]
+        }
     },
     links: {
         privacyPolicy: "https://www.pinnacle.sh/privacy",
-        termsOfService: "https://www.pinnacle.sh/terms",
+        termsOfService: "https://www.pinnacle.sh/terms"
     },
     messageFlow: "Customer initiates -> Automated response -> Agent follow-up if needed",
     name: "Account Notifications",
@@ -2244,16 +2297,16 @@ await client.campaigns.dlc.upsert({
         directLending: false,
         embeddedLink: "https://www.pinnacle.sh/example",
         embeddedPhone: false,
-        numberPooling: false,
+        numberPooling: false
     },
     sampleMessages: ["Security alert: Unusual login detected from new device."],
     useCase: {
         sub: ["FRAUD_ALERT"],
-        value: "ACCOUNT_NOTIFICATION",
-    },
+        value: "ACCOUNT_NOTIFICATION"
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2267,21 +2320,22 @@ await client.campaigns.dlc.upsert({
 <dl>
 <dd>
 
-**request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
-
+**request:** `Pinnacle.campaigns.UpsertDlcCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Dlc.RequestOptions`
-
+**requestOptions:** `Dlc.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2299,7 +2353,6 @@ await client.campaigns.dlc.upsert({
 <dd>
 
 Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
-
 </dd>
 </dl>
 </dd>
@@ -2316,10 +2369,10 @@ Validate your 10DLC campaign configuration against carrier requirements and comp
 ```typescript
 await client.campaigns.dlc.validate({
     additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2333,27 +2386,27 @@ await client.campaigns.dlc.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ValidateCampaignParams`
-
+**request:** `Pinnacle.ValidateCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Dlc.RequestOptions`
-
+**requestOptions:** `Dlc.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Campaigns TollFree
-
 <details><summary><code>client.campaigns.tollFree.<a href="/src/api/resources/campaigns/resources/tollFree/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.TollFreeAutofillResponse</code></summary>
 <dl>
 <dd>
@@ -2367,7 +2420,6 @@ await client.campaigns.dlc.validate({
 <dd>
 
 Generate campaign details based off existing campaign and the brand it's connected to.
-
 </dd>
 </dl>
 </dd>
@@ -2384,10 +2436,10 @@ Generate campaign details based off existing campaign and the brand it's connect
 ```typescript
 await client.campaigns.tollFree.autofill({
     additionalInfo: "Please autofill missing campaign fields using my brand profile",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2401,21 +2453,22 @@ await client.campaigns.tollFree.autofill({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AutofillCampaignParams`
-
+**request:** `Pinnacle.AutofillCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `TollFree.RequestOptions`
-
+**requestOptions:** `TollFree.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2433,7 +2486,6 @@ await client.campaigns.tollFree.autofill({
 <dd>
 
 Retrieve Toll-Free campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2449,8 +2501,8 @@ Retrieve Toll-Free campaign.
 
 ```typescript
 await client.campaigns.tollFree.get("tf_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2465,20 +2517,21 @@ await client.campaigns.tollFree.get("tf_1234567890");
 <dd>
 
 **campaignId:** `string` — Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `TollFree.RequestOptions`
-
+**requestOptions:** `TollFree.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2496,7 +2549,6 @@ await client.campaigns.tollFree.get("tf_1234567890");
 <dd>
 
 Submit your toll-free campaign for approval and activation with carriers.
-
 </dd>
 </dl>
 </dd>
@@ -2512,8 +2564,8 @@ Submit your toll-free campaign for approval and activation with carriers.
 
 ```typescript
 await client.campaigns.tollFree.submit("tf_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2528,20 +2580,21 @@ await client.campaigns.tollFree.submit("tf_1234567890");
 <dd>
 
 **campaignId:** `string` — Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `TollFree.RequestOptions`
-
+**requestOptions:** `TollFree.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2561,7 +2614,6 @@ await client.campaigns.tollFree.submit("tf_1234567890");
 Create a new toll-free campaign or updates an existing one.<br>
 
 Omit campaignId to create a campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2579,21 +2631,37 @@ Omit campaignId to create a campaign.
 await client.campaigns.tollFree.upsert({
     brand: "b_1234567890",
     campaignId: "tf_1234567890",
+    keywords: {
+        HELP: {
+            message: "Email founders@trypinnacle.app for support."
+        },
+        OPT_IN: {
+            message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
+            keywords: ["START", "SUBSCRIBE"]
+        }
+    },
+    links: {
+        privacyPolicy: "https://www.pinnacle.sh/privacy",
+        termsOfService: "https://www.pinnacle.sh/terms"
+    },
     monthlyVolume: "1,000",
     name: "Pinnacle",
     optIn: {
         method: "DIGITAL",
         url: "https://www.pinnacle.sh/",
-        workflowDescription: "Visit https://www.pinnacle.sh/",
+        workflowDescription: "Visit https://www.pinnacle.sh/"
+    },
+    options: {
+        ageGated: false
     },
     productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
     useCase: {
         summary: "Alerts clients about any Pinnacle hosted workshops.",
-        value: "WORKSHOP_ALERTS",
-    },
+        value: "WORKSHOP_ALERTS"
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2607,21 +2675,22 @@ await client.campaigns.tollFree.upsert({
 <dl>
 <dd>
 
-**request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
-
+**request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `TollFree.RequestOptions`
-
+**requestOptions:** `TollFree.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2639,7 +2708,6 @@ await client.campaigns.tollFree.upsert({
 <dd>
 
 Validate your toll-free campaign configuration against carrier requirements and compliance rules.
-
 </dd>
 </dl>
 </dd>
@@ -2656,10 +2724,10 @@ Validate your toll-free campaign configuration against carrier requirements and
 ```typescript
 await client.campaigns.tollFree.validate({
     additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2673,27 +2741,27 @@ await client.campaigns.tollFree.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ValidateCampaignParams`
-
+**request:** `Pinnacle.ValidateCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `TollFree.RequestOptions`
-
+**requestOptions:** `TollFree.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Campaigns Rcs
-
 <details><summary><code>client.campaigns.rcs.<a href="/src/api/resources/campaigns/resources/rcs/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.RcsAutofillResponse</code></summary>
 <dl>
 <dd>
@@ -2707,7 +2775,6 @@ await client.campaigns.tollFree.validate({
 <dd>
 
 Generate campaign details based off existing campaign and the brand it's connected to.
-
 </dd>
 </dl>
 </dd>
@@ -2724,10 +2791,10 @@ Generate campaign details based off existing campaign and the brand it's connect
 ```typescript
 await client.campaigns.rcs.autofill({
     additionalInfo: "Please autofill missing campaign fields using my brand profile",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2741,21 +2808,22 @@ await client.campaigns.rcs.autofill({
 <dl>
 <dd>
 
-**request:** `Pinnacle.AutofillCampaignParams`
-
+**request:** `Pinnacle.AutofillCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2773,7 +2841,6 @@ await client.campaigns.rcs.autofill({
 <dd>
 
 Retrieve RCS campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2789,8 +2856,8 @@ Retrieve RCS campaign.
 
 ```typescript
 await client.campaigns.rcs.get("rcs_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2805,20 +2872,21 @@ await client.campaigns.rcs.get("rcs_1234567890");
 <dd>
 
 **campaignId:** `string` — Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2836,7 +2904,6 @@ await client.campaigns.rcs.get("rcs_1234567890");
 <dd>
 
 Submit your RCS campaign for approval and activation with carriers.
-
 </dd>
 </dl>
 </dd>
@@ -2852,8 +2919,8 @@ Submit your RCS campaign for approval and activation with carriers.
 
 ```typescript
 await client.campaigns.rcs.submit("rcs_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2868,20 +2935,21 @@ await client.campaigns.rcs.submit("rcs_1234567890");
 <dd>
 
 **campaignId:** `string` — Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2901,7 +2969,6 @@ await client.campaigns.rcs.submit("rcs_1234567890");
 Create a new RCS campaign or updates an existing one. <br>
 
 Omit campaignId to create a campaign.
-
 </dd>
 </dl>
 </dd>
@@ -2919,58 +2986,63 @@ Omit campaignId to create a campaign.
 await client.campaigns.rcs.upsert({
     agent: {
         color: "#000000",
-        description:
-            "Engaging campaigns with RBM \u2013 next-gen SMS marketing with rich content and better analytics.",
-        emails: [
-            {
+        description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.",
+        emails: [{
                 email: "founders@trypinnacle.app",
-                label: "Email Us",
-            },
-        ],
-        heroUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6",
-        iconUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3",
-        name: "Pinnacle Software Development",
-        phones: [
-            {
+                label: "Email Us"
+            }],
+        heroUrl: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
+        iconUrl: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
+        name: "Pinnacle - RCS Demo",
+        phones: [{
                 label: "Contact us directly",
-                phone: "+14154467821",
-            },
-        ],
-        websites: [
-            {
+                phone: "+14154467821"
+            }],
+        websites: [{
                 label: "Get started with Pinnacle",
-                url: "https://www.trypinnacle.app/",
-            },
-        ],
+                url: "https://www.trypinnacle.app/"
+            }]
     },
-    brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
     brand: "b_1234567890",
     campaignId: "rcs_1234567890",
-    expectedAgentResponses: [
-        "Here are the things I can help you with.",
-        "I can assist you with booking an appointment, or you may choose to book manually.",
-        "Here are the available times to connect with a representative tomorrow.",
-        "Your appointment has been scheduled.",
-    ],
+    expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
     links: {
         privacyPolicy: "https://www.trypinnacle.app/privacy",
-        termsOfService: "https://www.trypinnacle.app/terms",
+        termsOfService: "https://www.trypinnacle.app/terms"
     },
-    optIn: {
-        method: "WEBSITE",
-        termsAndConditions: "Would you like to subscribe to Pinnacle?",
+    useCase: {
+        behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
+        value: "OTHER"
     },
-    optOut: {
-        description: "Reply STOP to opt-out anytime.",
-        keywords: ["STOP", "UNSUBSCRIBE", "END"],
+    optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
+    messagingType: "MULTI_USE",
+    carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
+    keywords: {
+        HELP: {
+            message: "Email founders@trypinnacle.app for support.",
+            keywords: ["HELP", "SUPPORT"]
+        },
+        OPT_IN: {
+            message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
+            keywords: ["START", "SUBSCRIBE"]
+        },
+        OPT_OUT: {
+            message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
+            keywords: ["STOP", "UNSUBSCRIBE", "END"]
+        }
     },
-    useCase: {
-        behavior: "Acts as a customer service representative.",
-        value: "OTHER",
+    traffic: {
+        monthlyWebsite: 10000,
+        monthlyRcsEstimate: 10000
     },
+    agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
+    interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
+    isConversational: true,
+    ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
+    demoTrigger: "Text \"START\" to trigger the flow."
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2984,21 +3056,22 @@ await client.campaigns.rcs.upsert({
 <dl>
 <dd>
 
-**request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
-
+**request:** `Pinnacle.campaigns.UpsertRcsCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3016,7 +3089,6 @@ await client.campaigns.rcs.upsert({
 <dd>
 
 Validate your RCS campaign configuration against carrier requirements and compliance rules.
-
 </dd>
 </dl>
 </dd>
@@ -3033,10 +3105,10 @@ Validate your RCS campaign configuration against carrier requirements and compli
 ```typescript
 await client.campaigns.rcs.validate({
     additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-    campaignId: "dlc_1234567890",
+    campaignId: "dlc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3050,27 +3122,27 @@ await client.campaigns.rcs.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.ValidateCampaignParams`
-
+**request:** `Pinnacle.ValidateCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Messages Sms
-
 <details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SmsSendResponse</code></summary>
 <dl>
 <dd>
@@ -3084,7 +3156,6 @@ await client.campaigns.rcs.validate({
 <dd>
 
 Send a SMS message immediately or schedule it for future delivery.
-
 </dd>
 </dl>
 </dd>
@@ -3102,10 +3173,10 @@ Send a SMS message immediately or schedule it for future delivery.
 await client.messages.sms.send({
     from: "+14155164736",
     text: "Hey!",
-    to: "+14154746461",
+    to: "+14154746461"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3119,21 +3190,22 @@ await client.messages.sms.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.messages.Sms`
-
+**request:** `Pinnacle.messages.Sms` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Sms.RequestOptions`
-
+**requestOptions:** `Sms.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3151,7 +3223,6 @@ await client.messages.sms.send({
 <dd>
 
 Validate SMS message content without sending it.
-
 </dd>
 </dl>
 </dd>
@@ -3167,10 +3238,10 @@ Validate SMS message content without sending it.
 
 ```typescript
 await client.messages.sms.validate({
-    text: "Hello from Pinnacle",
+    text: "Hello from Pinnacle"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3184,27 +3255,27 @@ await client.messages.sms.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.SmsContent`
-
+**request:** `Pinnacle.SmsContent` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Sms.RequestOptions`
-
+**requestOptions:** `Sms.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Messages Mms
-
 <details><summary><code>client.messages.mms.<a href="/src/api/resources/messages/resources/mms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.MmsSendResponse</code></summary>
 <dl>
 <dd>
@@ -3218,7 +3289,6 @@ await client.messages.sms.validate({
 <dd>
 
 Send a MMS immediately or schedule it for future delivery.
-
 </dd>
 </dl>
 </dd>
@@ -3238,13 +3308,13 @@ await client.messages.mms.send({
     mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
     options: {
         multiple_messages: true,
-        validate: true,
+        validate: true
     },
     text: "Check out this image!",
-    to: "+14154746461",
+    to: "+14154746461"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3258,21 +3328,22 @@ await client.messages.mms.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.messages.Mms`
-
+**request:** `Pinnacle.messages.Mms` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Mms.RequestOptions`
-
+**requestOptions:** `Mms.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3290,7 +3361,6 @@ await client.messages.mms.send({
 <dd>
 
 Validate MMS message content without sending it.
-
 </dd>
 </dl>
 </dd>
@@ -3306,15 +3376,11 @@ Validate MMS message content without sending it.
 
 ```typescript
 await client.messages.mms.validate({
-    mediaUrls: [
-        "https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg",
-        "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w",
-        "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg",
-    ],
-    text: "Check out these images!",
+    mediaUrls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"],
+    text: "Check out these images!"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3328,28 +3394,28 @@ await client.messages.mms.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.MmsContent`
-
+**request:** `Pinnacle.MmsContent` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Mms.RequestOptions`
-
+**requestOptions:** `Mms.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Messages Rcs
-
-<details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.RcsSendResponse</code></summary>
+<details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SendRichMessageResponse</code></summary>
 <dl>
 <dd>
 
@@ -3364,7 +3430,6 @@ await client.messages.mms.validate({
 Send a RCS message immediately or schedule it for future delivery. <br>
 
 Requires an active RCS agent and recipient devices that support RCS Business Messaging.
-
 </dd>
 </dl>
 </dd>
@@ -3380,19 +3445,17 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
 
 ```typescript
 await client.messages.rcs.send({
-    quickReplies: [
-        {
+    quickReplies: [{
             type: "openUrl",
             payload: "payload",
-            title: "title",
-        },
-    ],
+            title: "title"
+        }],
     text: "text",
     from: "from",
-    to: "to",
+    to: "to"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3406,21 +3469,22 @@ await client.messages.rcs.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RichMessage`
-
+**request:** `Pinnacle.RichMessage` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3448,7 +3512,6 @@ This endpoint allows RCS agents to display a typing indicator to recipients. The
 **Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.
 
 > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
-
 </dd>
 </dl>
 </dd>
@@ -3467,11 +3530,11 @@ await client.messages.rcs.sendTyping({
     agentId: "agent_pinnacle",
     to: "+14154746461",
     options: {
-        test_mode: false,
-    },
+        test_mode: false
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3485,21 +3548,22 @@ await client.messages.rcs.sendTyping({
 <dl>
 <dd>
 
-**request:** `Pinnacle.messages.SendTypingIndicatorSchema`
-
+**request:** `Pinnacle.messages.SendTypingIndicatorSchema` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3517,7 +3581,6 @@ await client.messages.rcs.sendTyping({
 <dd>
 
 Validate RCS message content without sending it.
-
 </dd>
 </dl>
 </dd>
@@ -3533,17 +3596,15 @@ Validate RCS message content without sending it.
 
 ```typescript
 await client.messages.rcs.validate({
-    quickReplies: [
-        {
+    quickReplies: [{
             type: "openUrl",
             payload: "payload",
-            title: "title",
-        },
-    ],
-    text: "text",
+            title: "title"
+        }],
+    text: "text"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3557,27 +3618,27 @@ await client.messages.rcs.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.RcsValidateContent`
-
+**request:** `Pinnacle.RcsValidateContent` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Rcs.RequestOptions`
-
+**requestOptions:** `Rcs.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## PhoneNumbers Webhook
-
 <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
 <dl>
 <dd>
@@ -3591,7 +3652,6 @@ await client.messages.rcs.validate({
 <dd>
 
 Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
-
 </dd>
 </dl>
 </dd>
@@ -3608,10 +3668,10 @@ Connect a webhook to your phone number to receive real-time notifications for in
 ```typescript
 await client.phoneNumbers.webhook.attach("%2B14155551234", {
     webhookId: "wh_1234567890",
-    event: "MESSAGE.STATUS",
+    event: "MESSAGE.STATUS"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3625,33 +3685,34 @@ await client.phoneNumbers.webhook.attach("%2B14155551234", {
 <dl>
 <dd>
 
-**phone:** `string`
+**phone:** `string` 
 
 The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
 
 Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Pinnacle.AttachWebhookParams`
-
+**request:** `Pinnacle.AttachWebhookParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Webhook.RequestOptions`
-
+**requestOptions:** `Webhook.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3671,7 +3732,6 @@ Must be a phone number that you own and have already [purchased](./buy) through
 Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
 
 The webhook configuration itself remains intact and available for use with other phone numbers.
-
 </dd>
 </dl>
 </dd>
@@ -3687,8 +3747,8 @@ The webhook configuration itself remains intact and available for use with other
 
 ```typescript
 await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3702,43 +3762,43 @@ await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
 <dl>
 <dd>
 
-**phone:** `string`
+**phone:** `string` 
 
 The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
 
 Must be a phone number that you own and currently has the specified webhook attached.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**webhookId:** `string`
+**webhookId:** `string` 
 
 The unique identifier of the webhook you want to detach from the phone number. <br>
 
 This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Webhook.RequestOptions`
-
+**requestOptions:** `Webhook.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## PhoneNumbers Campaign
-
 <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachedPhoneNumberResult</code></summary>
 <dl>
 <dd>
@@ -3752,7 +3812,6 @@ This must be a valid webhook ID that is currently attached to the specified phon
 <dd>
 
 Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
-
 </dd>
 </dl>
 </dd>
@@ -3770,10 +3829,10 @@ Link a phone number to a specific campaign. Phone numbers must be linked to a ca
 await client.phoneNumbers.campaign.attach({
     phones: ["+14155550123", "+14155559876", "+14155550111"],
     campaignType: "TOLL_FREE",
-    campaignId: "tf_1234567890",
+    campaignId: "tf_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3787,21 +3846,22 @@ await client.phoneNumbers.campaign.attach({
 <dl>
 <dd>
 
-**request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
-
+**request:** `Pinnacle.phoneNumbers.AttachCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Campaign.RequestOptions`
-
+**requestOptions:** `Campaign.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3819,7 +3879,6 @@ await client.phoneNumbers.campaign.attach({
 <dd>
 
 Remove the association between a phone number and its attached campaign.
-
 </dd>
 </dl>
 </dd>
@@ -3835,10 +3894,10 @@ Remove the association between a phone number and its attached campaign.
 
 ```typescript
 await client.phoneNumbers.campaign.detach({
-    phones: ["+14155559876", "14155550111"],
+    phones: ["+14155559876", "14155550111"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3852,27 +3911,27 @@ await client.phoneNumbers.campaign.detach({
 <dl>
 <dd>
 
-**request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
-
+**request:** `Pinnacle.phoneNumbers.DetachCampaignParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Campaign.RequestOptions`
-
+**requestOptions:** `Campaign.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Status Get
-
 <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">brand</a>(brandId) -> Pinnacle.BrandStatus</code></summary>
 <dl>
 <dd>
@@ -3886,7 +3945,6 @@ await client.phoneNumbers.campaign.detach({
 <dd>
 
 Retrieve a brand's status.
-
 </dd>
 </dl>
 </dd>
@@ -3902,8 +3960,8 @@ Retrieve a brand's status.
 
 ```typescript
 await client.status.get.brand("b_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3918,20 +3976,21 @@ await client.status.get.brand("b_1234567890");
 <dd>
 
 **brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Get.RequestOptions`
-
+**requestOptions:** `Get.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -3949,7 +4008,6 @@ await client.status.get.brand("b_1234567890");
 <dd>
 
 Retrieve a toll-free campaign's status.
-
 </dd>
 </dl>
 </dd>
@@ -3965,8 +4023,8 @@ Retrieve a toll-free campaign's status.
 
 ```typescript
 await client.status.get.tollFree("tf_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -3981,20 +4039,21 @@ await client.status.get.tollFree("tf_1234567890");
 <dd>
 
 **campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Get.RequestOptions`
-
+**requestOptions:** `Get.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4012,7 +4071,6 @@ await client.status.get.tollFree("tf_1234567890");
 <dd>
 
 Retrieve a 10DLC campaign's status.
-
 </dd>
 </dl>
 </dd>
@@ -4028,8 +4086,8 @@ Retrieve a 10DLC campaign's status.
 
 ```typescript
 await client.status.get.dlc("dlc_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4044,20 +4102,21 @@ await client.status.get.dlc("dlc_1234567890");
 <dd>
 
 **campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Get.RequestOptions`
-
+**requestOptions:** `Get.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4075,7 +4134,6 @@ await client.status.get.dlc("dlc_1234567890");
 <dd>
 
 Retrieve a RCS campaign's status.
-
 </dd>
 </dl>
 </dd>
@@ -4091,8 +4149,8 @@ Retrieve a RCS campaign's status.
 
 ```typescript
 await client.status.get.rcs("rcs_1234567890");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4107,20 +4165,21 @@ await client.status.get.rcs("rcs_1234567890");
 <dd>
 
 **campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Get.RequestOptions`
-
+**requestOptions:** `Get.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4140,7 +4199,6 @@ await client.status.get.rcs("rcs_1234567890");
 Retrieve a phone number's order status and campaign attachment status. <br>
 
 Check if a number is active and ready to send messages.
-
 </dd>
 </dl>
 </dd>
@@ -4156,8 +4214,8 @@ Check if a number is active and ready to send messages.
 
 ```typescript
 await client.status.get.phoneNumber("+14151234567");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4172,26 +4230,26 @@ await client.status.get.phoneNumber("+14151234567");
 <dd>
 
 **phoneNumber:** `string` — Phone number in E164 format that is in review.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Get.RequestOptions`
-
+**requestOptions:** `Get.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Tools Url
-
 <details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ShortenedUrl</code></summary>
 <dl>
 <dd>
@@ -4205,7 +4263,6 @@ await client.status.get.phoneNumber("+14151234567");
 <dd>
 
 Create a shortened URL that redirects visitors to the provided destination URL.
-
 </dd>
 </dl>
 </dd>
@@ -4223,11 +4280,11 @@ Create a shortened URL that redirects visitors to the provided destination URL.
 await client.tools.url.create({
     url: "https://www.pinnacle.sh/",
     options: {
-        expiresAt: "2025-06-23T16:18:25.000Z",
-    },
+        expiresAt: "2025-06-23T16:18:25.000Z"
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4241,21 +4298,22 @@ await client.tools.url.create({
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.CreateUrlParams`
-
+**request:** `Pinnacle.tools.CreateUrlParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Url.RequestOptions`
-
+**requestOptions:** `Url.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4273,7 +4331,6 @@ await client.tools.url.create({
 <dd>
 
 Retrieve configuration and details for your shortened URL using its unique identifier.
-
 </dd>
 </dl>
 </dd>
@@ -4289,8 +4346,8 @@ Retrieve configuration and details for your shortened URL using its unique ident
 
 ```typescript
 await client.tools.url.get("ePzVxILF");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4304,25 +4361,26 @@ await client.tools.url.get("ePzVxILF");
 <dl>
 <dd>
 
-**linkId:** `string`
+**linkId:** `string` 
 
 Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
 
 See the response of [Create Shortened URL](./create-url) for more information.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Url.RequestOptions`
-
+**requestOptions:** `Url.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4340,7 +4398,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
 <dd>
 
 Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
-
 </dd>
 </dl>
 </dd>
@@ -4356,10 +4413,10 @@ Update the destination or expiration date of an existing shortened URL. Expiring
 
 ```typescript
 await client.tools.url.update("ePzVxILF", {
-    url: "https://www.pinnacle.sh/",
+    url: "https://www.pinnacle.sh/"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4373,39 +4430,39 @@ await client.tools.url.update("ePzVxILF", {
 <dl>
 <dd>
 
-**linkId:** `string`
+**linkId:** `string` 
 
 Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
 
 See the response of [Create Shortened URL](./create-url) for more information.
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.UpdateUrlParams`
-
+**request:** `Pinnacle.tools.UpdateUrlParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Url.RequestOptions`
-
+**requestOptions:** `Url.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Tools File
-
 <details><summary><code>client.tools.file.<a href="/src/api/resources/tools/resources/file/client/Client.ts">upload</a>({ ...params }) -> Pinnacle.UploadResults</code></summary>
 <dl>
 <dd>
@@ -4419,7 +4476,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
 <dd>
 
 Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
-
 </dd>
 </dl>
 </dd>
@@ -4441,12 +4497,12 @@ await client.tools.file.upload({
     options: {
         deleteAt: "2025-12-31T23:59:59Z",
         download: {
-            expiresAt: "2025-06-30T12:00:00.000Z",
-        },
-    },
+            expiresAt: "2025-06-30T12:00:00.000Z"
+        }
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4460,21 +4516,22 @@ await client.tools.file.upload({
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.UploadFileParams`
-
+**request:** `Pinnacle.tools.UploadFileParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `File_.RequestOptions`
-
+**requestOptions:** `File_.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4511,15 +4568,10 @@ Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
 
 ```typescript
 await client.tools.file.refresh({
-    urls: [
-        "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken",
-        "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2",
-        "invalid/url",
-        "https://google.com",
-    ],
+    urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4533,27 +4585,27 @@ await client.tools.file.refresh({
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.RefreshFileParams`
-
+**request:** `Pinnacle.tools.RefreshFileParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `File_.RequestOptions`
-
+**requestOptions:** `File_.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Tools ContactCard
-
 <details><summary><code>client.tools.contactCard.<a href="/src/api/resources/tools/resources/contactCard/client/Client.ts">get</a>({ ...params }) -> Pinnacle.VCardData</code></summary>
 <dl>
 <dd>
@@ -4567,7 +4619,6 @@ await client.tools.file.refresh({
 <dd>
 
 Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
-
 </dd>
 </dl>
 </dd>
@@ -4583,10 +4634,10 @@ Retrieve contact information as a vCard and get a presigned URL to download the
 
 ```typescript
 await client.tools.contactCard.get({
-    id: "cc_1234567890",
+    id: "cc_1234567890"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4600,21 +4651,22 @@ await client.tools.contactCard.get({
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.GetVcardParams`
-
+**request:** `Pinnacle.tools.GetVcardParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `ContactCard.RequestOptions`
-
+**requestOptions:** `ContactCard.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -4632,7 +4684,6 @@ await client.tools.contactCard.get({
 <dd>
 
 Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
-
 </dd>
 </dl>
 </dd>
@@ -4655,12 +4706,11 @@ await client.tools.contactCard.upsert({
         givenName: "Jane",
         additionalNames: ["A."],
         honorificPrefixes: ["Dr."],
-        honorificSuffixes: ["PhD"],
+        honorificSuffixes: ["PhD"]
     },
     nickname: ["Janie"],
     birthday: "1990-02-15",
-    addresses: [
-        {
+    addresses: [{
             countryName: "USA",
             extendedAddress: "Apt. 4B",
             locality: "Anytown",
@@ -4668,39 +4718,34 @@ await client.tools.contactCard.upsert({
             postOfficeBox: "PO Box 123",
             region: "CA",
             streetAddress: "123 Main St",
-            type: ["HOME", "PREF"],
-        },
-    ],
+            type: ["HOME", "PREF"]
+        }],
     url: "https://app.pinnacle.sh",
-    phones: [
-        {
+    phones: [{
             type: ["CELL"],
-            value: "+15551234567",
-        },
-    ],
-    emails: [
-        {
+            value: "+15551234567"
+        }],
+    emails: [{
             type: ["INTERNET"],
-            value: "jane.smith@example.com",
-        },
-    ],
+            value: "jane.smith@example.com"
+        }],
     timezone: "America/Los_Angeles",
     geo: {
         latitude: 34.0522,
-        longitude: -118.2437,
+        longitude: -118.2437
     },
     title: "Engineer",
     role: "Developer",
     organization: {
         name: "Acme Co",
-        units: ["Engineering", "R&D"],
+        units: ["Engineering", "R&D"]
     },
     categories: ["Friend", "Colleague"],
     note: "Test contact entry",
-    photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ",
+    photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -4714,21 +4759,22 @@ await client.tools.contactCard.upsert({
 <dl>
 <dd>
 
-**request:** `Pinnacle.tools.UpsertVcardParams`
-
+**request:** `Pinnacle.tools.UpsertVcardParams` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `ContactCard.RequestOptions`
-
+**requestOptions:** `ContactCard.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>