rcs-js 2.0.0-rc.13 → 2.0.0-rc.15

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

@@ -5,4 +5,4 @@ import * as Pinnacle from "../index.mjs";
 /**
  * Response containing RCS capabilities for requested phone numbers
  */
-export type RcsCapabilitiesResult = Record<string, (Pinnacle.RcsCapability | null) | undefined>;
+export type RcsCapabilitiesResult = Record<string, Pinnacle.RcsCapability | null>;

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

@@ -11,6 +11,6 @@ export declare namespace ShortenedUrl {
         /** Destination URL that your shortened link redirects to. */
         to: string;
         /** Expiration date for your shortened link in ISO 8601 format, or null if it's permanent. */
-        expiresAt?: string | null;
+        expiresAt: string | null;
     }
 }

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

@@ -11,7 +11,6 @@ export interface TollFreeCampaignWithExtendedBrandAndStatus extends Pinnacle.Tol
      * `INCOMPLETE`: Has not been submitted.<br>
      * `PENDING`: Currently being reviewed.<br>
      * `VERIFIED`: Verified and good to go.<br>
-     * `UNVERIFIED`: No longer verified due to an update in the brand details.<br>
      * `VETTED`: Brand has been vetted by an external provider and has received vetting scores.
      */
     status: Pinnacle.ProfileStatusEnum;

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

@@ -19,6 +19,6 @@ export declare namespace UploadResults {
          *
          * Null indicates that `download.expiresAt` was not provided and the expiration time is defaulted to one hour after uploading.
          */
-        expiresAt?: string | null;
+        expiresAt: string | null;
     }
 }

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

@@ -26,7 +26,7 @@ export declare namespace VCardData {
              *
              * Null indicates that it is permanent.
              */
-            expiresAt?: string | null;
+            expiresAt: string | null;
         }
     }
 }

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

@@ -4,6 +4,7 @@
 /**
  * Types of events that can trigger webhook notifications for phone numbers.
  * Subscribe to specific events to receive real-time updates about your phone number activity.
+ * Use `null` to listen to all events.
  */
 export type WebhookEventEnum = "MESSAGE.STATUS" | "MESSAGE.RECEIVED";
 export declare const WebhookEventEnum: {

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.0-rc.13";
+export declare const SDK_VERSION = "2.0.0-rc.15";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.0-rc.13";
+export const SDK_VERSION = "2.0.0-rc.15";

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

@@ -28,7 +28,7 @@ export class EnhancedMessages extends Messages {
             }
             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",
+                    error: "Make sure to set the PINNACLE_SIGNING_SECRET environment variable or pass the secret as an argument to the process method",
                 });
             }
             if (!headerSecret) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.0-rc.13",
+    "version": "2.0.0-rc.15",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",
@@ -66,4 +66,4 @@
         "node": ">=18.0.0"
     },
     "sideEffects": 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>
 
@@ -3037,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",
 });
 ```
 
@@ -3058,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>
@@ -3180,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>
@@ -3923,7 +3924,7 @@ Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
 
 <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>  
+</Callout>
 </dd>
 </dl>
 </dd>
@@ -3995,7 +3996,7 @@ await client.tools.file.refresh({
 <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>
@@ -4060,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>