rcs-js 1.0.22 → 2.0.0-rc.2

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

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

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

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The primary use case classification for this campaign.
+ */
+export type DlcCampaignUseCaseEnum = "ACCOUNT_NOTIFICATION" | "AGENTS_FRANCHISES" | "CARRIER_EXEMPT" | "CHARITY" | "CUSTOMER_CARE" | "DELIVERY_NOTIFICATION" | "EMERGENCY" | "FRAUD_ALERT" | "HIGHER_EDUCATION" | "K12_EDUCATION" | "LOW_VOLUME" | "M2M" | "MARKETING" | "MIXED" | "POLITICAL" | "POLLING_VOTING" | "PROXY" | "PUBLIC_SERVICE_ANNOUNCEMENT" | "SECURITY_ALERT" | "SOCIAL" | "SOLE_PROPRIETOR" | "SWEEPSTAKE" | "TRIAL" | "TWO_FA" | "UCAAS_HIGH" | "UCAAS_LOW";
+export declare const DlcCampaignUseCaseEnum: {
+    readonly AccountNotification: "ACCOUNT_NOTIFICATION";
+    readonly AgentsFranchises: "AGENTS_FRANCHISES";
+    readonly CarrierExempt: "CARRIER_EXEMPT";
+    readonly Charity: "CHARITY";
+    readonly CustomerCare: "CUSTOMER_CARE";
+    readonly DeliveryNotification: "DELIVERY_NOTIFICATION";
+    readonly Emergency: "EMERGENCY";
+    readonly FraudAlert: "FRAUD_ALERT";
+    readonly HigherEducation: "HIGHER_EDUCATION";
+    readonly K12Education: "K12_EDUCATION";
+    readonly LowVolume: "LOW_VOLUME";
+    readonly M2M: "M2M";
+    readonly Marketing: "MARKETING";
+    readonly Mixed: "MIXED";
+    readonly Political: "POLITICAL";
+    readonly PollingVoting: "POLLING_VOTING";
+    readonly Proxy: "PROXY";
+    readonly PublicServiceAnnouncement: "PUBLIC_SERVICE_ANNOUNCEMENT";
+    readonly SecurityAlert: "SECURITY_ALERT";
+    readonly Social: "SOCIAL";
+    readonly SoleProprietor: "SOLE_PROPRIETOR";
+    readonly Sweepstake: "SWEEPSTAKE";
+    readonly Trial: "TRIAL";
+    readonly TwoFa: "TWO_FA";
+    readonly UcaasHigh: "UCAAS_HIGH";
+    readonly UcaasLow: "UCAAS_LOW";
+};

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

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DlcCampaignUseCaseEnum = void 0;
+exports.DlcCampaignUseCaseEnum = {
+    AccountNotification: "ACCOUNT_NOTIFICATION",
+    AgentsFranchises: "AGENTS_FRANCHISES",
+    CarrierExempt: "CARRIER_EXEMPT",
+    Charity: "CHARITY",
+    CustomerCare: "CUSTOMER_CARE",
+    DeliveryNotification: "DELIVERY_NOTIFICATION",
+    Emergency: "EMERGENCY",
+    FraudAlert: "FRAUD_ALERT",
+    HigherEducation: "HIGHER_EDUCATION",
+    K12Education: "K12_EDUCATION",
+    LowVolume: "LOW_VOLUME",
+    M2M: "M2M",
+    Marketing: "MARKETING",
+    Mixed: "MIXED",
+    Political: "POLITICAL",
+    PollingVoting: "POLLING_VOTING",
+    Proxy: "PROXY",
+    PublicServiceAnnouncement: "PUBLIC_SERVICE_ANNOUNCEMENT",
+    SecurityAlert: "SECURITY_ALERT",
+    Social: "SOCIAL",
+    SoleProprietor: "SOLE_PROPRIETOR",
+    Sweepstake: "SWEEPSTAKE",
+    Trial: "TRIAL",
+    TwoFa: "TWO_FA",
+    UcaasHigh: "UCAAS_HIGH",
+    UcaasLow: "UCAAS_LOW",
+};

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

@@ -0,0 +1,116 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Dlc campaign schema that includes extended brand and status.
+ */
+export interface DlcCampaignWithExtendedBrandAndStatus {
+    /** Whether the campaign renews automatically. */
+    autoRenew: boolean;
+    /** Brand associated with this campaign. */
+    brand: Pinnacle.ExtendedBrand;
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    /** Description of the campaign. */
+    description?: string;
+    /** Keyword response configuration. */
+    keywords?: DlcCampaignWithExtendedBrandAndStatus.Keywords;
+    /** Legal documentation links. */
+    links?: DlcCampaignWithExtendedBrandAndStatus.Links;
+    /** Describe the flow of how users will opt in to this campaign. */
+    messageFlow?: string;
+    /** Display name of the campaign. */
+    name?: string;
+    /** Campaign configuration options. */
+    options?: DlcCampaignWithExtendedBrandAndStatus.Options;
+    /** Example messages for the campaign. */
+    sampleMessages?: string[];
+    /**
+     * 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>
+     */
+    status: Pinnacle.ProfileStatusEnum;
+    /** Use case for the campaign. */
+    useCase?: DlcCampaignWithExtendedBrandAndStatus.UseCase;
+}
+export declare namespace DlcCampaignWithExtendedBrandAndStatus {
+    /**
+     * Keyword response configuration.
+     */
+    interface Keywords {
+        /** Help keyword settings. */
+        HELP: Keywords.Help;
+        /** Opt-in keyword settings. */
+        OPT_IN: Keywords.OptIn;
+        /** Opt-out keyword settings. */
+        OPT_OUT: Keywords.OptOut;
+    }
+    namespace Keywords {
+        /**
+         * Help keyword settings.
+         */
+        interface Help {
+            /** Response message for help keywords. */
+            message?: string;
+            /** Keywords that trigger help response. */
+            values?: string[];
+        }
+        /**
+         * Opt-in keyword settings.
+         */
+        interface OptIn {
+            /** Response message for opt-in keywords. */
+            message: string;
+            /** Keywords that trigger opt-in. */
+            values: string[];
+        }
+        /**
+         * Opt-out keyword settings.
+         */
+        interface OptOut {
+            /** Response message for opt-out keywords. */
+            message: string;
+            /** Keywords that trigger opt-out. */
+            values: string[];
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Campaign configuration options.
+     */
+    interface Options {
+        /** Whether the campaign uses affiliate marketing. */
+        affiliateMarketing: boolean;
+        /** Whether the campaign is age-gated. */
+        ageGated: boolean;
+        /** Whether the campaign involves direct lending. */
+        directLending: boolean;
+        /** Link embedded in campaign message. */
+        embeddedLink?: string;
+        /** Whether messages include phone numbers. */
+        embeddedPhone: boolean;
+        /** Whether the campaign uses number pooling. */
+        numberPooling: boolean;
+    }
+    /**
+     * Use case for the campaign.
+     */
+    interface UseCase {
+        /** Sub-use case categories. */
+        sub?: Pinnacle.SubUseCaseEnum[];
+        value?: Pinnacle.DlcCampaignUseCaseEnum;
+    }
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Collection of contact profiles associated with a phone number.
+ * May include multiple profiles if the number is associated with different online identities.
+ */
+export type EnhancedContact = Pinnacle.EnhancedContactItem[];

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

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

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

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface EnhancedContactItem {
+    /**
+     * Professional or personal description of the contact.
+     * May include job title, company affiliation, or biographical information.
+     */
+    description: string;
+    /** Primary email address associated with this contact profile. */
+    email: string;
+    /**
+     * Additional web links associated with this contact profile.
+     * May include personal websites, social media profiles, or professional portfolios.
+     */
+    links: string[];
+    /**
+     * LinkedIn profile URL if available and publicly accessible.
+     * Null if no LinkedIn profile is found or accessible.
+     */
+    linkedin?: string | null;
+    /** Full name of the contact person associated with this profile. */
+    name: string;
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Standard error response returned when a request cannot be processed successfully.
+ */
+export interface Error_ {
+    /** Human-readable description of the error that occurred, corresponding to the HTTP status code. */
+    error: string;
+}

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
+    /** ISO 8601 formatted timestamp of when this brand was added to our system. */
+    createdAt: string;
+    /** The brand's ID. */
+    id: number;
+    /** Indicates if this brand is archived. */
+    isArchived: boolean;
+    /**
+     * 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.
+     */
+    status: Pinnacle.BrandStatusEnum;
+    /** ISO 8601 formatted timestamp of when this brand was last updated. */
+    updatedAt: string;
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
+    /** ISO 8601 formatted timestamp of the last TCR vetting. */
+    lastTcrVettingDate?: string | null;
+    /** Feedback from The Campaign Registry if TCR vetting was performed. */
+    tcrFeedback?: Pinnacle.VettingFeedback[] | null;
+    /** History of all external vetting attempts for this brand. */
+    vettingHistory: Pinnacle.VettingHistory[];
+}

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

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

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

@@ -0,0 +1,112 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface ExtendedRcsCampaign {
+    /** Agent configured to the campaign. */
+    agent: ExtendedRcsCampaign.Agent;
+    /** Agent's unique identifier. */
+    agentId: string;
+    /** Brand associated with this campaign. */
+    brand: Pinnacle.ExtendedBrand;
+    /** Indicates whether the brand has provided an attestation. */
+    brandAttestation: boolean;
+    /** Unique identifier for the campaign. */
+    campaignId: number;
+    /** List of what the agent might say to users. */
+    expectedAgentResponses?: string[];
+    /** Legal documentation links. */
+    links: ExtendedRcsCampaign.Links;
+    /** Opt-in configuration. */
+    optIn: ExtendedRcsCampaign.OptIn;
+    /** Opt-out configuration. */
+    optOut: ExtendedRcsCampaign.OptOut;
+    /** Use case classification for the campaign. */
+    useCase: ExtendedRcsCampaign.UseCase;
+}
+export declare namespace ExtendedRcsCampaign {
+    /**
+     * Agent configured to the campaign.
+     */
+    interface Agent {
+        /** Color of the agent's buttons. */
+        color?: string;
+        /** Description of the agent. */
+        description?: string;
+        /** List of emails. */
+        emails?: Agent.Emails.Item[];
+        /** Link to the agent's hero. */
+        heroUrl?: string;
+        /** Link to the agent's icon. */
+        iconUrl?: string;
+        /** Name of the agent. */
+        name?: string;
+        /** List of phone numbers. */
+        phones?: Agent.Phones.Item[];
+        /** List of urls. */
+        websites?: Agent.Websites.Item[];
+    }
+    namespace Agent {
+        type Emails = Emails.Item[];
+        namespace Emails {
+            interface Item {
+                /** Email attached to the agent. */
+                email?: string;
+                /** Label for the email. */
+                label?: string;
+            }
+        }
+        type Phones = Phones.Item[];
+        namespace Phones {
+            interface Item {
+                /** Label for the phone number. */
+                label?: string;
+                /** Phone number attached to the agent in E.164 format. */
+                phone?: string;
+            }
+        }
+        type Websites = Websites.Item[];
+        namespace Websites {
+            interface Item {
+                /** Label for the url. */
+                label?: string;
+                /** Url attached to the agent. */
+                url?: string;
+            }
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Opt-in configuration.
+     */
+    interface OptIn {
+        method?: Pinnacle.RcsCampaignOptInMethodEnum;
+        /** Message shown to users explaining what they are agreeing to when opting in. */
+        termsAndConditions?: string;
+    }
+    /**
+     * Opt-out configuration.
+     */
+    interface OptOut {
+        /** Description for the keyword. */
+        description?: string;
+        /** Keywords to opt-out. */
+        keywords?: string[];
+    }
+    /**
+     * Use case classification for the campaign.
+     */
+    interface UseCase {
+        /** Summary of the use case. */
+        behavior?: string;
+        value?: Pinnacle.RcsCampaignUseCaseEnum;
+    }
+}

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Parameters for getting a specific conversation.
+ */
+export type GetConversationParams = 
+/**
+ * Retrieve conversation information by ID. */
+{
+    id: number;
+}
+/**
+ * Retrieve conversation information by sender and recipient. */
+ | {
+    recipient: string;
+    sender: string;
+};

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

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

package/dist/cjs/api/types/InboundButton.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 InboundButton = 
+/**
+ * Data associated with a button that is pressed. Excludes `requestUserLocation` and `sendLocation`. */
+Pinnacle.ClickAction
+/**
+ * User provided location. Occurs when recipient responds to a `requestUserLocation` or `sendLocation` button. */
+ | Pinnacle.LocationShareAction;

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

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

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

@@ -0,0 +1,107 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LinkClickEvent {
+    /** Accept-Language header value. */
+    accept_language?: string | null;
+    /** Accuracy radius for geographic coordinates in kilometers. */
+    accuracy_radius_km?: number | null;
+    /** Autonomous System Number. */
+    asn?: number | null;
+    /** Reason why the request was blocked (if applicable). */
+    blocked_reason?: string | null;
+    /** User-Agent Client Hint brand. */
+    ch_ua_brand?: string | null;
+    /** User-Agent Client Hint mobile indicator. */
+    ch_ua_mobile?: string | null;
+    /** User-Agent Client Hint platform. */
+    ch_ua_platform?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Color depth in bits. */
+    color_depth?: number | null;
+    /** Type of internet connection. */
+    connection_type?: string | null;
+    /** Country code (ISO 3166-1 alpha-2). */
+    country?: string | null;
+    /** Timestamp when the click occurred in ISO 8601 format. */
+    created_at: string;
+    /** Error details if the request failed. */
+    error_details?: Record<string, unknown> | null;
+    /** Facebook Click Identifier. */
+    fbclid?: string | null;
+    /** Final resolved URL after redirects. */
+    final_url?: string | null;
+    /** Unique fingerprint identifier for the client. */
+    fingerprint_id?: string | null;
+    /** Google Click Identifier. */
+    gclid?: string | null;
+    /** Unique identifier for the click event. */
+    id: number;
+    /** IP address of the visitor (may be anonymized). */
+    ip_address?: string | null;
+    /** Chain of IP addresses for proxied requests. */
+    ip_chain?: string[] | null;
+    /** Whether the request was identified as coming from a bot. */
+    is_bot?: boolean | null;
+    /** Request latency in milliseconds. */
+    latency_ms?: number | null;
+    /** Geographic latitude. */
+    latitude?: number | null;
+    /** ID of your shortened URL. */
+    link_id: number;
+    /** Geographic longitude. */
+    longitude?: number | null;
+    /** Additional metadata as JSON object. */
+    metadata?: Record<string, unknown> | null;
+    /** HTTP method used. */
+    method?: string | null;
+    /** Metro area code. */
+    metro_code?: number | null;
+    /** Network downlink speed estimate in Mbps. */
+    network_downlink?: number | null;
+    /** Network round-trip time in milliseconds. */
+    network_rtt?: number | null;
+    /** Time to first byte in milliseconds,. */
+    performance_ttfb_ms?: number | null;
+    /** Postal/ZIP code. */
+    postal_code?: string | null;
+    /** Number of redirect hops to reach final destination. */
+    redirect_hops?: number | null;
+    /** The referring URL. */
+    referrer?: string | null;
+    /** Domain of the referring URL. */
+    referrer_domain?: string | null;
+    /** Region or state. */
+    region?: string | null;
+    /** Timestamp when the redirect was resolved in ISO 8601 format. */
+    resolved_at?: string | null;
+    /** Screen resolution. */
+    screen_res?: string | null;
+    /** HTTP status code of the response. */
+    status_code?: number | null;
+    /** Timezone offset in minutes from UTC. */
+    timezone_offset_min?: number | null;
+    /** Whether the request came from a Tor exit node. */
+    tor_exit_node?: boolean | null;
+    /** Browser name. */
+    ua_browser?: string | null;
+    /** Device type. */
+    ua_device?: string | null;
+    /** Operating system. */
+    ua_os?: string | null;
+    /** Browser version. */
+    ua_version?: string | null;
+    /** User agent string from the browser. */
+    user_agent?: string | null;
+    /** UTM campaign parameter. */
+    utm_campaign?: string | null;
+    /** UTM content parameter. */
+    utm_content?: string | null;
+    /** UTM medium parameter. */
+    utm_medium?: string | null;
+    /** UTM source parameter. */
+    utm_source?: string | null;
+    /** UTM term. */
+    utm_term?: string | null;
+}

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LocationShareAction {
+    /** Location data shared by the user. */
+    data: LocationShareAction.Data;
+}
+export declare namespace LocationShareAction {
+    /**
+     * Location data shared by the user.
+     */
+    interface Data {
+        /** Address corresponding to the shared location. */
+        address: string;
+        /** Latitude of the shared location. */
+        latitude: number;
+        /** Longitude of the shared location. */
+        longitude: number;
+        /** Text message sent with the location. */
+        text?: string;
+    }
+}

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

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

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

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface Message {
+    content: Pinnacle.MessageContent;
+    /**
+     * Total cost charged for sending the message. <br>
+     *
+     * Null means the message incurred no cost or has not been charged yet.
+     */
+    cost?: number | null;
+    /**
+     * Timestamp indicating when the message was successfully delivered to the recipient. <br>
+     *
+     * Null indicates the message has not yet been delivered.
+     */
+    deliveredAt?: string | null;
+    /**
+     * Detailed explanation of any errors that occurred while delivering the message. <br>
+     *
+     * Null indicates no errors.
+     */
+    error?: string | null;
+    /** Unique identifier of the message. */
+    id: number;
+    method: Pinnacle.MessageMethodEnum;
+    /** Number of segments the message was split into for delivery. */
+    numSegments: number;
+    /** Phone number that received the message in E.164 format. */
+    receiver: string;
+    /** Phone number or agent that sent the message. */
+    sender: string;
+    /**
+     * Timestamp indicating when the message was submitted for delivery. <br>
+     *
+     * Null indicates the message is still in the queue.
+     */
+    sentAt?: string | null;
+    status: Pinnacle.MessageStatusEnum;
+    type: Pinnacle.MessageProtocolEnum;
+}