rcs-js 2.0.0-rc.1 → 2.0.0-rc.11

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>
@@ -2224,6 +2453,7 @@ await client.campaigns.rcs.upsert({
             },
         ],
     },
+    brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
     brand: 2,
     expectedAgentResponses: [
         "Here are the things I can help you with.",
@@ -2348,9 +2578,9 @@ await client.campaigns.rcs.validate({
 </dl>
 </details>
 
-## Message Sms
+## Messages Sms
 
-<details><summary><code>client.message.sms.<a href="/src/api/resources/message/resources/sms/client/Client.ts">validate</a>({ ...params }) -> Pinnacle.SmsValidationResult</code></summary>
+<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>
 
@@ -2362,7 +2592,7 @@ await client.campaigns.rcs.validate({
 <dl>
 <dd>
 
-Validate SMS message content without sending it.
+Send a SMS message immediately or schedule it for future delivery.
 
 </dd>
 </dl>
@@ -2378,8 +2608,10 @@ Validate SMS message content without sending it.
 <dd>
 
 ```typescript
-await client.message.sms.validate({
-    text: "Hello from Pinnacle",
+await client.messages.sms.send({
+    from: "+14155164736",
+    text: "Hey!",
+    to: "+14154746461",
 });
 ```
 
@@ -2396,7 +2628,7 @@ await client.message.sms.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.SmsContent`
+**request:** `Pinnacle.messages.Sms`
 
 </dd>
 </dl>
@@ -2415,9 +2647,7 @@ await client.message.sms.validate({
 </dl>
 </details>
 
-## Messages Send
-
-<details><summary><code>client.messages.send.<a href="/src/api/resources/messages/resources/send/client/Client.ts">sms</a>({ ...params }) -> Pinnacle.SendSmsResponse</code></summary>
+<details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">validate</a>({ ...params }) -> Pinnacle.SmsValidationResult</code></summary>
 <dl>
 <dd>
 
@@ -2429,7 +2659,7 @@ await client.message.sms.validate({
 <dl>
 <dd>
 
-Send a SMS message immediately or schedule it for future delivery.
+Validate SMS message content without sending it.
 
 </dd>
 </dl>
@@ -2445,10 +2675,8 @@ Send a SMS message immediately or schedule it for future delivery.
 <dd>
 
 ```typescript
-await client.messages.send.sms({
-    from: "+14155164736",
-    text: "Hey! \uD83D\uDE02",
-    to: "+14154746461",
+await client.messages.sms.validate({
+    text: "Hello from Pinnacle",
 });
 ```
 
@@ -2465,7 +2693,7 @@ await client.messages.send.sms({
 <dl>
 <dd>
 
-**request:** `Pinnacle.messages.Sms`
+**request:** `Pinnacle.SmsContent`
 
 </dd>
 </dl>
@@ -2473,7 +2701,7 @@ await client.messages.send.sms({
 <dl>
 <dd>
 
-**requestOptions:** `Send.RequestOptions`
+**requestOptions:** `Sms.RequestOptions`
 
 </dd>
 </dl>
@@ -2484,7 +2712,9 @@ await client.messages.send.sms({
 </dl>
 </details>
 
-<details><summary><code>client.messages.send.<a href="/src/api/resources/messages/resources/send/client/Client.ts">mms</a>({ ...params }) -> Pinnacle.SendMmsResponse</code></summary>
+## 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>
 
@@ -2512,7 +2742,7 @@ Send a MMS immediately or schedule it for future delivery.
 <dd>
 
 ```typescript
-await client.messages.send.mms({
+await client.messages.mms.send({
     from: "+14155164736",
     mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
     options: {
@@ -2545,7 +2775,7 @@ await client.messages.send.mms({
 <dl>
 <dd>
 
-**requestOptions:** `Send.RequestOptions`
+**requestOptions:** `Mms.RequestOptions`
 
 </dd>
 </dl>
@@ -2556,7 +2786,7 @@ await client.messages.send.mms({
 </dl>
 </details>
 
-<details><summary><code>client.messages.send.<a href="/src/api/resources/messages/resources/send/client/Client.ts">rcs</a>({ ...params }) -> Pinnacle.SendRcsResponse</code></summary>
+<details><summary><code>client.messages.mms.<a href="/src/api/resources/messages/resources/mms/client/Client.ts">validate</a>({ ...params }) -> Pinnacle.MmsValidationResult</code></summary>
 <dl>
 <dd>
 
@@ -2568,9 +2798,7 @@ await client.messages.send.mms({
 <dl>
 <dd>
 
-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.
+Validate MMS message content without sending it.
 
 </dd>
 </dl>
@@ -2586,17 +2814,13 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
 <dd>
 
 ```typescript
-await client.messages.send.rcs({
-    quickReplies: [
-        {
-            type: "openUrl",
-            payload: "payload",
-            title: "title",
-        },
+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: "text",
-    from: "from",
-    to: "to",
+    text: "Check out these images!",
 });
 ```
 
@@ -2613,7 +2837,7 @@ await client.messages.send.rcs({
 <dl>
 <dd>
 
-**request:** `Pinnacle.Rcs`
+**request:** `Pinnacle.MmsContent`
 
 </dd>
 </dl>
@@ -2621,7 +2845,7 @@ await client.messages.send.rcs({
 <dl>
 <dd>
 
-**requestOptions:** `Send.RequestOptions`
+**requestOptions:** `Mms.RequestOptions`
 
 </dd>
 </dl>
@@ -2632,9 +2856,9 @@ await client.messages.send.rcs({
 </dl>
 </details>
 
-## Messages Mms
+## Messages Rcs
 
-<details><summary><code>client.messages.mms.<a href="/src/api/resources/messages/resources/mms/client/Client.ts">validate</a>({ ...params }) -> Pinnacle.MmsValidationResult</code></summary>
+<details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.RcsSendResponse</code></summary>
 <dl>
 <dd>
 
@@ -2646,7 +2870,9 @@ await client.messages.send.rcs({
 <dl>
 <dd>
 
-Validate MMS message content without sending it.
+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>
@@ -2662,13 +2888,17 @@ Validate MMS message content without sending it.
 <dd>
 
 ```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",
+await client.messages.rcs.send({
+    quickReplies: [
+        {
+            type: "openUrl",
+            payload: "payload",
+            title: "title",
+        },
     ],
-    text: "Check out these images!",
+    text: "text",
+    from: "from",
+    to: "to",
 });
 ```
 
@@ -2685,7 +2915,7 @@ await client.messages.mms.validate({
 <dl>
 <dd>
 
-**request:** `Pinnacle.MmsContent`
+**request:** `Pinnacle.Rcs`
 
 </dd>
 </dl>
@@ -2693,7 +2923,7 @@ await client.messages.mms.validate({
 <dl>
 <dd>
 
-**requestOptions:** `Mms.RequestOptions`
+**requestOptions:** `Rcs.RequestOptions`
 
 </dd>
 </dl>
@@ -2704,8 +2934,6 @@ await client.messages.mms.validate({
 </dl>
 </details>
 
-## Messages Rcs
-
 <details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">validate</a>({ ...params }) -> Pinnacle.RcsValidationResult</code></summary>
 <dl>
 <dd>
@@ -3212,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>
@@ -3244,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>

package/dist/cjs/api/resources/message/client/Client.d.ts

@@ -1,22 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments.js";
-import * as core from "../../../../core/index.js";
-import { Sms } from "../resources/sms/client/Client.js";
-export declare namespace Message {
-    interface Options {
-        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-    }
-}
-export declare class Message {
-    protected readonly _options: Message.Options;
-    protected _sms: Sms | undefined;
-    constructor(_options: Message.Options);
-    get sms(): Sms;
-}

package/dist/cjs/api/resources/message/client/Client.js

@@ -1,17 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Message = void 0;
-const Client_js_1 = require("../resources/sms/client/Client.js");
-class Message {
-    constructor(_options) {
-        this._options = _options;
-    }
-    get sms() {
-        var _a;
-        return ((_a = this._sms) !== null && _a !== void 0 ? _a : (this._sms = new Client_js_1.Sms(this._options)));
-    }
-}
-exports.Message = Message;

package/dist/cjs/api/resources/message/client/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/api/resources/message/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./client/index.js";
-export * from "./resources/index.js";

package/dist/cjs/api/resources/message/resources/index.d.ts

@@ -1 +0,0 @@
-export * as sms from "./sms/index.js";

package/dist/cjs/api/resources/message/resources/index.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sms = void 0;
-exports.sms = __importStar(require("./sms/index.js"));

package/dist/cjs/api/resources/message/resources/sms/client/index.d.ts

@@ -1 +0,0 @@
-export {};