@azure-tools/communication-short-codes 1.0.0-beta.4 → 1.0.0-beta.5

package/{types/communication-short-codes.d.ts → dist/browser/generated/src/models/index.d.ts}

@@ -1,377 +1,422 @@
-/// <reference lib="esnext.asynciterable" />
-
-import { CommonClientOptions } from '@azure/core-client';
-import * as coreClient from '@azure/core-client';
-import { KeyCredential } from '@azure/core-auth';
-import { OperationOptions } from '@azure/core-client';
-import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { TokenCredential } from '@azure/core-auth';
-
-/** Defines values for AttachmentType. */
-export declare type AttachmentType = "callToAction" | "termsOfService" | "privacyPolicy" | "other";
-
-/** Defines values for BillingFrequency. */
-export declare type BillingFrequency = "monthly" | "once";
-
-/** Defines values for CallToActionType. */
-export declare type CallToActionType = "website" | "pointOfSale" | "sms" | "interactiveVoiceResponse";
-
-export declare interface CompanyInformation {
-    /** Legal entity name for customer submitting Program Brief. */
-    name?: string;
-    /** Company URL for customer submitting Program Brief. */
-    url?: string;
-    /** Company's address for the customer submitting the Program Brief. */
-    address?: string;
-    /** Contact Information */
-    contactInformation?: ContactInformation;
-    /** Customer Care Information */
-    customerCareInformation?: CustomerCareInformation;
-}
-
-/** Contact Information */
-export declare interface ContactInformation {
-    /** Name of authorized user for purposes of submitting the Program Brief. */
-    name?: string;
-    /** Contact phone number for the authorized user for the customer. Use E164 format. e.g. +14086111111. */
-    phone?: string;
-    /** Contact email address number for the authorized user for the customer. */
-    email?: string;
-}
-
-/** Customer Care Information */
-export declare interface CustomerCareInformation {
-    /** Customer support phone number for the customer submitting the Program Brief. Use E164 format. e.g. +18005551212 */
-    tollFreeNumber?: string;
-    /** Customer support email address for the customer submitting the Program Brief. */
-    email?: string;
-}
-
-/**
- * Additional options for the delete US Program Brief request.
- */
-export declare interface DeleteUSProgramBriefOptions extends OperationOptions {
-}
-
-/** Defines values for FileType. */
-export declare type FileType = "png" | "jpg" | "jpeg" | "pdf";
-
-/**
- * Additional options for the Get US Program Brief request.
- */
-export declare interface GetUSProgramBriefOptions extends OperationOptions {
-}
-
-/**
- * Additional options for the List Short Codes request.
- */
-export declare interface ListShortCodesOptions extends ShortCodesGetShortCodesOptionalParams {
-}
-
-/**
- * Additional options for the List US Program Brief request.
- */
-export declare interface ListUSProgramBriefsOptions extends OperationOptions {
-}
-
-/** Defines values for MessageContentType. */
-export declare type MessageContentType = "accountNotificationInformationalAlerts" | "ageGatedContent" | "chatConversationalMessaging" | "deliveryNotification" | "donationsPledge" | "education" | "fraudAlerts" | "loanArrangement" | "loyaltyProgram" | "marketingAndPromotion" | "mmsPicture" | "mmsVideo" | "oneTimePasswordOrMultiFactorAuthentication" | "political" | "publicServiceAnnouncements" | "securityAlerts" | "socialMedia" | "sweepstakesOrContest" | "votingOrPolling" | "other";
-
-export declare interface MessageDetails {
-    /** Applicable message protocol used in the program e.g. SMS or MMS. */
-    supportedProtocol?: MessageProtocol;
-    /** Indicates the nature of the messaging associated with the program e.g. 'subscription', 'transaction'. */
-    recurrence?: Recurrence;
-    /**
-     * Message text for mobile terminated message associated with HELP keyword
-     * e.g 'This is the HELP message test.'.
-     */
-    helpAnswerToUser?: string;
-    /**
-     * "Message text for mobile terminated message associated with STOP keyword
-     * e.g. 'This is the STOP message test.'.
-     */
-    optOutAnswerToUser?: string;
-    optInMessageToUser?: string;
-    /** Keyword used to confirm double Opt-In method e.g. 'JOIN'. */
-    optInAnswerFromUser?: string;
-    optInConfirmationMessageToUser?: string;
-    /** Describes directionality e.g. oneWay or twoWay */
-    directionality?: MessageDirectionality;
-    /** Provides message exchange examples from and to end user for each supported message content type. */
-    useCases?: UseCase[];
-}
-
-/** Defines values for MessageDirection. */
-export declare type MessageDirection = "toUser" | "fromUser";
-
-/** Defines values for MessageDirectionality. */
-export declare type MessageDirectionality = "oneWay" | "twoWay";
-
-/** Represents a message example to be sent from or to the end user. */
-export declare interface MessageExample {
-    /** Indicates whether the message example is supposed to be sent to or from the end user e.g. toUser */
-    direction?: MessageDirection;
-    /** Actual example text for the message e.g. 'Want me to notify you when package in the way?' */
-    text?: string;
-}
-
-/** A sequence of example messages to and from the end user. */
-export declare interface MessageExampleSequence {
-    /** Example messages to be sent to and from the end user. */
-    messages?: MessageExample[];
-}
-
-/** Defines values for MessageProtocol. */
-export declare type MessageProtocol = "sms" | "mms";
-
-/** Defines values for NumberType. */
-export declare type NumberType = "shortCode" | "alphaId";
-
-/** A File Attachment for a Program Brief */
-export declare interface ProgramBriefAttachment {
-    /** Program Brief Attachment Id. */
-    id: string;
-    /**
-     * Attachment type describing the purpose of the attachment
-     * e.g. 'callToAction', 'termsOfService'
-     */
-    type: AttachmentType;
-    /**
-     * The name of the file being attached
-     * e.g. 'myFile01'
-     */
-    fileName: string;
-    /** File size in bytes. */
-    fileSizeInBytes?: number;
-    /**
-     * The type of file being attached
-     * e.g. 'pdf', 'jpg', 'png'
-     */
-    fileType: FileType;
-    /** File content as base 64 encoded string */
-    fileContentBase64: string;
-}
-
-/** A summary of Program Brief File Attachment data */
-export declare interface ProgramBriefAttachmentSummary {
-    /** Program Brief Attachment Id. */
-    id?: string;
-    /**
-     * Attachment type describing the purpose of the attachment
-     * e.g. 'callToAction', 'termsOfService'
-     */
-    type?: AttachmentType;
-    /**
-     * The name of the attached file
-     * e.g. 'myFile01'
-     */
-    fileName?: string;
-}
-
-/** Defines values for ProgramBriefStatus. */
-export declare type ProgramBriefStatus = "submitted" | "approved" | "submitNewVanityNumbers" | "updateProgramBrief" | "draft" | "denied";
-
-export declare interface ProgramDetails {
-    /** Set to true if the request is for a vanity number. */
-    isVanity?: boolean;
-    /**
-     * Priority ordered list of preferred vanity numbers.
-     * Vanity numbers should be 5 or 6 digit when number type is ShortCode.
-     * e.g. 555555, 222222.
-     */
-    preferredVanityNumbers?: string[];
-    /** Type for desired numbers e.g. 'shortCode' or 'alphaId'. */
-    numberType?: NumberType;
-    /** Indicates whether the number will be used for political campaigns or not. */
-    isPoliticalCampaign?: boolean;
-    /**
-     * A program name that indicates the purpose of filling the Program Brief and how the number will be used for messaging.
-     * e.g. 'CONTOSO Shipping'
-     */
-    name?: string;
-    /** Describes how and why the number will be used for messaging as part of the program. */
-    description?: string;
-    /** URL for the program or company. */
-    url?: string;
-    /** Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'. */
-    callToActionTypes?: CallToActionType[];
-    /** URL for "call to action" image for the program. */
-    callToActionUrl?: string;
-    /** Call to action text. To be provided when InteractiveVoiceResponse is specified as call to action type */
-    callToAction?: string;
-    /** URL for program terms of service. */
-    termsOfServiceUrl?: string;
-    /** URL for privacy policy. */
-    privacyPolicyUrl?: string;
-    /**
-     * Date in which SMS messages will start to be sent out.
-     * Should follow ISO 8601 internet format for datetimes.
-     * e.g. 2021-08-17T22:02:51.316Z, 2021-08-17T16:39:57-08:00, etc.
-     */
-    expectedDateOfService?: Date;
-}
-
-/** Defines values for Recurrence. */
-export declare type Recurrence = "subscription" | "transaction";
-
-/** Holds a note about a Program Brief that has gone thru stages of review process. */
-export declare interface ReviewNote {
-    /** Note related to a Program Brief that may imply changes needed from the client. */
-    message?: string;
-    /** Date and time when the note was added to the Program Brief. */
-    date?: Date;
-}
-
-/** Represents a number, ShortCode or AlphaId, acquired in a given country. */
-export declare interface ShortCode {
-    /** The value of the ShortCode or the alpha numeric e.g. '555555', 'CONTOSO', etc. */
-    number?: string;
-    /** The type of number e.g. 'ShortCode', 'AlphaId'. */
-    numberType?: NumberType;
-    /** ISO 3166 2-char code representing the country e.g. 'US'. */
-    countryCode?: string;
-    /** Program Brief Name. */
-    programBriefIds?: string[];
-    /** Date in which number was purchased. */
-    purchaseDate?: Date;
-}
-
-/** The incurred cost for a single short code. */
-export declare interface ShortCodeCost {
-    /** The cost amount. */
-    amount: number;
-    /** The ISO 4217 currency code for the cost amount, e.g. USD. */
-    currencyCode: string;
-    /** The frequency with which the cost gets billed. */
-    billingFrequency: BillingFrequency;
-}
-
-export declare class ShortCodesClient {
-    /**
-     * A reference to the auto-generated ShortCodes HTTP client.
-     */
-    private readonly client;
-    constructor(connectionString: string, options?: ShortCodesClientOptions);
-    constructor(endpoint: string, credential: KeyCredential, options?: ShortCodesClientOptions);
-    constructor(endpoint: string, credential: TokenCredential, options?: ShortCodesClientOptions);
-    listShortCodes(options?: ListShortCodesOptions): PagedAsyncIterableIterator<ShortCode>;
-    upsertUSProgramBrief(programBriefId: string, options?: ShortCodesUpsertUSProgramBriefOptionalParams): Promise<USProgramBrief>;
-    deleteUSProgramBrief(programBriefId: string, options?: DeleteUSProgramBriefOptions): Promise<void>;
-    getUSProgramBrief(programBriefId: string, options?: GetUSProgramBriefOptions): Promise<USProgramBrief>;
-    listUSProgramBriefs(options?: ListUSProgramBriefsOptions): PagedAsyncIterableIterator<USProgramBrief>;
-    submitUSProgramBrief(programBriefId: string, options?: SubmitUSProgramBriefOptions): Promise<USProgramBrief>;
-    getUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesGetUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>;
-    listUSProgramBriefAttachments(programBriefId: string, options?: ShortCodesGetUSProgramBriefAttachmentsOptionalParams): PagedAsyncIterableIterator<ProgramBriefAttachment>;
-    deleteUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesDeleteUSProgramBriefAttachmentOptionalParams): Promise<void>;
-    createOrReplaceUSProgramBriefAttachment(programBriefId: string, attachmentId: string, fileName: string, fileType: FileType, fileContent: string, attachmentType: AttachmentType, options?: ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>;
-}
-
-/**
- * Client options used to configure the ShortCodesClient API requests.
- */
-export declare interface ShortCodesClientOptions extends CommonClientOptions {
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-    /** File size in bytes. */
-    fileSizeInBytes?: number;
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesDeleteUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesGetShortCodesOptionalParams extends coreClient.OperationOptions {
-    /** An optional parameter for how many entries to skip, for pagination purposes. */
-    skip?: number;
-    /** An optional parameter for how many entries to return, for pagination purposes. */
-    top?: number;
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesGetUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesGetUSProgramBriefAttachmentsOptionalParams extends coreClient.OperationOptions {
-    /** An optional parameter for how many entries to skip, for pagination purposes. */
-    skip?: number;
-    /** An optional parameter for how many entries to return, for pagination purposes. */
-    top?: number;
-}
-
-/** Optional parameters. */
-export declare interface ShortCodesUpsertUSProgramBriefOptionalParams extends coreClient.OperationOptions {
-    /** Data to create new a Program Brief or fields to update an existing Program Brief */
-    body?: USProgramBrief;
-}
-
-/**
- * Additional options for the Submit US Program Brief request.
- */
-export declare interface SubmitUSProgramBriefOptions extends OperationOptions {
-}
-
-export declare interface TrafficDetails {
-    /** Estimated total messages per month. */
-    totalMonthlyVolume?: number;
-    /** Estimated number of Mobile-Originated messages likely to be received from a user per month. */
-    monthlyAverageMessagesFromUser?: number;
-    /** Estimated number of Mobile-Terminated messages likely to be sent per user per month. */
-    monthlyAverageMessagesToUser?: number;
-    /** Indicates if the nature of the messaging traffic will be bursty. */
-    isSpiky?: boolean;
-    /**
-     * If isSpiky=true, then explain additional details about the traffic pattern
-     * e.g. 'Higher traffic expected during holiday season and Black Friday.'.
-     */
-    spikeDetails?: string;
-    /** Numbers of days in which is expected to start sending messages from the short code. */
-    estimatedRampUpTimeInDays?: number;
-}
-
-/** Describes a messaging use case for a given content type by providing example messages. */
-export declare interface UseCase {
-    /** Indicates the messaging content type used in the program e.g. 'accountNotificationInformationalAlerts', 'chatConversationalMessaging', 'mmsVideo', 'socialMedia'. */
-    contentType?: MessageContentType;
-    /** Indicates the messaging content type used in the program whenever it is not any of the pre-defined content types */
-    customContentType?: string;
-    /** Example messages to be sent to and from the end user for the indicated content type. */
-    examples?: MessageExampleSequence[];
-}
-
-/**
- * Represents a US Program Brief for acquiring a short code in the United States.
- * A Program Brief provides vital information to the carriers about a messaging program or campaign that would be associated with a short code or alpha sender number.
- * A Program Brief also provides specifics about the use case, the purpose and the consumer experience receiving the message.
- */
-export declare interface USProgramBrief {
-    /** Program Brief Id. */
-    id: string;
-    /** Program Brief status e.g. 'submitted', 'approved', etc */
-    status?: ProgramBriefStatus;
-    /** Number provisioned for the Program Brief e.g. 555555, 'CONTOSO' */
-    number?: string;
-    /**
-     * Notes added to the Program Brief after being reviewed to help customer understand
-     * review results and necessary follow up actions.
-     */
-    reviewNotes?: ReviewNote[];
-    /** Represents the costs tied to the number. */
-    costs?: ShortCodeCost[];
-    /** Date and time when the Program Brief was submitted. */
-    submissionDate?: Date;
-    /** Last date and time when the Program Brief status was updated. */
-    statusUpdatedDate?: Date;
-    programDetails?: ProgramDetails;
-    companyInformation?: CompanyInformation;
-    messageDetails?: MessageDetails;
-    trafficDetails?: TrafficDetails;
-    /** A list of summarized data of attachments currently added to the Program Brief */
-    attachments?: ProgramBriefAttachmentSummary[];
-}
-
-export { }
+import * as coreClient from "@azure/core-client";
+/** A wrapper for a list of short code entities. */
+export interface AcquiredShortCodes {
+    /** List of short codes. */
+    shortCodes?: ShortCode[];
+    /** Represents the URL link to the next page. */
+    nextLink?: string;
+}
+/** Represents a ShortCode acquired in a given country. */
+export interface ShortCode {
+    /** The value of the ShortCode e.g. '555555'. */
+    value?: string;
+    /** ISO 3166 2-char code representing the country e.g. 'US'. */
+    countryCode?: string;
+    /** Program Brief Name. */
+    programBriefIds?: string[];
+    /** Date in which number was purchased. */
+    purchaseDate?: Date;
+}
+/** The Communication Services error. */
+export interface CommunicationErrorResponse {
+    /** The Communication Services error. */
+    error: CommunicationError;
+}
+/** The Communication Services error. */
+export interface CommunicationError {
+    /** The error code. */
+    code: string;
+    /** The error message. */
+    message: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * Further details about specific errors that led to this error.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: CommunicationError[];
+    /**
+     * The inner error if any.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly innerError?: CommunicationError;
+}
+/** A wrapper for a list of short code costs entities. */
+export interface ShortCodeCosts {
+    /** List of short code costs. */
+    costs?: ShortCodeCost[];
+    /** Represents the URL link to the next page of short code results. */
+    nextLink?: string;
+}
+/** The incurred cost for a single short code. */
+export interface ShortCodeCost {
+    /** The cost amount. */
+    amount?: number;
+    /** The ISO 4217 currency code for the cost amount, e.g. USD. */
+    currencyCode?: string;
+    /** The ISO 3166-2 code of the phone number's country, e.g. US. */
+    countryCode?: string;
+    /** Indicate whether a shortcode is vanity. */
+    isVanityShortCode?: boolean;
+    /** The frequency with which the cost gets billed. */
+    billingFrequency?: BillingFrequency;
+}
+/**
+ * Represents a US Program Brief for acquiring a short code in the United States.
+ * A Program Brief provides vital information to the carriers about a messaging program or campaign that would be associated with a short code or alpha sender number.
+ * A Program Brief also provides specifics about the use case, the purpose and the consumer experience receiving the message.
+ */
+export interface USProgramBrief {
+    /** Program Brief Id. */
+    id: string;
+    /** Program Brief status e.g. 'submitted', 'approved', etc */
+    status?: ProgramBriefStatus;
+    /** Number provisioned for the Program Brief e.g. 555555, 'CONTOSO' */
+    number?: string;
+    /**
+     * Notes added to the Program Brief after being reviewed to help customer understand
+     * review results and necessary follow up actions.
+     */
+    reviewNotes?: ReviewNote[];
+    /** Represents the costs tied to the number. */
+    costs?: ShortCodeCost[];
+    /** Date and time when the Program Brief was submitted. */
+    submissionDate?: Date;
+    /** Last date and time when the Program Brief status was updated. */
+    statusUpdatedDate?: Date;
+    programDetails?: ProgramDetails;
+    companyInformation?: CompanyInformation;
+    messageDetails?: MessageDetails;
+    trafficDetails?: TrafficDetails;
+    /** A list of summarized data of attachments currently added to the Program Brief */
+    attachments?: ProgramBriefAttachmentSummary[];
+}
+/** Holds a note about a Program Brief that has gone thru stages of review process. */
+export interface ReviewNote {
+    /** Note related to a Program Brief that may imply changes needed from the client. */
+    message?: string;
+    /** Date and time when the note was added to the Program Brief. */
+    date?: Date;
+}
+export interface ProgramDetails {
+    /** Set to true if the request is for a vanity number. */
+    isVanity?: boolean;
+    /**
+     * Priority ordered list of preferred vanity numbers.
+     * Vanity numbers should be 5 or 6 digit when number type is ShortCode.
+     * e.g. 555555, 222222.
+     */
+    preferredVanityNumbers?: string[];
+    /** Type for desired numbers e.g. 'shortCode' or 'alphaId'. */
+    numberType?: NumberType;
+    /** Indicates whether the number will be used for political campaigns or not. */
+    isPoliticalCampaign?: boolean;
+    /**
+     * A program name that indicates the purpose of filling the Program Brief and how the number will be used for messaging.
+     * e.g. 'CONTOSO Shipping'
+     */
+    name?: string;
+    /** Describes how and why the number will be used for messaging as part of the program. */
+    description?: string;
+    /** URL for the program or company. */
+    url?: string;
+    /** Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'. */
+    callToActionTypes?: CallToActionType[];
+    /** URL for "call to action" image for the program. */
+    callToActionUrl?: string;
+    /** Call to action text. To be provided when InteractiveVoiceResponse is specified as call to action type */
+    callToAction?: string;
+    /** URL for program terms of service. */
+    termsOfServiceUrl?: string;
+    /** URL for privacy policy. */
+    privacyPolicyUrl?: string;
+    /**
+     * Date in which SMS messages will start to be sent out.
+     * Should follow ISO 8601 internet format for datetimes.
+     * e.g. 2021-08-17T22:02:51.316Z, 2021-08-17T16:39:57-08:00, etc.
+     */
+    expectedDateOfService?: Date;
+}
+export interface CompanyInformation {
+    /** Legal entity name for customer submitting Program Brief. */
+    name?: string;
+    /** Company URL for customer submitting Program Brief. */
+    url?: string;
+    /** Company's address for the customer submitting the Program Brief. */
+    address?: string;
+    /** Contact Information */
+    contactInformation?: ContactInformation;
+    /** Customer Care Information */
+    customerCareInformation?: CustomerCareInformation;
+}
+/** Contact Information */
+export interface ContactInformation {
+    /** Name of authorized user for purposes of submitting the Program Brief. */
+    name?: string;
+    /** Contact phone number for the authorized user for the customer. Use E164 format. e.g. +14086111111. */
+    phone?: string;
+    /** Contact email address number for the authorized user for the customer. */
+    email?: string;
+}
+/** Customer Care Information */
+export interface CustomerCareInformation {
+    /** Customer support phone number for the customer submitting the Program Brief. Use E164 format. e.g. +18005551212 */
+    tollFreeNumber?: string;
+    /** Customer support email address for the customer submitting the Program Brief. */
+    email?: string;
+}
+export interface MessageDetails {
+    /** Applicable message protocol used in the program e.g. SMS or MMS. */
+    supportedProtocol?: MessageProtocol;
+    /** Indicates the nature of the messaging associated with the program e.g. 'subscription', 'transaction'. */
+    recurrence?: Recurrence;
+    /**
+     * Message text for mobile terminated message associated with HELP keyword
+     * e.g 'This is the HELP message test.'.
+     */
+    helpAnswerToUser?: string;
+    /**
+     * "Message text for mobile terminated message associated with STOP keyword
+     * e.g. 'This is the STOP message test.'.
+     */
+    optOutAnswerToUser?: string;
+    optInMessageToUser?: string;
+    /** Keyword used to confirm double Opt-In method e.g. 'JOIN'. */
+    optInAnswerFromUser?: string;
+    optInConfirmationMessageToUser?: string;
+    /** Describes directionality e.g. oneWay or twoWay */
+    directionality?: MessageDirectionality;
+    /** Provides message exchange examples from and to end user for each supported message content type. */
+    useCases?: UseCase[];
+}
+/** Describes a messaging use case for a given content type by providing example messages. */
+export interface UseCase {
+    /** Indicates the messaging content type used in the program e.g. 'accountNotificationInformationalAlerts', 'chatConversationalMessaging', 'mmsVideo', 'socialMedia'. */
+    contentType?: MessageContentType;
+    /** Indicates the messaging content type used in the program whenever it is not any of the pre-defined content types */
+    customContentType?: string;
+    /** Example messages to be sent to and from the end user for the indicated content type. */
+    examples?: MessageExampleSequence[];
+}
+/** A sequence of example messages to and from the end user. */
+export interface MessageExampleSequence {
+    /** Example messages to be sent to and from the end user. */
+    messages?: MessageExample[];
+}
+/** Represents a message example to be sent from or to the end user. */
+export interface MessageExample {
+    /** Indicates whether the message example is supposed to be sent to or from the end user e.g. toUser */
+    direction?: MessageDirection;
+    /** Actual example text for the message e.g. 'Want me to notify you when package in the way?' */
+    text?: string;
+}
+export interface TrafficDetails {
+    /** Estimated total messages per month. */
+    totalMonthlyVolume?: number;
+    /** Estimated number of Mobile-Originated messages likely to be received from a user per month. */
+    monthlyAverageMessagesFromUser?: number;
+    /** Estimated number of Mobile-Terminated messages likely to be sent per user per month. */
+    monthlyAverageMessagesToUser?: number;
+    /** Indicates if the nature of the messaging traffic will be bursty. */
+    isSpiky?: boolean;
+    /**
+     * If isSpiky=true, then explain additional details about the traffic pattern
+     * e.g. 'Higher traffic expected during holiday season and Black Friday.'.
+     */
+    spikeDetails?: string;
+    /** Numbers of days in which is expected to start sending messages from the short code. */
+    estimatedRampUpTimeInDays?: number;
+}
+/** A summary of Program Brief File Attachment data */
+export interface ProgramBriefAttachmentSummary {
+    /** Program Brief Attachment Id. */
+    id?: string;
+    /**
+     * Attachment type describing the purpose of the attachment
+     * e.g. 'callToAction', 'termsOfService'
+     */
+    type?: AttachmentType;
+    /**
+     * The name of the attached file
+     * e.g. 'myFile01'
+     */
+    fileName?: string;
+}
+/** A wrapper for a list of USProgramBrief entities. */
+export interface USProgramBriefs {
+    /** List of Program Briefs. */
+    programBriefs?: USProgramBrief[];
+    /** Represents the URL link to the next page. */
+    nextLink?: string;
+}
+/** A File Attachment for a Program Brief */
+export interface ProgramBriefAttachment {
+    /** Program Brief Attachment Id. */
+    id: string;
+    /**
+     * Attachment type describing the purpose of the attachment
+     * e.g. 'callToAction', 'termsOfService'
+     */
+    type: AttachmentType;
+    /**
+     * The name of the file being attached
+     * e.g. 'myFile01'
+     */
+    fileName: string;
+    /** File size in bytes. */
+    fileSizeInBytes?: number;
+    /**
+     * The type of file being attached
+     * e.g. 'pdf', 'jpg', 'png'
+     */
+    fileType: FileType;
+    /** File content as base 64 encoded string */
+    fileContentBase64: string;
+}
+/** A wrapper for a list of ProgramBriefAttachment entities. */
+export interface ProgramBriefAttachments {
+    /** List of Program Brief attachments. */
+    attachments?: ProgramBriefAttachment[];
+    /** Represents the URL link to the next page. */
+    nextLink?: string;
+}
+/** Defines values for BillingFrequency. */
+export type BillingFrequency = "monthly" | "once";
+/** Defines values for ProgramBriefStatus. */
+export type ProgramBriefStatus = "submitted" | "approved" | "submitNewVanityNumbers" | "updateProgramBrief" | "draft" | "denied";
+/** Defines values for NumberType. */
+export type NumberType = "shortCode" | "alphaId";
+/** Defines values for CallToActionType. */
+export type CallToActionType = "website" | "pointOfSale" | "sms" | "interactiveVoiceResponse";
+/** Defines values for MessageProtocol. */
+export type MessageProtocol = "sms" | "mms";
+/** Defines values for Recurrence. */
+export type Recurrence = "subscription" | "transaction";
+/** Defines values for MessageDirectionality. */
+export type MessageDirectionality = "oneWay" | "twoWay";
+/** Defines values for MessageContentType. */
+export type MessageContentType = "accountNotificationInformationalAlerts" | "ageGatedContent" | "chatConversationalMessaging" | "deliveryNotification" | "donationsPledge" | "education" | "fraudAlerts" | "loanArrangement" | "loyaltyProgram" | "marketingAndPromotion" | "mmsPicture" | "mmsVideo" | "oneTimePasswordOrMultiFactorAuthentication" | "political" | "publicServiceAnnouncements" | "securityAlerts" | "socialMedia" | "sweepstakesOrContest" | "votingOrPolling" | "other";
+/** Defines values for MessageDirection. */
+export type MessageDirection = "toUser" | "fromUser";
+/** Defines values for AttachmentType. */
+export type AttachmentType = "callToAction" | "termsOfService" | "privacyPolicy" | "other";
+/** Defines values for FileType. */
+export type FileType = "png" | "jpg" | "jpeg" | "pdf";
+/** Optional parameters. */
+export interface ShortCodesGetShortCodesOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getShortCodes operation. */
+export type ShortCodesGetShortCodesResponse = AcquiredShortCodes;
+/** Optional parameters. */
+export interface ShortCodesGetCostsOptionalParams extends coreClient.OperationOptions {
+    /** The number of items to skip in the result set (default: 0). */
+    skip?: number;
+    /** The maximum number of items to return in the result set (default: 100). */
+    top?: number;
+}
+/** Contains response data for the getCosts operation. */
+export type ShortCodesGetCostsResponse = ShortCodeCosts;
+/** Optional parameters. */
+export interface ShortCodesUpsertUSProgramBriefOptionalParams extends coreClient.OperationOptions {
+    /** Data to create new a Program Brief or fields to update an existing Program Brief */
+    body?: USProgramBrief;
+}
+/** Contains response data for the upsertUSProgramBrief operation. */
+export type ShortCodesUpsertUSProgramBriefResponse = USProgramBrief;
+/** Optional parameters. */
+export interface ShortCodesDeleteUSProgramBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getUSProgramBrief operation. */
+export type ShortCodesGetUSProgramBriefResponse = USProgramBrief;
+/** Optional parameters. */
+export interface ShortCodesSubmitUSProgramBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the submitUSProgramBrief operation. */
+export type ShortCodesSubmitUSProgramBriefResponse = USProgramBrief;
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefsOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getUSProgramBriefs operation. */
+export type ShortCodesGetUSProgramBriefsResponse = USProgramBriefs;
+/** Optional parameters. */
+export interface ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+    /** File size in bytes. */
+    fileSizeInBytes?: number;
+}
+/** Contains response data for the createOrReplaceUSProgramBriefAttachment operation. */
+export type ShortCodesCreateOrReplaceUSProgramBriefAttachmentResponse = ProgramBriefAttachment;
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getUSProgramBriefAttachment operation. */
+export type ShortCodesGetUSProgramBriefAttachmentResponse = ProgramBriefAttachment;
+/** Optional parameters. */
+export interface ShortCodesDeleteUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefAttachmentsOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getUSProgramBriefAttachments operation. */
+export type ShortCodesGetUSProgramBriefAttachmentsResponse = ProgramBriefAttachments;
+/** Optional parameters. */
+export interface ShortCodesGetShortCodesNextOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getShortCodesNext operation. */
+export type ShortCodesGetShortCodesNextResponse = AcquiredShortCodes;
+/** Optional parameters. */
+export interface ShortCodesGetCostsNextOptionalParams extends coreClient.OperationOptions {
+    /** The number of items to skip in the result set (default: 0). */
+    skip?: number;
+    /** The maximum number of items to return in the result set (default: 100). */
+    top?: number;
+}
+/** Contains response data for the getCostsNext operation. */
+export type ShortCodesGetCostsNextResponse = ShortCodeCosts;
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefsNextOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getUSProgramBriefsNext operation. */
+export type ShortCodesGetUSProgramBriefsNextResponse = USProgramBriefs;
+/** Optional parameters. */
+export interface ShortCodesGetUSProgramBriefAttachmentsNextOptionalParams extends coreClient.OperationOptions {
+    /** An optional parameter for how many entries to skip, for pagination purposes. */
+    skip?: number;
+    /** An optional parameter for how many entries to return, for pagination purposes. */
+    top?: number;
+}
+/** Contains response data for the getUSProgramBriefAttachmentsNext operation. */
+export type ShortCodesGetUSProgramBriefAttachmentsNextResponse = ProgramBriefAttachments;
+/** Optional parameters. */
+export interface ShortCodesClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+//# sourceMappingURL=index.d.ts.map