rcs-js 2.0.0-rc.10 → 2.0.0-rc.12

package/reference.md

@@ -1199,6 +1199,235 @@ await client.phoneNumbers.get({
 </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>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.rcs.getCapabilities({
+    phoneNumbers: ["+12345678901", "+19876543210"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.RcsCapabilitiesQuery`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Rcs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">whitelist</a>({ ...params }) -> Pinnacle.RcsWhitelistResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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 add test devices to your agent's whitelist before sending test messages.
+
+## Verification Process
+
+After whitelisting a number, you'll need to complete verification:
+
+1. Check the test device for an "RBM Tester Management" request
+2. Accept the request on the device
+3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+    ```
+    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+    ```
+
+> **Important Notes**
+>
+> - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
+> - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
+> - **Verification required:** The whitelist request isn't complete until you verify the device.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.rcs.whitelist({
+    agentId: "agent_XXXXXXXXXXXX",
+    phoneNumber: "+12345678901",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.RcsWhitelistRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Rcs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getLink</a>({ ...params }) -> Pinnacle.RcsLinkResult</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.rcs.getLink({
+    agentId: "agent_XXXXXXXXXXXX",
+    testMode: false,
+    phoneNumber: "+12345678901",
+    body: "Hello, I need help with my order",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.RcsLinkRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**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>
@@ -1351,7 +1580,7 @@ await client.campaigns.dlc.autofill({
 <dl>
 <dd>
 
-Retrieve DLC campaign.
+Retrieve 10DLC campaign.
 
 </dd>
 </dl>
@@ -1383,7 +1612,7 @@ await client.campaigns.dlc.get(28);
 <dl>
 <dd>
 
-**campaignId:** `number` — Unique identifier of the DLC campaign.
+**campaignId:** `number` — Unique identifier of the 10DLC campaign.
 
 </dd>
 </dl>
@@ -1414,7 +1643,7 @@ await client.campaigns.dlc.get(28);
 <dl>
 <dd>
 
-Submit your DLC campaign for approval and activation with carriers.
+Submit your 10DLC campaign for approval and activation with carriers.
 
 </dd>
 </dl>
@@ -1446,7 +1675,7 @@ await client.campaigns.dlc.submit(161);
 <dl>
 <dd>
 
-**campaignId:** `number` — Unique identifier of the DLC campaign to submit.
+**campaignId:** `number` — Unique identifier of the 10DLC campaign to submit.
 
 </dd>
 </dl>
@@ -1477,7 +1706,7 @@ await client.campaigns.dlc.submit(161);
 <dl>
 <dd>
 
-Create a new DLC campaign or updates an existing one. <br>
+Create a new 10DLC campaign or updates an existing one. <br>
 
 Omit campaignId to create a campaign.
 
@@ -1579,7 +1808,7 @@ await client.campaigns.dlc.upsert({
 <dl>
 <dd>
 
-Validate your DLC campaign configuration against carrier requirements and compliance rules.
+Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
 
 </dd>
 </dl>
@@ -2686,7 +2915,7 @@ await client.messages.rcs.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.Rcs`
+**request:** `Pinnacle.RichMessage`
 
 </dd>
 </dl>
@@ -3211,7 +3440,7 @@ await client.status.get.tollFree(28);
 <dl>
 <dd>
 
-Retrieve a DLC campaign's status.
+Retrieve a 10DLC campaign's status.
 
 </dd>
 </dl>
@@ -3243,7 +3472,7 @@ await client.status.get.dlc(28);
 <dl>
 <dd>
 
-**campaignId:** `number` — ID of the DLC campaign.
+**campaignId:** `number` — ID of the 10DLC campaign.
 
 </dd>
 </dl>
@@ -3539,7 +3768,7 @@ See the response of [Create Shortened URL](./create-url) for more information.
 <dl>
 <dd>
 
-Update the destination or configuration of an existing shortened URL.
+Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
 
 </dd>
 </dl>
@@ -3678,6 +3907,80 @@ await client.tools.file.upload({
 </dl>
 </details>
 
+<details><summary><code>client.tools.file.<a href="/src/api/resources/tools/resources/file/client/Client.ts">refresh</a>({ ...params }) -> Pinnacle.RefreshedFile[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
+
+<Callout type="info">
+  This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
+</Callout>  
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tools.file.refresh({
+    uris: [
+        "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",
+        "icons/3/test.jpg",
+        "invalid/url",
+        "https://google.com",
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.tools.RefreshFileParams`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**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>

package/dist/cjs/api/types/ClickAction.d.ts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ClickAction {
-    /** Title of the button or quick reply that was clicked on. */
-    button: string;
-    /** Payload received from the button interaction. */
-    data: ClickAction.Data;
-}
-export declare namespace ClickAction {
-    /**
-     * Payload received from the button interaction.
-     */
-    type Data = 
-    /**
-     * Data that is attached to the button. <br>
-     *
-     * This is only returned when `trigger` buttons are pressed. */
-    {
-        metadata: string;
-        payload: string;
-    }
-    /**
-     * Indicates that the button was clicked. <br>
-     *
-     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
-     | "clicked";
-}

package/dist/cjs/api/types/InboundButton.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
-export type InboundButton = 
-/**
- * Data associated with a button that is pressed. Excludes `requestUserLocation` and `sendLocation`. */
-Pinnacle.ClickAction
-/**
- * User provided location. Occurs when recipient responds to a `requestUserLocation` or `sendLocation` button. */
- | Pinnacle.LocationShareAction;

package/dist/esm/api/types/ClickAction.d.mts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ClickAction {
-    /** Title of the button or quick reply that was clicked on. */
-    button: string;
-    /** Payload received from the button interaction. */
-    data: ClickAction.Data;
-}
-export declare namespace ClickAction {
-    /**
-     * Payload received from the button interaction.
-     */
-    type Data = 
-    /**
-     * Data that is attached to the button. <br>
-     *
-     * This is only returned when `trigger` buttons are pressed. */
-    {
-        metadata: string;
-        payload: string;
-    }
-    /**
-     * Indicates that the button was clicked. <br>
-     *
-     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
-     | "clicked";
-}

package/dist/esm/api/types/InboundButton.d.mts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
-export type InboundButton = 
-/**
- * Data associated with a button that is pressed. Excludes `requestUserLocation` and `sendLocation`. */
-Pinnacle.ClickAction
-/**
- * User provided location. Occurs when recipient responds to a `requestUserLocation` or `sendLocation` button. */
- | Pinnacle.LocationShareAction;