rcs-js 2.0.0-rc.9 → 2.0.1-rc.1

package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs

@@ -16,11 +16,11 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class ContactCard {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * 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.
      *
      * @param {Pinnacle.tools.GetVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,7 +31,7 @@ export class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request, requestOptions) {
@@ -90,7 +90,7 @@ export class ContactCard {
         });
     }
     /**
-     * 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.
      *
      * @param {Pinnacle.tools.UpsertVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -101,7 +101,7 @@ export class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",

package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts

@@ -4,12 +4,12 @@
 /**
  * @example
  *     {
- *         id: 33
+ *         id: "cc_1234567890"
  *     }
  */
 export interface GetVcardParams {
-    /** ID of your contact. */
-    id: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id: string;
     options?: GetVcardParams.Options;
 }
 export declare namespace GetVcardParams {

package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts

@@ -5,7 +5,7 @@ import * as Pinnacle from "../../../../../../index.mjs";
 /**
  * @example
  *     {
- *         id: 34,
+ *         id: "cc_1234567890",
  *         formattedName: "Jane Smith",
  *         name: {
  *             familyName: "Smith",

package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts

@@ -9,7 +9,7 @@ export declare namespace File_ {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace File_ {
 }
 export declare class File_ {
     protected readonly _options: File_.Options;
-    constructor(_options: File_.Options);
+    constructor(_options?: File_.Options);
     /**
      * Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
      *
@@ -53,7 +53,28 @@ 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({
+     *         urls: ["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", "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;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/esm/api/resources/tools/resources/file/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class File_ {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -96,6 +96,80 @@ export 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({
+     *         urls: ["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", "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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         urls: ["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", "invalid/url", "https://google.com"]
+ *     }
+ */
+export interface RefreshFileParams {
+    /** Array of file URLs to refresh for extended access. Provided URLs must be presigned URLs (i.e. `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or external URLs will be returned unchanged in the response. */
+    urls: string[];
+}

package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts

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

package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts

@@ -9,7 +9,7 @@ export declare namespace Url {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Url {
 }
 export declare class Url {
     protected readonly _options: Url.Options;
-    constructor(_options: Url.Options);
+    constructor(_options?: Url.Options);
     /**
      * Create a shortened URL that redirects visitors to the provided destination URL.
      *
@@ -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>
      *
@@ -87,6 +87,6 @@ export declare class Url {
     update(linkId: string, request?: Pinnacle.tools.UpdateUrlParams, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrl>;
     private __update;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/esm/api/resources/tools/resources/url/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class Url {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -160,7 +160,7 @@ export 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/esm/api/resources/webhooks/client/Client.d.mts

@@ -9,7 +9,7 @@ export declare namespace Webhooks {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Webhooks {
 }
 export declare class Webhooks {
     protected readonly _options: Webhooks.Options;
-    constructor(_options: Webhooks.Options);
+    constructor(_options?: Webhooks.Options);
     /**
      * Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
      *
@@ -47,6 +47,6 @@ export declare class Webhooks {
     get(request: Pinnacle.GetWebhookParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.WebhookResult>;
     private __get;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/esm/api/resources/webhooks/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
 import * as errors from "../../../../errors/index.mjs";
 export class Webhooks {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**

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

@@ -22,7 +22,7 @@ export interface AdvancedPhoneInformation {
     /** Detailed carrier information. */
     carrier: AdvancedPhoneInformation.Carrier;
     /** Enhanced contact information associated with the phone number. */
-    contact?: AdvancedPhoneInformation.Contact | null;
+    contact: AdvancedPhoneInformation.Contact | null;
 }
 export declare namespace AdvancedPhoneInformation {
     /**
@@ -68,25 +68,25 @@ export declare namespace AdvancedPhoneInformation {
         /** Complete country identification and metadata. */
         country: Location.Country;
         /** Primary city or municipality associated with the phone number. */
-        city?: string | null;
+        city: string | null;
         /**
          * State, province, or primary administrative division code.
          * Uses standard 2-letter abbreviations where applicable.
          */
-        state?: string | null;
+        state: string | null;
         /** Postal or ZIP code for the phone number's registered location. */
-        zip?: string | null;
+        zip: string | null;
         /**
          * Primary Metropolitan Statistical Area (PMSA) code for US numbers.
          * Used for demographic and market analysis purposes.
          */
-        metroCode?: string | null;
+        metroCode: string | null;
         /** County or secondary administrative division name. */
-        county?: string | null;
+        county: string | null;
         /** Coordinates provide the precise latitude and longitude values for the phone number’s registered location. */
         coordinates: Location.Coordinates;
         /** IANA timezone identifier for the number’s location. */
-        timeZone?: string | null;
+        timeZone: string | null;
     }
     namespace Location {
         /**
@@ -105,9 +105,9 @@ export declare namespace AdvancedPhoneInformation {
          */
         interface Coordinates {
             /** Decimal degrees latitude coordinate. */
-            latitude?: number | null;
+            latitude: number | null;
             /** Decimal degrees longitude coordinate. */
-            longitude?: number | null;
+            longitude: number | null;
         }
     }
     /**

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

@@ -10,13 +10,13 @@ export type AttachWebhookParams =
 /**
  * Attach a webhook you’ve already created in your account to this phone number. */
 {
-    webhookId: number;
-    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+    webhookId: string;
+    event: Pinnacle.WebhookEventEnum | null;
 }
 /**
  * Create a new webhook and immediately attach it to your phone number. */
  | {
     name: string;
     url: string;
-    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+    event: Pinnacle.WebhookEventEnum | null;
 };

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

@@ -22,8 +22,8 @@ export declare namespace AttachedPhoneNumberResult {
              * Campaign that the phone is now attached to.
              */
             interface Campaign {
-                /** Id of the campaign. */
-                id: number;
+                /** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
+                id: string;
                 /** Campaign's name. */
                 name: string;
                 type: Pinnacle.MessagingProfileEnum;

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

@@ -4,6 +4,11 @@
 export interface AutofillCampaignParams {
     /** Any additional information you want to provide. */
     additionalInfo?: string;
-    /** Campaign ID. */
-    campaignId?: number;
+    /**
+     * Unique identifier for the campaign.
+     * - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
+     * - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
+     * - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)
+     */
+    campaignId?: string;
 }

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

@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.mjs";
 export interface AutofillDlcCampaignResponse {
     /** Whether the campaign renews automatically. */
     autoRenew: boolean;
-    /** Brand id. */
-    brand?: number;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brand?: string;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    campaignId?: string;
     /** Description of the campaign. */
     description?: string;
     /** Keyword response configuration. */
@@ -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/esm/api/types/BrandStatus.d.mts

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.mjs";
 export interface BrandStatus {
     /** List of errors that occurred. */
     errors: string[];
-    /** Id of the brand. */
-    id: number;
+    /** The unique identifier of the brand. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    id: string;
     /**
      * Current review status of the brand. <br>
      *

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+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/esm/api/types/ButtonClicked.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,58 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * 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: string | 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;
+        /** Number of times the button has been clicked. */
+        clicks: number;
+    }
+    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/esm/api/types/ButtonClickedData.mjs

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var ButtonClickedData;
+(function (ButtonClickedData) {
+    let Button;
+    (function (Button) {
+        Button.Type = {
+            Card: "CARD",
+            QuickReply: "QUICK_REPLY",
+        };
+    })(Button = ButtonClickedData.Button || (ButtonClickedData.Button = {}));
+})(ButtonClickedData || (ButtonClickedData = {}));

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

@@ -6,7 +6,12 @@ import * as Pinnacle from "../index.mjs";
  * Information about the campaign associated with a conversation
  */
 export interface CampaignQuery {
-    /** Unique identifier for the campaign */
+    /**
+     * Unique identifier for the campaign. This identifier is a string that begins with the prefix:
+     * - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
+     * - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
+     * - RCS: `rcs_` (e.g., `rcs_1234567890`)
+     */
     id: string;
     type: Pinnacle.CampaignEnum;
 }

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

@@ -19,8 +19,8 @@ export declare namespace ConfiguredWebhook {
      * Detailed information about the attached webhook.
      */
     interface Webhook {
-        /** Unique identifier of the webhook within the account. */
-        id: number;
+        /** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
+        id: string;
         /** Name of the webhook. */
         name: string;
         /** The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests. */

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

@@ -6,8 +6,8 @@ export interface Contact {
     description?: string;
     /** Contact's email address, if available. */
     email?: string;
-    /** Unique ID of the contact. */
-    id: number;
+    /** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+    id: string;
     /** Full name of the contact, if available. */
     name?: string;
     /** Contact's phone number in E.164 format. */

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

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ContactId {
-    /** Unique ID of the created contact. */
-    id: number;
+    /** Unique ID of the created contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+    id: string;
 }