Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/mixed-reality-remote-rendering

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AssetConversion

AssetConversion: NonStartedAssetConversion | RunningAssetConversion | SucceededAssetConversion | FailedAssetConversion | CancelledAssetConversion

A type representing the various states of a conversion. This is a tagged union with "status" as its discriminant property.

AssetConversionPollerLike

AssetConversionPollerLike: PollerLike<AssetConversionOperationState, AssetConversion>

The poller returned by the beginConversion operation.

AssetConversionStatus

AssetConversionStatus: string

Defines values for AssetConversionStatus.
KnownAssetConversionStatus can be used interchangeably with AssetConversionStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: The conversion was created but hasn't started.
Running: The conversion is running.
Cancelled: The conversion was cancelled. This is a terminal state.
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state.
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state.

BeginConversionOptions

BeginConversionOptions: AssetConversionPollerOptions & OperationOptions

Options to configure the beginConversion operation.

BeginSessionOptions

BeginSessionOptions: RenderingSessionPollerOptions & OperationOptions

Options to configure the beginSession operation.

EndSessionOptions

EndSessionOptions: OperationOptions

Options to configure the endSession operation.

GetConversionOptions

GetConversionOptions: OperationOptions

Options to configure the getConversion operation.

GetSessionOptions

GetSessionOptions: OperationOptions

Options to configure the getSession operation.

ListConversionsOptions

ListConversionsOptions: OperationOptions

Options to configure the listConversions operation.

ListSessionsOptions

ListSessionsOptions: OperationOptions

Options to configure the listSessions operation.

RemoteRenderingCreateConversionResponse

RemoteRenderingCreateConversionResponse: RemoteRenderingCreateConversionHeaders & Conversion

Contains response data for the createConversion operation.

RemoteRenderingCreateSessionResponse

RemoteRenderingCreateSessionResponse: SessionProperties

Contains response data for the createSession operation.

RemoteRenderingGetConversionResponse

RemoteRenderingGetConversionResponse: RemoteRenderingGetConversionHeaders & Conversion

Contains response data for the getConversion operation.

RemoteRenderingGetSessionResponse

RemoteRenderingGetSessionResponse: SessionProperties

Contains response data for the getSession operation.

RemoteRenderingListConversionsNextResponse

RemoteRenderingListConversionsNextResponse: RemoteRenderingListConversionsNextHeaders & ConversionList

Contains response data for the listConversionsNext operation.

RemoteRenderingListConversionsResponse

RemoteRenderingListConversionsResponse: RemoteRenderingListConversionsHeaders & ConversionList

Contains response data for the listConversions operation.

RemoteRenderingListSessionsNextResponse

RemoteRenderingListSessionsNextResponse: SessionsList

Contains response data for the listSessionsNext operation.

RemoteRenderingListSessionsResponse

RemoteRenderingListSessionsResponse: SessionsList

Contains response data for the listSessions operation.

RemoteRenderingStopSessionResponse

RemoteRenderingStopSessionResponse: RemoteRenderingStopSessionHeaders

Contains response data for the stopSession operation.

RemoteRenderingUpdateSessionResponse

RemoteRenderingUpdateSessionResponse: SessionProperties

Contains response data for the updateSession operation.

RenderingServerSize

RenderingServerSize: string

Defines values for RenderingServerSize.
KnownRenderingServerSize can be used interchangeably with RenderingServerSize, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard rendering session size.
Premium: Premium rendering session size.

RenderingSession

RenderingSession: StartingRenderingSession | ReadyRenderingSession | ErrorRenderingSession | ExpiredRenderingSession | StoppedRenderingSession

Information about a rendering session. This is a tagged union with "status" as its discriminant property.

RenderingSessionPollerLike

RenderingSessionPollerLike: PollerLike<RenderingSessionOperationState, RenderingSession>

The poller returned by the beginSession operation.

RenderingSessionStatus

RenderingSessionStatus: string

Defines values for RenderingSessionStatus.
KnownRenderingSessionStatus can be used interchangeably with RenderingSessionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The rendering session has encountered an error, and is unusable. This is a terminal state.
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state.
Starting: The rendering session is starting, but not accepting incoming connections yet.
Ready: The rendering session is ready for incoming connections.
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state.

ResumeBeginConversionOptions

ResumeBeginConversionOptions: BeginConversionOptions & { resumeFrom: string }

Options for resuming a pre-existing conversion operation.

ResumeBeginSessionOptions

ResumeBeginSessionOptions: BeginSessionOptions & { resumeFrom: string }

Options for resuming a pre-existing session operation.

UpdateSessionOptions

UpdateSessionOptions: OperationOptions

Options to configure the updateSession operation.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.1"

Const maxTimestampMs

maxTimestampMs: 8640000000000000 = 8640000000000000

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

createRemoteRenderingServiceError

Object literals

Const AssetConversionInputSettings

AssetConversionInputSettings: object

type

type: object

className

className: string = "AssetConversionInputSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

blobPrefix

blobPrefix: object

serializedName

serializedName: string = "blobPrefix"

type

type: object

name

name: string = "String"

relativeInputAssetPath

relativeInputAssetPath: object

required

required: boolean = true

serializedName

serializedName: string = "relativeInputAssetPath"

type

type: object

name

name: string = "String"

storageContainerReadListSas

storageContainerReadListSas: object

serializedName

serializedName: string = "storageContainerReadListSas"

type

type: object

name

name: string = "String"

storageContainerUrl

storageContainerUrl: object

required

required: boolean = true

serializedName

serializedName: string = "storageContainerUri"

type

type: object

name

name: string = "String"

Const AssetConversionOutput

AssetConversionOutput: object

type

type: object

className

className: string = "AssetConversionOutput"

name

name: string = "Composite"

modelProperties

modelProperties: object

outputAssetUrl

outputAssetUrl: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "outputAssetUri"

type

type: object

name

name: string = "String"

Const AssetConversionOutputSettings

AssetConversionOutputSettings: object

type

type: object

className

className: string = "AssetConversionOutputSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

blobPrefix

blobPrefix: object

serializedName

serializedName: string = "blobPrefix"

type

type: object

name

name: string = "String"

outputAssetFilename

outputAssetFilename: object

serializedName

serializedName: string = "outputAssetFilename"

type

type: object

name

name: string = "String"

storageContainerUrl

storageContainerUrl: object

required

required: boolean = true

serializedName

serializedName: string = "storageContainerUri"

type

type: object

name

name: string = "String"

storageContainerWriteSas

storageContainerWriteSas: object

serializedName

serializedName: string = "storageContainerWriteSas"

type

type: object

name

name: string = "String"

Const AssetConversionSettings

AssetConversionSettings: object

type

type: object

className

className: string = "AssetConversionSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

inputSettings

inputSettings: object

serializedName

serializedName: string = "inputLocation"

type

type: object

className

className: string = "AssetConversionInputSettings"

name

name: string = "Composite"

outputSettings

outputSettings: object

serializedName

serializedName: string = "outputLocation"

type

type: object

className

className: string = "AssetConversionOutputSettings"

name

name: string = "Composite"

Const Conversion

Conversion: object

type

type: object

className

className: string = "Conversion"

name

name: string = "Composite"

modelProperties

modelProperties: object

conversionId

conversionId: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: string = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

output

output: object

serializedName

serializedName: string = "output"

type

type: object

className

className: string = "AssetConversionOutput"

name

name: string = "Composite"

settings

settings: object

serializedName

serializedName: string = "settings"

type

type: object

className

className: string = "AssetConversionSettings"

name

name: string = "Composite"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const ConversionList

ConversionList: object

type

type: object

className

className: string = "ConversionList"

name

name: string = "Composite"

modelProperties

modelProperties: object

conversions

conversions: object

required

required: boolean = true

serializedName

serializedName: string = "conversions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Conversion"

name

name: string = "Composite"

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

Const CreateConversionSettings

CreateConversionSettings: object

type

type: object

className

className: string = "CreateConversionSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

settings

settings: object

serializedName

serializedName: string = "settings"

type

type: object

className

className: string = "AssetConversionSettings"

name

name: string = "Composite"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

Const RemoteRenderingCreateConversionExceptionHeaders

RemoteRenderingCreateConversionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingCreateConversionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingCreateConversionHeaders

RemoteRenderingCreateConversionHeaders: object

type

type: object

className

className: string = "RemoteRenderingCreateConversionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingCreateSessionExceptionHeaders

RemoteRenderingCreateSessionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingCreateSessionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingCreateSessionHeaders

RemoteRenderingCreateSessionHeaders: object

type

type: object

className

className: string = "RemoteRenderingCreateSessionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingGetConversionExceptionHeaders

RemoteRenderingGetConversionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingGetConversionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingGetConversionHeaders

RemoteRenderingGetConversionHeaders: object

type

type: object

className

className: string = "RemoteRenderingGetConversionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "Number"

Const RemoteRenderingGetSessionExceptionHeaders

RemoteRenderingGetSessionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingGetSessionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingListConversionsExceptionHeaders

RemoteRenderingListConversionsExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingListConversionsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingListConversionsHeaders

RemoteRenderingListConversionsHeaders: object

type

type: object

className

className: string = "RemoteRenderingListConversionsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingListConversionsNextExceptionHeaders

RemoteRenderingListConversionsNextExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingListConversionsNextExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingListConversionsNextHeaders

RemoteRenderingListConversionsNextHeaders: object

type

type: object

className

className: string = "RemoteRenderingListConversionsNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingListSessionsExceptionHeaders

RemoteRenderingListSessionsExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingListSessionsExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingListSessionsNextExceptionHeaders

RemoteRenderingListSessionsNextExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingListSessionsNextExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingServiceErrorInternal

RemoteRenderingServiceErrorInternal: object

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const RemoteRenderingStopSessionExceptionHeaders

RemoteRenderingStopSessionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingStopSessionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RemoteRenderingStopSessionHeaders

RemoteRenderingStopSessionHeaders: object

type

type: object

className

className: string = "RemoteRenderingStopSessionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

Const RemoteRenderingUpdateSessionExceptionHeaders

RemoteRenderingUpdateSessionExceptionHeaders: object

type

type: object

className

className: string = "RemoteRenderingUpdateSessionExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

mscv

mscv: object

serializedName

serializedName: string = "ms-cv"

type

type: object

name

name: string = "String"

wWWAuthenticate

wWWAuthenticate: object

serializedName

serializedName: string = "www-authenticate"

type

type: object

name

name: string = "String"

Const RenderingSessionSettings

RenderingSessionSettings: object

type

type: object

className

className: string = "RenderingSessionSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

maxLeaseTimeInMinutes

maxLeaseTimeInMinutes: object

required

required: boolean = true

serializedName

serializedName: string = "maxLeaseTimeMinutes"

type

type: object

name

name: string = "Number"

size

size: object

required

required: boolean = true

serializedName

serializedName: string = "size"

type

type: object

name

name: string = "String"

Const SessionProperties

SessionProperties: object

type

type: object

className

className: string = "SessionProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

arrInspectorPort

arrInspectorPort: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "arrInspectorPort"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65534

InclusiveMinimum

InclusiveMinimum: number = 49152

type

type: object

name

name: string = "Number"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: string = "DateTime"

elapsedTimeInMinutes

elapsedTimeInMinutes: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "elapsedTimeMinutes"

type

type: object

name

name: string = "Number"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "RemoteRenderingServiceErrorInternal"

name

name: string = "Composite"

handshakePort

handshakePort: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "handshakePort"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 65534

InclusiveMinimum

InclusiveMinimum: number = 49152

type

type: object

name

name: string = "Number"

host

host: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "hostname"

type

type: object

name

name: string = "String"

maxLeaseTimeInMinutes

maxLeaseTimeInMinutes: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "maxLeaseTimeMinutes"

type

type: object

name

name: string = "Number"

sessionId

sessionId: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

size

size: object

required

required: boolean = true

serializedName

serializedName: string = "size"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

teraflops

teraflops: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "teraflops"

type

type: object

name

name: string = "Number"

Const SessionsList

SessionsList: object

type

type: object

className

className: string = "SessionsList"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

sessions

sessions: object

required

required: boolean = true

serializedName

serializedName: string = "sessions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SessionProperties"

name

name: string = "Composite"

Const UpdateSessionSettings

UpdateSessionSettings: object

type

type: object

className

className: string = "UpdateSessionSettings"

name

name: string = "Composite"

modelProperties

modelProperties: object

maxLeaseTimeInMinutes

maxLeaseTimeInMinutes: object

required

required: boolean = true

serializedName

serializedName: string = "maxLeaseTimeMinutes"

type

type: object

name

name: string = "Number"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accountId

accountId: object

parameterPath

parameterPath: string = "accountId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "account_id"

type

type: object

name

name: string = "Uuid"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-01-01"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const body

body: object

mapper

mapper: any = CreateConversionSettingsMapper

parameterPath

parameterPath: string = "body"

Const body1

body1: object

mapper

mapper: any = RenderingSessionSettingsMapper

parameterPath

parameterPath: string = "body"

Const body2

body2: object

mapper

mapper: any = UpdateSessionSettingsMapper

parameterPath

parameterPath: string = "body"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const conversionId

conversionId: object

parameterPath

parameterPath: string = "conversionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "conversion_id"

type

type: object

name

name: string = "String"

Const createConversionOperationSpec

createConversionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/accounts/{account_id}/conversions/{conversion_id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.conversionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Conversion

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionHeaders

201

201: object

bodyMapper

bodyMapper: any = Mappers.Conversion

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionHeaders

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionExceptionHeaders

isError

isError: boolean = true

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionExceptionHeaders

isError

isError: boolean = true

409

409: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateConversionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const createSessionOperationSpec

createSessionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/accounts/{account_id}/sessions/{session_id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SessionProperties

201

201: object

bodyMapper

bodyMapper: any = Mappers.SessionProperties

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionHeaders

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionExceptionHeaders

isError

isError: boolean = true

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionExceptionHeaders

isError

isError: boolean = true

409

409: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingCreateSessionExceptionHeaders

isError

isError: boolean = true

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getConversionOperationSpec

getConversionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/accounts/{account_id}/conversions/{conversion_id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.conversionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Conversion

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionHeaders

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionExceptionHeaders

isError

isError: boolean = true

404

404: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetConversionExceptionHeaders

isError

isError: boolean = true

Const getSessionOperationSpec

getSessionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/accounts/{account_id}/sessions/{session_id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SessionProperties

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetSessionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetSessionExceptionHeaders

isError

isError: boolean = true

404

404: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetSessionExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetSessionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingGetSessionExceptionHeaders

isError

isError: boolean = true

Const listConversionsNextOperationSpec

listConversionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ConversionList

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsNextHeaders

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsNextExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsNextExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsNextExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsNextExceptionHeaders

isError

isError: boolean = true

Const listConversionsOperationSpec

listConversionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/accounts/{account_id}/conversions"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.accountId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ConversionList

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsHeaders

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingListConversionsExceptionHeaders

isError

isError: boolean = true

Const listSessionsNextOperationSpec

listSessionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SessionsList

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsNextExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsNextExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsNextExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsNextExceptionHeaders

isError

isError: boolean = true

Const listSessionsOperationSpec

listSessionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/accounts/{account_id}/sessions"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.accountId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SessionsList

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingListSessionsExceptionHeaders

isError

isError: boolean = true

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const sessionId

sessionId: object

parameterPath

parameterPath: string = "sessionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "session_id"

type

type: object

name

name: string = "String"

Const stopSessionOperationSpec

stopSessionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/accounts/{account_id}/sessions/{session_id}/:stop"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.sessionId]

responses

responses: object

204

204: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionHeaders

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionExceptionHeaders

isError

isError: boolean = true

404

404: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingStopSessionExceptionHeaders

isError

isError: boolean = true

Const updateSessionOperationSpec

updateSessionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/accounts/{account_id}/sessions/{session_id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body2

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.accountId,Parameters.sessionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SessionProperties

401

401: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

403

403: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

404

404: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

422

422: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

429

429: object

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.RemoteRenderingUpdateSessionExceptionHeaders

isError

isError: boolean = true

Generated using TypeDoc