Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-sms

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

SmsSendResponse

SmsSendResponse: SendSmsResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SendSmsResponse } }

Contains response data for the send operation.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.3"

Const logger

logger: any = createClientLogger("communication-sms")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-communication-sms" = "azure-communication-sms"

Const packageVersion

packageVersion: "1.0.0-beta.3" = "1.0.0-beta.3"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers)

Functions

Const extractOperationOptions

  • extractOperationOptions<T>(obj: T): { operationOptions: OperationOptions; restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>> }

  • Type parameters

    • T: OperationOptions

    Parameters

    • obj: T

    Returns { operationOptions: OperationOptions; restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>> }

    • operationOptions: OperationOptions
    • restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>>

Const isSmsClientOptions

  • isSmsClientOptions(options: any): options is SmsClientOptions

  • Checks whether the type of a value is SmsClientOptions or not.

    Parameters

    • options: any

      The value being checked.

    Returns options is SmsClientOptions

Object literals

Const SendMessageRequest

SendMessageRequest: object

serializedName

serializedName: string = "SendMessageRequest"

type

type: object

className

className: string = "SendMessageRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

from

from: object

required

required: boolean = true

serializedName

serializedName: string = "from"

type

type: object

name

name: string = "String"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

sendSmsOptions

sendSmsOptions: object

serializedName

serializedName: string = "sendSmsOptions"

type

type: object

className

className: string = "SendSmsOptions"

name

name: string = "Composite"

to

to: object

required

required: boolean = true

serializedName

serializedName: string = "to"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const SendSmsOptions

SendSmsOptions: object

serializedName

serializedName: string = "SendSmsOptions"

type

type: object

className

className: string = "SendSmsOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

enableDeliveryReport

enableDeliveryReport: object

serializedName

serializedName: string = "enableDeliveryReport"

type

type: object

name

name: string = "Boolean"

Const SendSmsResponse

SendSmsResponse: object

serializedName

serializedName: string = "SendSmsResponse"

type

type: object

className

className: string = "SendSmsResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

messageId

messageId: object

serializedName

serializedName: string = "messageId"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-07-20-preview1"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const sendOperationSpec

sendOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "sms"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

requestBody

requestBody: object

parameterPath

parameterPath: string = "sendMessageRequest"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.SendSmsResponse

Generated using TypeDoc