Offer class

Use to read or replace an existing <xref:Offer> by id.

Properties

client
id
url

Returns a reference URL to the resource. Used for linking in Permissions.

Methods

read(RequestOptions)

Read the <xref:OfferDefinition> for the given <xref:Offer>.

replace(OfferDefinition, RequestOptions)

Replace the given <xref:Offer> with the specified <xref:OfferDefinition>.

Property Details

client

client: CosmosClient

Property Value

id

id: string

Property Value

string

url

Returns a reference URL to the resource. Used for linking in Permissions.

url: string

Property Value

string

Method Details

read(RequestOptions)

Read the <xref:OfferDefinition> for the given <xref:Offer>.

function read(options?: RequestOptions)

Parameters

options
RequestOptions

Returns

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Replace the given <xref:Offer> with the specified <xref:OfferDefinition>.

function replace(body: OfferDefinition, options?: RequestOptions)

Parameters

body
OfferDefinition

The specified <xref:OfferDefinition>

options
RequestOptions

Returns

Promise<OfferResponse>