rcs-js 2.0.0-rc.9 → 2.0.0

package/dist/esm/wrapper/messages/Client.mjs

@@ -0,0 +1,45 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Messages } from "../../api/resources/messages/client/Client.mjs";
+import { UnauthorizedError } from "../../api/errors/index.mjs";
+export class EnhancedMessages extends Messages {
+    process(req, secret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const signingSecret = secret || process.env.PINNACLE_SIGNING_SECRET;
+            let headerSecret;
+            let body;
+            if (req instanceof Request) {
+                headerSecret =
+                    ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.get("PINNACLE-SIGNING-SECRET")) || ((_b = req.headers) === null || _b === void 0 ? void 0 : _b.get("pinnacle-signing-secret")) || undefined;
+                body = yield req.json();
+            }
+            else {
+                const headers = req.headers;
+                headerSecret = headers["pinnacle-signing-secret"];
+                body = req.body;
+            }
+            if (!signingSecret) {
+                throw new UnauthorizedError({
+                    error: "Make sure to set the PINNACLE_SIGNING_SECRET environment variable or pass the secret as an argument to the process method",
+                });
+            }
+            if (!headerSecret) {
+                throw new UnauthorizedError({
+                    error: "Failed to get the PINNACLE-SIGNING-SECRET header from request",
+                });
+            }
+            if (headerSecret !== signingSecret) {
+                throw new UnauthorizedError({ error: "Invalid webhook signature" });
+            }
+            return body;
+        });
+    }
+}

package/dist/esm/wrapper/tools/Client.d.mts

@@ -0,0 +1,6 @@
+import { Tools } from '../../api/resources/tools/client/Client.mjs';
+import { FileUploader } from './FileUploader.mjs';
+export declare class EnhancedTools extends Tools {
+    protected _fileUploader: FileUploader | undefined;
+    get file(): FileUploader;
+}

package/dist/esm/wrapper/tools/Client.mjs

@@ -0,0 +1,8 @@
+import { Tools } from '../../api/resources/tools/client/Client.mjs';
+import { FileUploader } from './FileUploader.mjs';
+export class EnhancedTools extends Tools {
+    get file() {
+        var _a;
+        return ((_a = this._fileUploader) !== null && _a !== void 0 ? _a : (this._fileUploader = new FileUploader(this._options)));
+    }
+}

package/dist/esm/wrapper/tools/FileUploader.d.mts

@@ -0,0 +1,15 @@
+import { File_ } from "../../api/resources/tools/resources/file/client/Client.mjs";
+import { UploadFileParams } from "../../api/resources/tools/resources/file/client/requests/index.mjs";
+export declare class FileUploader extends File_ {
+    /**
+     * Upload a file from a file path (Node.js) or File object (browser)
+     * @param fileInput - File path string (Node.js) or File object (browser)
+     * @param options - Upload options
+     * @returns The download URL of the uploaded file
+     */
+    uploadFromPath(fileInput: string | File, options?: {
+        name?: string;
+        options?: UploadFileParams.Options;
+    }): Promise<string>;
+    private getMimeType;
+}

package/dist/esm/wrapper/tools/FileUploader.mjs

@@ -0,0 +1,125 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as mime from "mime-types";
+import { File_ } from "../../api/resources/tools/resources/file/client/Client.mjs";
+import { BadRequestError, NotFoundError, InternalServerError } from "../../api/errors/index.mjs";
+export class FileUploader extends File_ {
+    /**
+     * Upload a file from a file path (Node.js) or File object (browser)
+     * @param fileInput - File path string (Node.js) or File object (browser)
+     * @param options - Upload options
+     * @returns The download URL of the uploaded file
+     */
+    uploadFromPath(fileInput, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let size;
+            let fileName;
+            let contentType;
+            let blob;
+            if (typeof window === "undefined") {
+                if (typeof fileInput !== "string") {
+                    throw new BadRequestError({ message: "In Node.js, fileInput must be a file path string" });
+                }
+                const fs = yield import("fs");
+                const path = yield import("path");
+                const filePath = fileInput;
+                let stats;
+                try {
+                    stats = yield fs.promises.stat(filePath);
+                }
+                catch (error) {
+                    if (error.code === "ENOENT") {
+                        throw new NotFoundError({ error: `File not found: ${filePath}` });
+                    }
+                    throw new InternalServerError({ error: `Failed to access file: ${error.message}` });
+                }
+                if (stats.isDirectory()) {
+                    throw new BadRequestError({ message: `Path is a directory, not a file: ${filePath}` });
+                }
+                size = stats.size;
+                fileName = (options === null || options === void 0 ? void 0 : options.name) || path.default.basename(filePath);
+                contentType = this.getMimeType(filePath);
+                const fileBuffer = yield fs.promises.readFile(filePath);
+                const arrayBuffer = new Uint8Array(fileBuffer).buffer;
+                blob = new Blob([arrayBuffer], { type: contentType });
+            }
+            else {
+                if (!(fileInput instanceof File)) {
+                    throw new BadRequestError({ message: "In browser, fileInput must be a File object" });
+                }
+                const file = fileInput;
+                size = file.size;
+                fileName = (options === null || options === void 0 ? void 0 : options.name) || file.name;
+                contentType = file.type || this.getMimeType(file.name);
+                blob = file;
+            }
+            const uploadParams = {
+                contentType,
+                size,
+                name: fileName,
+                options: options === null || options === void 0 ? void 0 : options.options,
+            };
+            const uploadResult = yield this.upload(uploadParams);
+            if (uploadResult.uploadUrl) {
+                yield fetch(uploadResult.uploadUrl, {
+                    method: "PUT",
+                    body: blob,
+                    headers: {
+                        "Content-Type": contentType,
+                    },
+                });
+            }
+            return uploadResult.downloadUrl;
+        });
+    }
+    getMimeType(filePath) {
+        const mimeType = mime.lookup(filePath);
+        if (!mimeType) {
+            return "application/octet-stream";
+        }
+        const supportedTypes = new Set([
+            "audio/mpeg",
+            "audio/mp4",
+            "audio/ogg",
+            "audio/aac",
+            "audio/webm",
+            "audio/wav",
+            "audio/3gpp",
+            "audio/amr",
+            "video/mp4",
+            "video/mpeg",
+            "video/quicktime",
+            "video/webm",
+            "video/3gpp",
+            "video/H264",
+            "video/x-m4v",
+            "image/jpeg",
+            "image/png",
+            "image/gif",
+            "image/bmp",
+            "image/tiff",
+            "image/webp",
+            "application/pdf",
+            "text/csv",
+            "application/rtf",
+            "text/vcard",
+            "text/calendar",
+        ]);
+        if (supportedTypes.has(mimeType)) {
+            return mimeType;
+        }
+        const baseType = mimeType.split("/")[0];
+        if (["audio", "video", "image"].includes(baseType)) {
+            console.warn(`MIME type ${mimeType} may not be fully supported. Proceeding anyway.`);
+            return mimeType;
+        }
+        return "application/octet-stream";
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.0-rc.9",
+    "version": "2.0.0",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",
@@ -38,6 +38,9 @@
         "test:browser": "jest --selectProjects browser",
         "test:wire": "jest --selectProjects wire"
     },
+    "dependencies": {
+        "mime-types": "^3.0.1"
+    },
     "devDependencies": {
         "webpack": "^5.97.1",
         "ts-loader": "^9.5.1",
@@ -49,7 +52,8 @@
         "msw": "^2.8.4",
         "@types/node": "^18.19.70",
         "prettier": "^3.4.2",
-        "typescript": "~5.7.2"
+        "typescript": "~5.7.2",
+        "@types/mime-types": "^3.0.1"
     },
     "browser": {
         "fs": false,

package/reference.md

@@ -645,7 +645,7 @@ await client.contacts.update({
 
 ## Conversations
 
-<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> (Pinnacle.Conversation | null) | undefined</code></summary>
+<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Conversation | null</code></summary>
 <dl>
 <dd>
 
@@ -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.",
@@ -2685,7 +2915,7 @@ await client.messages.rcs.send({
 <dl>
 <dd>
 
-**request:** `Pinnacle.Rcs`
+**request:** `Pinnacle.RichMessage`
 
 </dd>
 </dl>
@@ -2807,7 +3037,8 @@ Connect a webhook to your phone number to receive real-time notifications for in
 
 ```typescript
 await client.phoneNumbers.webhook.attach("%2B14155551234", {
-    webhookId: 1,
+    webhookId: 123,
+    event: "MESSAGE.STATUS",
 });
 ```
 
@@ -2828,7 +3059,7 @@ await client.phoneNumbers.webhook.attach("%2B14155551234", {
 
 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.
+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>
@@ -2950,7 +3181,7 @@ This must be a valid webhook ID that is currently attached to the specified phon
 <dl>
 <dd>
 
-Link a phone number to a specific campaign.
+Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
 
 </dd>
 </dl>
@@ -3210,7 +3441,7 @@ await client.status.get.tollFree(28);
 <dl>
 <dd>
 
-Retrieve a DLC campaign's status.
+Retrieve a 10DLC campaign's status.
 
 </dd>
 </dl>
@@ -3242,7 +3473,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>
@@ -3538,7 +3769,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>
@@ -3677,6 +3908,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>
@@ -3691,7 +3996,7 @@ await client.tools.file.upload({
 <dl>
 <dd>
 
-Retrieve contact information as a vCard and get a presigned URL to download the file.
+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>
@@ -3756,7 +4061,7 @@ await client.tools.contactCard.get({
 <dl>
 <dd>
 
-Create a new contact card or updates an existing one with full vCard data.
+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>