ShortCodesClient class

Package:

@azure-tools/communication-short-codes

Constructors

ShortCodesClient(string, KeyCredential, ShortCodesClientOptions)
ShortCodesClient(string, ShortCodesClientOptions)
ShortCodesClient(string, TokenCredential, ShortCodesClientOptions)

Methods

createOrReplaceUSProgramBriefAttachment(string, string, string, FileType, string, AttachmentType, ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams)
deleteUSProgramBrief(string, DeleteUSProgramBriefOptions)
deleteUSProgramBriefAttachment(string, string, ShortCodesDeleteUSProgramBriefAttachmentOptionalParams)
getUSProgramBrief(string, GetUSProgramBriefOptions)
getUSProgramBriefAttachment(string, string, ShortCodesGetUSProgramBriefAttachmentOptionalParams)
listShortCodes(ListShortCodesOptions)
listUSProgramBriefAttachments(string, ShortCodesGetUSProgramBriefAttachmentsOptionalParams)
listUSProgramBriefs(ListUSProgramBriefsOptions)
submitUSProgramBrief(string, SubmitUSProgramBriefOptions)
upsertUSProgramBrief(string, ShortCodesUpsertUSProgramBriefOptionalParams)

Constructor Details

ShortCodesClient(string, KeyCredential, ShortCodesClientOptions)

new ShortCodesClient(endpoint: string, credential: KeyCredential, options?: ShortCodesClientOptions)

Parameters

endpoint

string

credential

KeyCredential

options

ShortCodesClientOptions

ShortCodesClient(string, ShortCodesClientOptions)

new ShortCodesClient(connectionString: string, options?: ShortCodesClientOptions)

Parameters

connectionString

string

options

ShortCodesClientOptions

ShortCodesClient(string, TokenCredential, ShortCodesClientOptions)

new ShortCodesClient(endpoint: string, credential: TokenCredential, options?: ShortCodesClientOptions)

Parameters

endpoint

string

credential

TokenCredential

options

ShortCodesClientOptions

Method Details

createOrReplaceUSProgramBriefAttachment(string, string, string, FileType, string, AttachmentType, ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams)

function createOrReplaceUSProgramBriefAttachment(programBriefId: string, attachmentId: string, fileName: string, fileType: FileType, fileContent: string, attachmentType: AttachmentType, options?: ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>

Parameters

programBriefId

string

attachmentId

string

fileName

string

fileType

FileType

fileContent

string

attachmentType

AttachmentType

options

ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams

Returns

Promise<ProgramBriefAttachment>

deleteUSProgramBrief(string, DeleteUSProgramBriefOptions)

function deleteUSProgramBrief(programBriefId: string, options?: DeleteUSProgramBriefOptions): Promise<void>

Parameters

programBriefId

string

options

DeleteUSProgramBriefOptions

Returns

Promise<void>

deleteUSProgramBriefAttachment(string, string, ShortCodesDeleteUSProgramBriefAttachmentOptionalParams)

function deleteUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesDeleteUSProgramBriefAttachmentOptionalParams): Promise<void>

Parameters

programBriefId

string

attachmentId

string

options

ShortCodesDeleteUSProgramBriefAttachmentOptionalParams

Returns

Promise<void>

getUSProgramBrief(string, GetUSProgramBriefOptions)

function getUSProgramBrief(programBriefId: string, options?: GetUSProgramBriefOptions): Promise<USProgramBrief>

Parameters

programBriefId

string

options

GetUSProgramBriefOptions

Returns

Promise<USProgramBrief>

getUSProgramBriefAttachment(string, string, ShortCodesGetUSProgramBriefAttachmentOptionalParams)

function getUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesGetUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>

Parameters

programBriefId

string

attachmentId

string

options

ShortCodesGetUSProgramBriefAttachmentOptionalParams

Returns

Promise<ProgramBriefAttachment>

listShortCodes(ListShortCodesOptions)

function listShortCodes(options?: ListShortCodesOptions): PagedAsyncIterableIterator<ShortCode, ShortCode[], PageSettings>

Parameters

options

ListShortCodesOptions

Returns

PagedAsyncIterableIterator<ShortCode, ShortCode[], PageSettings>

listUSProgramBriefAttachments(string, ShortCodesGetUSProgramBriefAttachmentsOptionalParams)

function listUSProgramBriefAttachments(programBriefId: string, options?: ShortCodesGetUSProgramBriefAttachmentsOptionalParams): PagedAsyncIterableIterator<ProgramBriefAttachment, ProgramBriefAttachment[], PageSettings>

Parameters

programBriefId

string

options

ShortCodesGetUSProgramBriefAttachmentsOptionalParams

Returns

PagedAsyncIterableIterator<ProgramBriefAttachment, ProgramBriefAttachment[], PageSettings>

listUSProgramBriefs(ListUSProgramBriefsOptions)

function listUSProgramBriefs(options?: ListUSProgramBriefsOptions): PagedAsyncIterableIterator<USProgramBrief, USProgramBrief[], PageSettings>

Parameters

options

ListUSProgramBriefsOptions

Returns

PagedAsyncIterableIterator<USProgramBrief, USProgramBrief[], PageSettings>

submitUSProgramBrief(string, SubmitUSProgramBriefOptions)

function submitUSProgramBrief(programBriefId: string, options?: SubmitUSProgramBriefOptions): Promise<USProgramBrief>

Parameters

programBriefId

string

options

SubmitUSProgramBriefOptions

Returns

Promise<USProgramBrief>

upsertUSProgramBrief(string, ShortCodesUpsertUSProgramBriefOptionalParams)

function upsertUSProgramBrief(programBriefId: string, options?: ShortCodesUpsertUSProgramBriefOptionalParams): Promise<USProgramBrief>

Parameters

programBriefId

string

options

ShortCodesUpsertUSProgramBriefOptionalParams

Returns

Promise<USProgramBrief>