Favourites | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Favourites

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Favourites(options: FavouritesOptions, http: Client): Favourites

Overrides ThBaseHandler.constructor
- Defined in src/v0/favourites.ts:52
Parameters
- options: FavouritesOptions
- http: Client
Returns Favourites

Properties

endpoint

endpoint: string

http

http: Client

options

options: FavouritesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/favourites'

Methods

create

create(favourite: Favourite): Promise<FavouriteResponse>

- Defined in src/v0/favourites.ts:109
Parameters
- favourite: Favourite
Returns Promise<FavouriteResponse>

delete

delete(favouriteId: string): Promise<FavouriteResponse>

- Defined in src/v0/favourites.ts:143
Parameters
- favouriteId: string
Returns Promise<FavouriteResponse>

get

get(favouriteId: string): Promise<FavouriteResponse>

- Defined in src/v0/favourites.ts:91
Parameters
- favouriteId: string
Returns Promise<FavouriteResponse>

getAll

getAll(query?: Record<string, unknown>): Promise<FavouritesResponse>

- Defined in src/v0/favourites.ts:67
Parameters
- Optional query: Record<string, unknown>
Returns Promise<FavouritesResponse>

update

update(favouriteId: string, favourite: Favourite): Promise<FavouriteResponse>

- Defined in src/v0/favourites.ts:126
Parameters
- favouriteId: string
- favourite: Favourite
Returns Promise<FavouriteResponse>

Generated using TypeDoc