rcs-js 1.0.22 → 2.0.0-rc.2

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Current review status of the brand.
+ *
+ * `INCOMPLETE`: Has not been submitted.
+ * `PENDING`: Currently being reviewed.
+ * `VERIFIED`: Verified and good to go.
+ * `UNVERIFIED`: No longer verified due to an update in the brand details.
+ * `VETTED`: Brand has been vetted by an external provider and has received vetting scores.
+ */
+export type BrandStatusEnum = "PENDING" | "UNVERIFIED" | "VERIFIED" | "VETTED" | "FAILED" | "INCOMPLETE";
+export declare const BrandStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Unverified: "UNVERIFIED";
+    readonly Verified: "VERIFIED";
+    readonly Vetted: "VETTED";
+    readonly Failed: "FAILED";
+    readonly Incomplete: "INCOMPLETE";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrandStatusEnum = void 0;
+exports.BrandStatusEnum = {
+    Pending: "PENDING",
+    Unverified: "UNVERIFIED",
+    Verified: "VERIFIED",
+    Vetted: "VETTED",
+    Failed: "FAILED",
+    Incomplete: "INCOMPLETE",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of campaign:
+ * - TOLL_FREE: Toll-free number campaigns
+ * - 10DLC: 10-digit long code campaigns for A2P messaging
+ * - RCS: Rich Communication Services campaigns
+ */
+export type CampaignEnum = "TOLL_FREE" | "10DLC" | "RCS";
+export declare const CampaignEnum: {
+    readonly TollFree: "TOLL_FREE";
+    readonly TenDlc: "10DLC";
+    readonly Rcs: "RCS";
+};

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

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignEnum = void 0;
+exports.CampaignEnum = {
+    TollFree: "TOLL_FREE",
+    TenDlc: "10DLC",
+    Rcs: "RCS",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Information about the campaign associated with a conversation
+ */
+export interface CampaignQuery {
+    /** Unique identifier for the campaign */
+    id: string;
+    type: Pinnacle.CampaignEnum;
+}

package/dist/cjs/api/types/CampaignQuery.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/CampaignSubmissionResult.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CampaignSubmissionResult {
+    /** Indicates whether the campaign submission was successful. */
+    success: boolean;
+}

package/dist/cjs/api/types/CampaignSubmissionResult.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/CampaignValidationResult.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CampaignValidationResult {
+    /** List of validation errors. */
+    errors: CampaignValidationResult.Errors.Item[];
+    /** Whether the campaign is valid or not. */
+    is_valid: boolean;
+}
+export declare namespace CampaignValidationResult {
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            /** A human-readable description of the error. */
+            description: string;
+            /** An example of a valid value for the field. */
+            example?: string;
+            /** The field that is not valid. */
+            field: string;
+        }
+    }
+}

package/dist/cjs/api/types/CampaignValidationResult.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/ClickAction.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ClickAction {
+    /** Title of the button or quick reply that was clicked on. */
+    button: string;
+    /** Payload received from the button interaction. */
+    data: ClickAction.Data;
+}
+export declare namespace ClickAction {
+    /**
+     * Payload received from the button interaction.
+     */
+    type Data = 
+    /**
+     * Data that is attached to the button. <br>
+     *
+     * This is only returned when `trigger` buttons are pressed. */
+    {
+        metadata: string;
+        payload: string;
+    }
+    /**
+     * Indicates that the button was clicked. <br>
+     *
+     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
+     | "clicked";
+}

package/dist/cjs/api/types/ClickAction.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/CompanySectorEnum.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Industry the Brand operates in.
+ */
+export type CompanySectorEnum = "AGRICULTURE" | "COMMUNICATION" | "CONSTRUCTION" | "EDUCATION" | "ENERGY" | "ENTERTAINMENT" | "FINANCIAL" | "GAMBLING" | "GOVERNMENT" | "HEALTHCARE" | "HOSPITALITY" | "INSURANCE" | "MANUFACTURING" | "NGO" | "REAL_ESTATE" | "RETAIL" | "TECHNOLOGY";
+export declare const CompanySectorEnum: {
+    readonly Agriculture: "AGRICULTURE";
+    readonly Communication: "COMMUNICATION";
+    readonly Construction: "CONSTRUCTION";
+    readonly Education: "EDUCATION";
+    readonly Energy: "ENERGY";
+    readonly Entertainment: "ENTERTAINMENT";
+    readonly Financial: "FINANCIAL";
+    readonly Gambling: "GAMBLING";
+    readonly Government: "GOVERNMENT";
+    readonly Healthcare: "HEALTHCARE";
+    readonly Hospitality: "HOSPITALITY";
+    readonly Insurance: "INSURANCE";
+    readonly Manufacturing: "MANUFACTURING";
+    readonly Ngo: "NGO";
+    readonly RealEstate: "REAL_ESTATE";
+    readonly Retail: "RETAIL";
+    readonly Technology: "TECHNOLOGY";
+};

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

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanySectorEnum = void 0;
+exports.CompanySectorEnum = {
+    Agriculture: "AGRICULTURE",
+    Communication: "COMMUNICATION",
+    Construction: "CONSTRUCTION",
+    Education: "EDUCATION",
+    Energy: "ENERGY",
+    Entertainment: "ENTERTAINMENT",
+    Financial: "FINANCIAL",
+    Gambling: "GAMBLING",
+    Government: "GOVERNMENT",
+    Healthcare: "HEALTHCARE",
+    Hospitality: "HOSPITALITY",
+    Insurance: "INSURANCE",
+    Manufacturing: "MANUFACTURING",
+    Ngo: "NGO",
+    RealEstate: "REAL_ESTATE",
+    Retail: "RETAIL",
+    Technology: "TECHNOLOGY",
+};

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Legal structure of the brand.
+ */
+export type CompanyTypeEnum = "GOVERNMENT" | "NON_PROFIT" | "PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "SOLE_PROPRIETOR";
+export declare const CompanyTypeEnum: {
+    readonly Government: "GOVERNMENT";
+    readonly NonProfit: "NON_PROFIT";
+    readonly PrivateProfit: "PRIVATE_PROFIT";
+    readonly PublicProfit: "PUBLIC_PROFIT";
+    readonly SoleProprietor: "SOLE_PROPRIETOR";
+};

package/dist/cjs/api/types/CompanyTypeEnum.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.CompanyTypeEnum = void 0;
+exports.CompanyTypeEnum = {
+    Government: "GOVERNMENT",
+    NonProfit: "NON_PROFIT",
+    PrivateProfit: "PRIVATE_PROFIT",
+    PublicProfit: "PUBLIC_PROFIT",
+    SoleProprietor: "SOLE_PROPRIETOR",
+};

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

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Confirmation that a webhook has been successfully attached to the specified phone number.
+ * Includes detailed webhook information, the subscribed event type, and the associated phone number.
+ */
+export interface ConfiguredWebhook {
+    /** Detailed information about the attached webhook. */
+    webhook: ConfiguredWebhook.Webhook;
+    /** Specific event type configured for this webhook attachment. */
+    event: Pinnacle.WebhookEventEnum;
+    /** Phone number in E.164 format that is linked to the webhook. */
+    phoneNumber: string;
+}
+export declare namespace ConfiguredWebhook {
+    /**
+     * Detailed information about the attached webhook.
+     */
+    interface Webhook {
+        /** Unique identifier of the webhook within the account. */
+        id: number;
+        /** Name of the webhook. */
+        name: string;
+        /** The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests. */
+        url: string;
+        /**
+         * Secret key used to verify the authenticity of incoming webhook requests. <br>
+         *
+         * This secret key will be stored in the `PINNACLE-SIGNING-SECRET` header.
+         */
+        secret?: string;
+    }
+}

package/dist/cjs/api/types/ConfiguredWebhook.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/Contact.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Contact {
+    /** Additional information about the contact. */
+    description?: string;
+    /** Contact's email address, if available. */
+    email?: string;
+    /** Unique ID of the contact. */
+    id: number;
+    /** Full name of the contact, if available. */
+    name?: string;
+    /** Contact's phone number in E.164 format. */
+    phoneNumber: string;
+    /** List of tags associated with the contact. */
+    tags?: string[];
+}

package/dist/cjs/api/types/Contact.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/ContactId.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ContactId {
+    /** Unique ID of the created contact. */
+    id: number;
+}

package/dist/cjs/api/types/ContactId.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/Conversation.d.ts

@@ -0,0 +1,63 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Conversation that was found.
+ */
+export interface Conversation {
+    /** Identifier for the brand associated with this conversation. */
+    brandId?: number | null;
+    /** Campaign information if this conversation is part of a marketing campaign. */
+    campaign?: Pinnacle.CampaignQuery | null;
+    /** Contact information for the recipient in a conversation. */
+    contact: Conversation.Contact;
+    /** ISO 8601 timestamp when the conversation was created. */
+    createdAt: string;
+    /** Unique identifier for the conversation. */
+    id: number;
+    /** Free-form notes or comments about the conversation. */
+    notes: string;
+    /**
+     * The sender of messages in this conversation. Can be:
+     * - A phone number with its capabilities and metadata
+     * - An RCS agent with ID and name
+     * - `null` if no sender is associated
+     */
+    sender?: Conversation.Sender | null;
+    /** ISO 8601 timestamp when the conversation was last updated. */
+    updatedAt: string;
+}
+export declare namespace Conversation {
+    /**
+     * Contact information for the recipient in a conversation.
+     */
+    interface Contact {
+        /** Unique identifier for the contact. */
+        id: number;
+        /** The contact's phone number in E.164 format. */
+        phoneNumber: string;
+    }
+    /**
+     * The sender of messages in this conversation. Can be:
+     * - A phone number with its capabilities and metadata
+     * - An RCS agent with ID and name
+     * - `null` if no sender is associated
+     */
+    type Sender = 
+    /**
+     * Information about a phone number sender in a conversation. */
+    {
+        capabilities: Pinnacle.PhoneCapabilities;
+        createdAt: string;
+        isSandbox: boolean;
+        phoneNumber: string;
+        updatedAt: string;
+    }
+    /**
+     * Information about an RCS agent sender in a conversation. */
+     | {
+        agentId: string;
+        agentName: string;
+    };
+}

package/dist/cjs/api/types/Conversation.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/ConversationList.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Response for list conversation.
+ */
+export interface ConversationList {
+    /** Total number of conversations matching the filter. */
+    count: number;
+    conversations: Pinnacle.Conversation[];
+    /** Indicates if more conversations are available beyond the current page. */
+    hasMore: boolean;
+}

package/dist/cjs/api/types/ConversationList.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/CreateUrlOptions.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateUrlOptions {
+    /**
+     * Expiration date in ISO 8601 format for the shortened URL. <br>
+     *
+     * If omitted, then a permalink is generated instead.
+     */
+    expiresAt?: string | null;
+}

package/dist/cjs/api/types/CreateUrlOptions.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/DetachedPhoneNumberResult.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 DetachedPhoneNumberResult {
+    /** List of phone numbers. */
+    phoneNumbers: DetachedPhoneNumberResult.PhoneNumbers.Item[];
+    /** List of numbers that were not failed to be detached. */
+    failed: DetachedPhoneNumberResult.Failed.Item[];
+}
+export declare namespace DetachedPhoneNumberResult {
+    type PhoneNumbers = PhoneNumbers.Item[];
+    namespace PhoneNumbers {
+        interface Item {
+            /** Phone number (E.164 format). */
+            phoneNumber: string;
+            /** Campaign that the phone is now detached from. */
+            campaign: Item.Campaign;
+        }
+        namespace Item {
+            /**
+             * Campaign that the phone is now detached from.
+             */
+            interface Campaign {
+                /** Id of the campaign. */
+                id: number;
+                /** Campaign's name. */
+                name: string;
+                type: Pinnacle.MessagingProfileEnum;
+            }
+        }
+    }
+    type Failed = Failed.Item[];
+    namespace Failed {
+        interface Item {
+            /** Phone number (E.164 format). */
+            number: string;
+            /** Error related to why the number was not detached. */
+            error: string;
+        }
+    }
+}

package/dist/cjs/api/types/DetachedPhoneNumberResult.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/DetachedWebhookInfo.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DetachedWebhookInfo {
+    /** Confirmation message. */
+    message: string;
+    /** ID of the detached webhook. */
+    webhookId: number;
+    /** Phone number the webhook was detached from in E.164 format. */
+    phoneNumber: string;
+}

package/dist/cjs/api/types/DetachedWebhookInfo.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/DetailedPhoneNumberEnum.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Classification of the phone number type based on Telesign’s taxonomy.
+ * Indicates the phone’s service category, such as mobile, fixed line, toll-free, or VOIP,
+ * along with special types like prepaid, pager, or restricted premium.
+ * The "INVALID" type denotes an unrecognized or improperly formatted number.
+ */
+export type DetailedPhoneNumberEnum = "FIXED_LINE" | "INVALID" | "MOBILE" | "OTHER" | "PAGER" | "PAYPHONE" | "PERSONAL" | "PREPAID" | "RESTRICTED_PREMIUM" | "TOLL_FREE" | "VOICEMAIL" | "VOIP";
+export declare const DetailedPhoneNumberEnum: {
+    readonly FixedLine: "FIXED_LINE";
+    readonly Invalid: "INVALID";
+    readonly Mobile: "MOBILE";
+    readonly Other: "OTHER";
+    readonly Pager: "PAGER";
+    readonly Payphone: "PAYPHONE";
+    readonly Personal: "PERSONAL";
+    readonly Prepaid: "PREPAID";
+    readonly RestrictedPremium: "RESTRICTED_PREMIUM";
+    readonly TollFree: "TOLL_FREE";
+    readonly Voicemail: "VOICEMAIL";
+    readonly Voip: "VOIP";
+};

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

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DetailedPhoneNumberEnum = void 0;
+exports.DetailedPhoneNumberEnum = {
+    FixedLine: "FIXED_LINE",
+    Invalid: "INVALID",
+    Mobile: "MOBILE",
+    Other: "OTHER",
+    Pager: "PAGER",
+    Payphone: "PAYPHONE",
+    Personal: "PERSONAL",
+    Prepaid: "PREPAID",
+    RestrictedPremium: "RESTRICTED_PREMIUM",
+    TollFree: "TOLL_FREE",
+    Voicemail: "VOICEMAIL",
+    Voip: "VOIP",
+};

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Current assignment status of the phone number to this campaign.
+ *
+ * `ASSIGNED`: Number assigned and ready to send messages.
+ * `PENDING_ASSIGNMENT`: In the process of being assigned.
+ * `PENDING_UNASSIGNMENT`: In the process of being unassigned.
+ * `FAILED_ASSIGNMENT`: Failed to assign the number.
+ * `FAILED_UNASSIGNMENT`: Failed to unassign the number.
+ */
+export type DlcAssignmentStatusEnum = "ASSIGNED" | "FAILED_ASSIGNMENT" | "FAILED_UNASSIGNMENT" | "PENDING_ASSIGNMENT" | "PENDING_UNASSIGNMENT";
+export declare const DlcAssignmentStatusEnum: {
+    readonly Assigned: "ASSIGNED";
+    readonly FailedAssignment: "FAILED_ASSIGNMENT";
+    readonly FailedUnassignment: "FAILED_UNASSIGNMENT";
+    readonly PendingAssignment: "PENDING_ASSIGNMENT";
+    readonly PendingUnassignment: "PENDING_UNASSIGNMENT";
+};

package/dist/cjs/api/types/DlcAssignmentStatusEnum.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.DlcAssignmentStatusEnum = void 0;
+exports.DlcAssignmentStatusEnum = {
+    Assigned: "ASSIGNED",
+    FailedAssignment: "FAILED_ASSIGNMENT",
+    FailedUnassignment: "FAILED_UNASSIGNMENT",
+    PendingAssignment: "PENDING_ASSIGNMENT",
+    PendingUnassignment: "PENDING_UNASSIGNMENT",
+};

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

@@ -0,0 +1,55 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Response for get DLC campaign status.
+ */
+export interface DlcCampaignStatus {
+    /**
+     * Summary of errors related to the verification process. <br>
+     *
+     * These errors may request additional information or point out erroneous and/or missing fields.
+     */
+    error: string;
+    /** Id of the DLC campaign. */
+    id: number;
+    /**
+     * Current review status of the DLC 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. See [error](dlc-campaign#response.body.error) for these potential issues.
+     */
+    status: Pinnacle.ProfileStatusEnum;
+    /**
+     * Status of toll free numbers that are being attached to this campaign. <br>
+     *
+     * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
+     */
+    updates: DlcCampaignStatus.Updates;
+}
+export declare namespace DlcCampaignStatus {
+    /**
+     * Status of toll free numbers that are being attached to this campaign. <br>
+     *
+     * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
+     */
+    interface Updates {
+        /** Number associated with the campaign in E.164 format. */
+        number: string;
+        /**
+         * Current assignment status of the phone number to this campaign. <br>
+         *
+         * `ASSIGNED`: Number assigned and ready to send messages.<br>
+         * `PENDING_ASSIGNMENT`: In the process of being assigned. This should take no more than 10 minutes.<br>
+         * `PENDING_UNASSIGNMENT`: In the process of being unassigned. This should take no more that 5 minutes.<br>
+         * `FAILED_ASSIGNMENT`: Failed to assign the number. Use the phone number status endpoint to see errors.<br>
+         * `FAILED_UNASSIGNMENT`: Failed to unassign the number. Use the phone number status endpoint to see errors.
+         */
+        status: Pinnacle.DlcAssignmentStatusEnum;
+        /** List of errors that occurred. */
+        errors: string[];
+    }
+}