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

package/dist/cjs/Client.js

@@ -54,8 +54,8 @@ class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.0-rc.11",
-                "User-Agent": "rcs-js/2.0.0-rc.11",
+                "X-Fern-SDK-Version": "2.0.0-rc.13",
+                "User-Agent": "rcs-js/2.0.0-rc.13",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts

@@ -71,6 +71,7 @@ export declare class Rcs {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *

package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js

@@ -205,6 +205,7 @@ class Rcs {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -236,6 +237,8 @@ class Rcs {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts

@@ -34,7 +34,7 @@ export declare class Rcs {
      *
      * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
      *
-     * @param {Pinnacle.Rcs} request
+     * @param {Pinnacle.RichMessage} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -56,7 +56,7 @@ export declare class Rcs {
      *         to: "to"
      *     })
      */
-    send(request: Pinnacle.Rcs, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
+    send(request: Pinnacle.RichMessage, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
     private __send;
     /**
      * Validate RCS message content without sending it.

package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js

@@ -60,7 +60,7 @@ class Rcs {
      *
      * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
      *
-     * @param {Pinnacle.Rcs} request
+     * @param {Pinnacle.RichMessage} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}

package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts

@@ -53,6 +53,27 @@ export declare class File_ {
      */
     upload(request: Pinnacle.tools.UploadFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.UploadResults>;
     private __upload;
+    /**
+     * 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>
+     *
+     * @param {Pinnacle.tools.RefreshFileParams} request
+     * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     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"]
+     *     })
+     */
+    refresh(request: Pinnacle.tools.RefreshFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.RefreshedFile[]>;
+    private __refresh;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "PINNACLE-API-KEY": string;
     }>;

package/dist/cjs/api/resources/tools/resources/file/client/Client.js

@@ -132,6 +132,80 @@ class File_ {
             }
         });
     }
+    /**
+     * 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>
+     *
+     * @param {Pinnacle.tools.RefreshFileParams} request
+     * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     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"]
+     *     })
+     */
+    refresh(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__refresh(request, requestOptions));
+    }
+    __refresh(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "tools/files/refresh"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /tools/files/refresh.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         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"]
+ *     }
+ */
+export interface RefreshFileParams {
+    /**
+     * Array of file URIs to refresh for extended access. <br>
+     *
+     * Accepted formats:
+     * - **Full presigned URLs**: `https://server.trypinnacle.app/storage/v1/object/sign/...`
+     * - **Short URIs**: `{BUCKET}/${TEAM_ID}/...` (e.g., `vault/3/document.pdf`)
+     *
+     * Invalid or external URLs will be returned unchanged in the response.
+     */
+    uris: string[];
+}

package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts

@@ -1 +1,2 @@
 export { type UploadFileParams } from "./UploadFileParams.js";
+export { type RefreshFileParams } from "./RefreshFileParams.js";

package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts

@@ -67,7 +67,7 @@ export declare class Url {
     get(linkId: string, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrlWithClickData>;
     private __get;
     /**
-     * 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.
      *
      * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
      *

package/dist/cjs/api/resources/tools/resources/url/client/Client.js

@@ -196,7 +196,7 @@ class Url {
         });
     }
     /**
-     * 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.
      *
      * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
      *

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

@@ -32,11 +32,11 @@ export declare namespace AutofillDlcCampaignResponse {
      */
     interface Keywords {
         /** Help keyword settings. */
-        HELP?: Keywords.Help;
+        HELP: Keywords.Help;
         /** Opt-in keyword settings. */
-        OPT_IN?: Keywords.OptIn;
+        OPT_IN: Keywords.OptIn;
         /** Opt-out keyword settings. */
-        OPT_OUT?: Keywords.OptOut;
+        OPT_OUT: Keywords.OptOut;
     }
     namespace Keywords {
         /**
@@ -46,14 +46,14 @@ export declare namespace AutofillDlcCampaignResponse {
             /** Response message for help keywords. */
             message?: string;
             /** Keywords that trigger help response. */
-            values?: string[];
+            values: string[];
         }
         /**
          * Opt-in keyword settings.
          */
         interface OptIn {
             /** Response message for opt-in keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-in. */
             values: string[];
         }
@@ -64,7 +64,7 @@ export declare namespace AutofillDlcCampaignResponse {
             /** Response message for opt-out keywords. */
             message?: string;
             /** Keywords that trigger opt-out. */
-            values?: string[];
+            values: string[];
         }
     }
     /**
@@ -81,17 +81,17 @@ export declare namespace AutofillDlcCampaignResponse {
      */
     interface Options {
         /** Whether the campaign uses affiliate marketing. */
-        affiliateMarketing?: boolean;
+        affiliateMarketing: boolean;
         /** Whether the campaign is age-gated. */
-        ageGated?: boolean;
+        ageGated: boolean;
         /** Whether the campaign involves direct lending. */
-        directLending?: boolean;
+        directLending: boolean;
         /** Link embedded in campaign message. */
         embeddedLink?: string;
         /** Whether messages include phone numbers. */
-        embeddedPhone?: boolean;
+        embeddedPhone: boolean;
         /** Whether the campaign uses number pooling. */
-        numberPooling?: boolean;
+        numberPooling: boolean;
     }
     /**
      * Use case for the campaign.

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export type ButtonClicked = 
+/**
+ * Data about a button that was clicked. */
+Pinnacle.ButtonClickedData
+/**
+ * User provided location. Occurs when recipient responds to `requestUserLocation` button and shares a location. */
+ | Pinnacle.LocationShareAction;

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

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Unified data structure for button click events.
+ */
+export interface ButtonClickedData {
+    /** Information about the button that was clicked. */
+    button: ButtonClickedData.Button;
+    /** ID of the message this button was attached to, or null if not available. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
+    messageId?: number | null;
+}
+export declare namespace ButtonClickedData {
+    /**
+     * Information about the button that was clicked.
+     */
+    interface Button {
+        /**
+         * Type of button clicked.
+         * - `CARD` for card buttons,
+         * - `QUICK_REPLY` for quick replies.
+         * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
+         */
+        type?: Button.Type | null;
+        /** Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title. */
+        raw: Button.Raw;
+        /** Extracted payload from the button's `payload` field, if provided. Provides quick access to any payload that was attached to the button. */
+        payload?: string | null;
+        /** Additional metadata attached to the button's `metadata` field, if provided. */
+        metadata?: string | null;
+    }
+    namespace Button {
+        /**
+         * Type of button clicked.
+         * - `CARD` for card buttons,
+         * - `QUICK_REPLY` for quick replies.
+         * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
+         */
+        type Type = "CARD" | "QUICK_REPLY";
+        const Type: {
+            readonly Card: "CARD";
+            readonly QuickReply: "QUICK_REPLY";
+        };
+        /**
+         * Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title.
+         */
+        type Raw = 
+        /**
+         * Full button object if we can determine the exact button. */
+        Pinnacle.RichButton
+        /**
+         * Button title if we cannot determine the exact button. This is a rare edge case and is mainly here for backward compatibility. */
+         | string;
+    }
+}

package/dist/cjs/api/types/ButtonClickedData.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtonClickedData = void 0;
+var ButtonClickedData;
+(function (ButtonClickedData) {
+    let Button;
+    (function (Button) {
+        Button.Type = {
+            Card: "CARD",
+            QuickReply: "QUICK_REPLY",
+        };
+    })(Button = ButtonClickedData.Button || (ButtonClickedData.Button = {}));
+})(ButtonClickedData || (exports.ButtonClickedData = ButtonClickedData = {}));

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

@@ -5,7 +5,7 @@ export interface CreateUrlOptions {
     /**
      * Expiration date in ISO 8601 format for the shortened URL. <br>
      *
-     * If omitted, then a permalink is generated instead.
+     * If omitted, then a permalink is generated instead. Short permalinks contain a 30-digit link id. Short links with an expiration date contain a 8-digit link id.
      */
     expiresAt?: string | null;
 }

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

@@ -15,7 +15,7 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     /** Description of the campaign. */
     description?: string;
     /** Keyword response configuration. */
-    keywords?: DlcCampaignWithExtendedBrandAndStatus.Keywords;
+    keywords: DlcCampaignWithExtendedBrandAndStatus.Keywords;
     /** Legal documentation links. */
     links?: DlcCampaignWithExtendedBrandAndStatus.Links;
     /** Describe the flow of how users will opt in to this campaign. */
@@ -23,16 +23,19 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     /** Display name of the campaign. */
     name?: string;
     /** Campaign configuration options. */
-    options?: DlcCampaignWithExtendedBrandAndStatus.Options;
+    options: DlcCampaignWithExtendedBrandAndStatus.Options;
     /** Example messages for the campaign. */
     sampleMessages?: string[];
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the campaign. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
-     * `FAILED`: Issues and errors related to the campaign's details.<br>
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
+     *
+     * `FAILED`: Issues and errors related to the campaign's details.
      */
     status: Pinnacle.ProfileStatusEnum;
     /** Use case for the campaign. */
@@ -58,14 +61,14 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
             /** Response message for help keywords. */
             message?: string;
             /** Keywords that trigger help response. */
-            values?: string[];
+            values: string[];
         }
         /**
          * Opt-in keyword settings.
          */
         interface OptIn {
             /** Response message for opt-in keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-in. */
             values: string[];
         }
@@ -74,7 +77,7 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
          */
         interface OptOut {
             /** Response message for opt-out keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-out. */
             values: string[];
         }

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

@@ -10,11 +10,14 @@ export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
     /** Indicates if this brand is archived. */
     isArchived: boolean;
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the campaign. <br>
+     *
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
      * `FAILED`: Issues and errors related to the campaign's details.
      */
     status: Pinnacle.BrandStatusEnum;

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

@@ -14,17 +14,18 @@ export interface ExtendedRcsCampaign {
     /** Indicates whether the brand has provided an attestation. */
     brandAttestation: boolean;
     /** Unique identifier for the campaign. */
-    campaignId: number;
+    campaignId?: number;
     /** List of what the agent might say to users. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
-    links: ExtendedRcsCampaign.Links;
+    links?: ExtendedRcsCampaign.Links;
+    status: Pinnacle.ProfileStatusEnum;
     /** Opt-in configuration. */
-    optIn: ExtendedRcsCampaign.OptIn;
+    optIn?: ExtendedRcsCampaign.OptIn;
     /** Opt-out configuration. */
-    optOut: ExtendedRcsCampaign.OptOut;
+    optOut?: ExtendedRcsCampaign.OptOut;
     /** Use case classification for the campaign. */
-    useCase: ExtendedRcsCampaign.UseCase;
+    useCase?: ExtendedRcsCampaign.UseCase;
 }
 export declare namespace ExtendedRcsCampaign {
     /**
@@ -36,7 +37,7 @@ export declare namespace ExtendedRcsCampaign {
         /** Description of the agent. */
         description?: string;
         /** List of emails. */
-        emails?: Agent.Emails.Item[];
+        emails: Agent.Emails.Item[];
         /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
         /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
@@ -44,9 +45,9 @@ export declare namespace ExtendedRcsCampaign {
         /** Name of the agent. */
         name?: string;
         /** List of phone numbers. */
-        phones?: Agent.Phones.Item[];
+        phones: Agent.Phones.Item[];
         /** List of urls. */
-        websites?: Agent.Websites.Item[];
+        websites: Agent.Websites.Item[];
     }
     namespace Agent {
         type Emails = Emails.Item[];

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

@@ -18,5 +18,5 @@ Pinnacle.SmsContent
  * Message that contains richer content (longer text, higher quality media, cards, buttons, and quick replies) from an RCS agent. */
  | Pinnacle.RcsContent
 /**
- * Message that represents when a user clicks on a RCS button or quick reply that was previously sent. */
- | Pinnacle.InboundButton;
+ * Message that represents when a user clicks on a RCS button or quick reply. */
+ | Pinnacle.ButtonClicked;

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

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Represents an incoming message or message status update received via webhook.
+ */
+export interface MessageEvent {
+    /** Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages. */
+    type: Pinnacle.WebhookEventEnum;
+    /** Conversation metadata containing the conversation ID, sender, and recipient information. */
+    conversation: MessageEvent.Conversation;
+    status: Pinnacle.MessageStatusEnum;
+    /** Direction of the message flow. */
+    direction: MessageEvent.Direction;
+    /** Number of segments for this message. */
+    segments: number;
+    /** Timestamp when the message was sent in ISO 8601 format. */
+    sentAt: string;
+    /**
+     * Timestamp when the message was delivered in ISO 8601 format.
+     * Null if not yet delivered or for inbound messages.
+     */
+    deliveredAt?: string | null;
+    /** Message details including ID and content. */
+    message: MessageEvent.Message;
+}
+export declare namespace MessageEvent {
+    /**
+     * Conversation metadata containing the conversation ID, sender, and recipient information.
+     */
+    interface Conversation {
+        /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
+        id: number;
+        /** Sender's phone number or agent ID. */
+        from: string;
+        /** Recipient's phone number. */
+        to: string;
+    }
+    /**
+     * Direction of the message flow.
+     */
+    type Direction = "INBOUND" | "OUTBOUND";
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+    /**
+     * Message details including ID and content.
+     */
+    interface Message {
+        /** Unique identifier of the message. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
+        id: number;
+        content: Pinnacle.MessageContent;
+    }
+}

package/dist/cjs/api/types/MessageEvent.js

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

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

@@ -2,11 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Current review status of the campaign.
+ * Current review status of the campaign. <br>
+ *
+ * `INCOMPLETE`: Not submitted. <br>
+ *
+ * `IN REVIEW`: Being reviewed by carriers. <br>
+ *
+ * `VERIFIED`: Approved and ready to send messages.<br>
  *
- * `INCOMPLETE`: Not submitted.
- * `IN REVIEW`: Being reviewed by carriers.
- * `VERIFIED`: Approved and ready to send messages.
  * `FAILED`: Issues and errors related to the campaign's details.
  */
 export type ProfileStatusEnum = "INCOMPLETE" | "IN REVIEW" | "VERIFIED" | "FAILED";

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

@@ -19,6 +19,8 @@ export declare namespace RcsBase {
         /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
         test_mode?: boolean;
         tracking?: Pinnacle.Tracking;
+        /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
+        transcode?: boolean;
         /**
          * Validate your message for any unsupported files. <br>
          *

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

@@ -5,6 +5,8 @@
  * Button that initiates a phone call when tapped by the recipient.
  */
 export interface RcsButtonCall {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Phone number to call in E.164 format */
     payload: string;
     /** Display text for the button. */

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

@@ -5,6 +5,8 @@
  * Button that opens a URL when tapped by the recipient.
  */
 export interface RcsButtonOpenUrl {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
     payload: string;
     /** Display text for the button. */

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

@@ -5,6 +5,8 @@
  * Button that prompts the recipient to share their current location.
  */
 export interface RcsButtonRequestUserLocation {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }