Safes | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Safes

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Safes(options: SafesOptions, http: Client): Safes

Overrides ThBaseHandler.constructor
- Defined in src/v0/safes.ts:100
Parameters
- options: SafesOptions
- http: Client
Returns Safes

Properties

endpoint

endpoint: string

http

http: Client

options

options: SafesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

book

book(body: BookRequestBody): Promise<SafeResponse>

- Defined in src/v0/safes.ts:198
Parameters
- body: BookRequestBody
Returns Promise<SafeResponse>

create

create(safe: Safe): Promise<SafeResponse>

- Defined in src/v0/safes.ts:169
Parameters
- safe: Safe
Returns Promise<SafeResponse>

get

get(safeId: string): Promise<SafeResponse>

- Defined in src/v0/safes.ts:135
Parameters
- safeId: string
Returns Promise<SafeResponse>

getAll

getAll(query?: SafesQuery): Promise<SafesResponse>

- Defined in src/v0/safes.ts:112
Parameters
- Optional query: SafesQuery
Returns Promise<SafesResponse>

meta

meta(): Promise<SafesResponse>

- Defined in src/v0/safes.ts:153
Returns Promise<SafesResponse>

put

put(safeId: string, safe: Safe): Promise<SafeResponse>

- Defined in src/v0/safes.ts:183
Parameters
- safeId: string
- safe: Safe
Returns Promise<SafeResponse>

Generated using TypeDoc