rcs-js 2.0.1-rc.1 → 2.0.1

package/reference.md

@@ -112,7 +112,7 @@ await client.brands.upsert({
     description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
     ein: "88-1234567",
     email: "founders@trypinnacle.app",
-    id: "b_1234567890",
+    id: 1,
     name: "Pinnacle",
     sector: "TECHNOLOGY",
     type: "PRIVATE_PROFIT",
@@ -180,7 +180,7 @@ Retrieve detailed information for a specific brand in your account by ID.
 <dd>
 
 ```typescript
-await client.brands.get("b_1234567890");
+await client.brands.get(1);
 ```
 
 </dd>
@@ -196,10 +196,7 @@ await client.brands.get("b_1234567890");
 <dl>
 <dd>
 
-**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`.
+**id:** `number` — ID of an existing brand in your account that you want to retrieve.
 
 </dd>
 </dl>
@@ -254,7 +251,7 @@ Submit your brand for review and approval by the compliance team.
 <dd>
 
 ```typescript
-await client.brands.submit("b_1234567890");
+await client.brands.submit(1);
 ```
 
 </dd>
@@ -270,10 +267,11 @@ await client.brands.submit("b_1234567890");
 <dl>
 <dd>
 
-**brandId:** `string`
+**brandId:** `number`
+
+The unique identifier of the brand you want to submit for review. <br>
 
-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.
+Must correspond to an existing brand in your account that is ready for submission.
 
 </dd>
 </dl>
@@ -399,7 +397,7 @@ Submit a brand for external vetting verification to enhance your brand's trust s
 <dd>
 
 ```typescript
-await client.brands.vet("b_1234567890", {});
+await client.brands.vet(1, {});
 ```
 
 </dd>
@@ -415,11 +413,11 @@ await client.brands.vet("b_1234567890", {});
 <dl>
 <dd>
 
-**brandId:** `string`
+**brandId:** `number`
 
 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.
+The brand must be already registered before it can be vetted.
 
 </dd>
 </dl>
@@ -476,9 +474,7 @@ Retrieve contact information for a given number.
 <dd>
 
 ```typescript
-await client.contacts.get({
-    id: "co_1234567890",
-});
+await client.contacts.get();
 ```
 
 </dd>
@@ -611,7 +607,7 @@ await client.contacts.update({
     email: "alvaroopedtech@pinnacle.sh",
     name: "Retired Bestie",
     tags: ["friend"],
-    id: "co_1234567890",
+    id: 137,
 });
 ```
 
@@ -678,7 +674,7 @@ Fetch a specific conversation using either its unique identifier or by matching
 
 ```typescript
 await client.conversations.get({
-    id: "conv_1234567890",
+    id: 1,
 });
 ```
 
@@ -743,8 +739,8 @@ Retrieves conversations by page with optional filtering based off provided param
 
 ```typescript
 await client.conversations.list({
-    brandId: "b_1234567890",
-    campaignId: "tf_1234567890",
+    brandId: 101,
+    campaignId: 136,
     campaignType: "TOLL_FREE",
     pageIndex: 0,
     pageSize: 20,
@@ -814,7 +810,7 @@ Update the notes associated with a specific conversation.
 
 ```typescript
 await client.conversations.update({
-    id: "conv_1234567890",
+    id: 123,
     notes: "Follow-up completed. Customer satisfied with resolution.",
 });
 ```
@@ -851,77 +847,6 @@ await client.conversations.update({
 </dl>
 </details>
 
-<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">listMessages</a>(id, { ...params }) -> Pinnacle.MessageList</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieve a paginated and filtered list of messages for a specific conversation.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.conversations.listMessages("id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<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`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**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>
@@ -952,7 +877,7 @@ Retrieve a previously sent message.
 <dd>
 
 ```typescript
-await client.messages.get("msg_1234567890");
+await client.messages.get(1240);
 ```
 
 </dd>
@@ -968,7 +893,7 @@ await client.messages.get("msg_1234567890");
 <dl>
 <dd>
 
-**id:** `string` — Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
+**id:** `number` — Unique identifier of the message.
 
 </dd>
 </dl>
@@ -1016,7 +941,7 @@ Add or remove an emoji reaction to a previously sent message.
 
 ```typescript
 await client.messages.react({
-    messageId: "msg_1234567890",
+    messageId: 1410,
     options: {
         force: true,
     },
@@ -1606,8 +1531,8 @@ 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",
+    additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
+    campaignId: 161,
 });
 ```
 
@@ -1671,7 +1596,7 @@ Retrieve 10DLC campaign.
 <dd>
 
 ```typescript
-await client.campaigns.dlc.get("dlc_1234567890");
+await client.campaigns.dlc.get(28);
 ```
 
 </dd>
@@ -1687,7 +1612,7 @@ await client.campaigns.dlc.get("dlc_1234567890");
 <dl>
 <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`.
+**campaignId:** `number` — Unique identifier of the 10DLC campaign.
 
 </dd>
 </dl>
@@ -1734,7 +1659,7 @@ Submit your 10DLC campaign for approval and activation with carriers.
 <dd>
 
 ```typescript
-await client.campaigns.dlc.submit("dlc_1234567890");
+await client.campaigns.dlc.submit(161);
 ```
 
 </dd>
@@ -1750,10 +1675,7 @@ await client.campaigns.dlc.submit("dlc_1234567890");
 <dl>
 <dd>
 
-**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`.
+**campaignId:** `number` — Unique identifier of the 10DLC campaign to submit.
 
 </dd>
 </dl>
@@ -1804,19 +1726,19 @@ Omit campaignId to create a campaign.
 ```typescript
 await client.campaigns.dlc.upsert({
     autoRenew: true,
-    brand: "b_1234567890",
-    campaignId: "dlc_1234567890",
+    brand: 1,
+    campaignId: 161,
     keywords: {
         HELP: {
             message: "Reply HELP for assistance, STOP to opt-out",
             values: ["HELP", "INFO", "SUPPORT"],
         },
         OPT_IN: {
-            message: "Welcome. You are now subscribed to Pinnacle.",
+            message: "Welcome! You're now subscribed to Pinnacle.",
             values: ["JOIN", "START", "SUBSCRIBE"],
         },
         OPT_OUT: {
-            message: "You have been unsubscribed. Reply START to rejoin.",
+            message: "You've been unsubscribed. Reply START to rejoin.",
             values: ["STOP", "QUIT", "UNSUBSCRIBE"],
         },
     },
@@ -1904,7 +1826,7 @@ 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: 161,
 });
 ```
 
@@ -1971,8 +1893,8 @@ 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",
+    additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
+    campaignId: 161,
 });
 ```
 
@@ -2036,7 +1958,7 @@ Retrieve Toll-Free campaign.
 <dd>
 
 ```typescript
-await client.campaigns.tollFree.get("tf_1234567890");
+await client.campaigns.tollFree.get(161);
 ```
 
 </dd>
@@ -2052,7 +1974,7 @@ await client.campaigns.tollFree.get("tf_1234567890");
 <dl>
 <dd>
 
-**campaignId:** `string` — Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
+**campaignId:** `number` — Unique identifier of toll-free campaign.
 
 </dd>
 </dl>
@@ -2099,7 +2021,7 @@ Submit your toll-free campaign for approval and activation with carriers.
 <dd>
 
 ```typescript
-await client.campaigns.tollFree.submit("tf_1234567890");
+await client.campaigns.tollFree.submit(161);
 ```
 
 </dd>
@@ -2115,7 +2037,7 @@ await client.campaigns.tollFree.submit("tf_1234567890");
 <dl>
 <dd>
 
-**campaignId:** `string` — Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
+**campaignId:** `number` — Unique identifier of the toll-free campaign to submit.
 
 </dd>
 </dl>
@@ -2165,8 +2087,8 @@ Omit campaignId to create a campaign.
 
 ```typescript
 await client.campaigns.tollFree.upsert({
-    brand: "b_1234567890",
-    campaignId: "tf_1234567890",
+    brand: 2,
+    campaignId: 161,
     monthlyVolume: "1,000",
     name: "Pinnacle",
     optIn: {
@@ -2174,7 +2096,7 @@ await client.campaigns.tollFree.upsert({
         url: "https://www.pinnacle.sh/",
         workflowDescription: "Visit https://www.pinnacle.sh/",
     },
-    productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
+    productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
     useCase: {
         summary: "Alerts clients about any Pinnacle hosted workshops.",
         value: "WORKSHOP_ALERTS",
@@ -2244,7 +2166,7 @@ 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: 161,
 });
 ```
 
@@ -2311,8 +2233,8 @@ 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",
+    additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
+    campaignId: 161,
 });
 ```
 
@@ -2376,7 +2298,7 @@ Retrieve RCS campaign.
 <dd>
 
 ```typescript
-await client.campaigns.rcs.get("rcs_1234567890");
+await client.campaigns.rcs.get(161);
 ```
 
 </dd>
@@ -2392,7 +2314,7 @@ await client.campaigns.rcs.get("rcs_1234567890");
 <dl>
 <dd>
 
-**campaignId:** `string` — Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
+**campaignId:** `number` — Unique identifier of the RCS campaign.
 
 </dd>
 </dl>
@@ -2439,7 +2361,7 @@ Submit your RCS campaign for approval and activation with carriers.
 <dd>
 
 ```typescript
-await client.campaigns.rcs.submit("rcs_1234567890");
+await client.campaigns.rcs.submit(161);
 ```
 
 </dd>
@@ -2455,7 +2377,7 @@ await client.campaigns.rcs.submit("rcs_1234567890");
 <dl>
 <dd>
 
-**campaignId:** `string` — Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
+**campaignId:** `number` — Unique identifier of the RCS campaign to retrieve.
 
 </dd>
 </dl>
@@ -2532,8 +2454,7 @@ await client.campaigns.rcs.upsert({
         ],
     },
     brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
-    brand: "b_1234567890",
-    campaignId: "rcs_1234567890",
+    brand: 2,
     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.",
@@ -2621,7 +2542,7 @@ 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: 161,
 });
 ```
 
@@ -3116,7 +3037,7 @@ Connect a webhook to your phone number to receive real-time notifications for in
 
 ```typescript
 await client.phoneNumbers.webhook.attach("%2B14155551234", {
-    webhookId: "wh_1234567890",
+    webhookId: 123,
     event: "MESSAGE.STATUS",
 });
 ```
@@ -3195,7 +3116,7 @@ The webhook configuration itself remains intact and available for use with other
 <dd>
 
 ```typescript
-await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
+await client.phoneNumbers.webhook.detach("+14155551234", 123);
 ```
 
 </dd>
@@ -3223,11 +3144,11 @@ Must be a phone number that you own and currently has the specified webhook atta
 <dl>
 <dd>
 
-**webhookId:** `string`
+**webhookId:** `number`
 
 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`.
+This must be a valid webhook ID that is currently attached to the specified phone number.
 
 </dd>
 </dl>
@@ -3279,7 +3200,7 @@ 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: 101,
 });
 ```
 
@@ -3410,7 +3331,7 @@ Retrieve a brand's status.
 <dd>
 
 ```typescript
-await client.status.get.brand("b_1234567890");
+await client.status.get.brand(28);
 ```
 
 </dd>
@@ -3426,7 +3347,7 @@ await client.status.get.brand("b_1234567890");
 <dl>
 <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`.
+**brandId:** `number` — ID of the brand.
 
 </dd>
 </dl>
@@ -3473,7 +3394,7 @@ Retrieve a toll-free campaign's status.
 <dd>
 
 ```typescript
-await client.status.get.tollFree("tf_1234567890");
+await client.status.get.tollFree(28);
 ```
 
 </dd>
@@ -3489,7 +3410,7 @@ await client.status.get.tollFree("tf_1234567890");
 <dl>
 <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`.
+**campaignId:** `number` — ID of the toll-free campaign.
 
 </dd>
 </dl>
@@ -3536,7 +3457,7 @@ Retrieve a 10DLC campaign's status.
 <dd>
 
 ```typescript
-await client.status.get.dlc("dlc_1234567890");
+await client.status.get.dlc(28);
 ```
 
 </dd>
@@ -3552,7 +3473,7 @@ await client.status.get.dlc("dlc_1234567890");
 <dl>
 <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`.
+**campaignId:** `number` — ID of the 10DLC campaign.
 
 </dd>
 </dl>
@@ -3599,7 +3520,7 @@ Retrieve a RCS campaign's status.
 <dd>
 
 ```typescript
-await client.status.get.rcs("rcs_1234567890");
+await client.status.get.rcs(28);
 ```
 
 </dd>
@@ -3615,7 +3536,7 @@ await client.status.get.rcs("rcs_1234567890");
 <dl>
 <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`.
+**campaignId:** `number` — ID of the campaign.
 
 </dd>
 </dl>
@@ -4019,9 +3940,10 @@ Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
 
 ```typescript
 await client.tools.file.refresh({
-    urls: [
+    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",
     ],
@@ -4091,7 +4013,7 @@ Retrieve contact information as a vCard and get a presigned URL to download the
 
 ```typescript
 await client.tools.contactCard.get({
-    id: "cc_1234567890",
+    id: 33,
 });
 ```
 
@@ -4156,7 +4078,7 @@ Create a new contact card or updates an existing one with full vCard data. Conta
 
 ```typescript
 await client.tools.contactCard.upsert({
-    id: "cc_1234567890",
+    id: 34,
     formattedName: "Jane Smith",
     name: {
         familyName: "Smith",

package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts

@@ -1,36 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../../../../index.js";
-/**
- * @example
- *     {}
- */
-export interface ConversationsListMessagesRequest {
-    /** Zero-based index for pagination. */
-    pageIndex?: number;
-    /** Number of messages to return per page. */
-    pageSize?: number;
-    /**
-     * Sort order for messages. <br>
-     *
-     * - `asc`: Oldest messages first
-     * - `desc`: Newest messages first (default)
-     */
-    sortOrder?: Pinnacle.ConversationsListMessagesRequestSortOrder;
-    /**
-     * Filter messages by direction. <br>
-     *
-     * - `INBOUND`: Messages received from contacts
-     * - `OUTBOUND`: Messages sent to contacts
-     */
-    direction?: Pinnacle.ConversationsListMessagesRequestDirection;
-    /** Filter messages by delivery status. */
-    status?: Pinnacle.ConversationsListMessagesRequestStatus;
-    /** Filter messages by protocol type. */
-    type?: Pinnacle.ConversationsListMessagesRequestType;
-    /** Filter messages sent on or after this date (ISO 8601 format). */
-    dateFrom?: string;
-    /** Filter messages sent on or before this date (ISO 8601 format). */
-    dateTo?: string;
-}

package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ConversationsListMessagesRequestDirection = "INBOUND" | "OUTBOUND";
-export declare const ConversationsListMessagesRequestDirection: {
-    readonly Inbound: "INBOUND";
-    readonly Outbound: "OUTBOUND";
-};

package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationsListMessagesRequestDirection = void 0;
-exports.ConversationsListMessagesRequestDirection = {
-    Inbound: "INBOUND",
-    Outbound: "OUTBOUND",
-};

package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ConversationsListMessagesRequestSortOrder = "asc" | "desc";
-export declare const ConversationsListMessagesRequestSortOrder: {
-    readonly Asc: "asc";
-    readonly Desc: "desc";
-};

package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationsListMessagesRequestSortOrder = void 0;
-exports.ConversationsListMessagesRequestSortOrder = {
-    Asc: "asc",
-    Desc: "desc",
-};

package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ConversationsListMessagesRequestStatus = "PENDING" | "SENT" | "SEND_FAILED" | "DELIVERED" | "DELIVERY_FAILED" | "RECEIVED" | "READ";
-export declare const ConversationsListMessagesRequestStatus: {
-    readonly Pending: "PENDING";
-    readonly Sent: "SENT";
-    readonly SendFailed: "SEND_FAILED";
-    readonly Delivered: "DELIVERED";
-    readonly DeliveryFailed: "DELIVERY_FAILED";
-    readonly Received: "RECEIVED";
-    readonly Read: "READ";
-};