Class Offers

Offers handler class

Hierarchy

Offers

Index

Constructors

constructor

Properties

transport

Methods

Constructors

constructor

new Offers(transport: API): Offers

- Defined in modules/Offers.ts:71
Offers handler class

Parameters
- transport: API
  
  API transport handler
Returns Offers

Properties

Private transport

transport: API

Handles communication with API

Methods

accept

accept(offer: Offer, headers: object): Promise<AxiosResponse>

- Defined in modules/Offers.ts:90
Accepts an offer.

Parameters
- offer: Offer
  
  Offer to accept
- headers: object
  
  Request headers
Returns Promise<AxiosResponse>

A promise that resolves to a boolean indicating whether the request was successful

counter

counter(offer: Offer, counterOffer: object, headers: object): Promise<AxiosResponse>

- Defined in modules/Offers.ts:111
Counteroffers with a new offer

Parameters
- offer: Offer
  
  Offer to counteroffer
- counterOffer: object
  
  Counteroffer object { offerAmount: number }
  - offerAmount: number
- headers: object
  
  Request headers
Returns Promise<AxiosResponse>

A promise that resolves to a boolean indicating whether the request was successful

findAll

findAll(searchParams: OfferSearchParams, headers: object): Promise<AxiosResponse>

- Defined in modules/Offers.ts:155
Retrieves all offers

Parameters
- searchParams: OfferSearchParams
  
  OfferSearchParams
- headers: object
  
  Request headers
Returns Promise<AxiosResponse>

A promise that resolves to an array of offers

findById

findById(offerId: number, headers: object): Promise<AxiosResponse>

- Defined in modules/Offers.ts:135
Retrieves an offer by ID

Parameters
- offerId: number
  
  offerId
- headers: object
  
  Request headers
Returns Promise<AxiosResponse>

A promise that resolves to an offer

Generated using TypeDoc