Class Offer

Use to read or replace an existing Offer by id.

see: Offers to query or read all offers.

Hierarchy

Offer

Index

Properties

client
id

Accessors

url

Methods

read
replace

Properties

client

client: CosmosClient

The parent CosmosClient for the Database Account.

id

id: string

The id of the given Offer.

Accessors

url

get url(): string

- Defined in client/Offer/Offer.ts:17
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string

Methods

read

read(options?: RequestOptions): Promise<OfferResponse>

- Defined in client/Offer/Offer.ts:35
Read the OfferDefinition for the given Offer.

Parameters
- Optional options: RequestOptions
Returns Promise<OfferResponse>

replace

replace(body: OfferDefinition, options?: RequestOptions): Promise<OfferResponse>

- Defined in client/Offer/Offer.ts:50
Replace the given Offer with the specified OfferDefinition.

Parameters
- body: OfferDefinition
  
  The specified OfferDefinition
- Optional options: RequestOptions
Returns Promise<OfferResponse>

Generated using TypeDoc