Reasons | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Reasons

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Reasons(options: ReasonsOptions, http: Client): Reasons

Overrides ThBaseHandler.constructor
- Defined in src/v0/reasons.ts:53
Parameters
- options: ReasonsOptions
- http: Client
Returns Reasons

Properties

endpoint

endpoint: string

http

http: Client

options

options: ReasonsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(reason: Reason): Promise<ReasonResponse>

- Defined in src/v0/reasons.ts:116
Parameters
- reason: Reason
Returns Promise<ReasonResponse>

delete

delete(reasonId: string): Promise<ReasonResponse>

- Defined in src/v0/reasons.ts:130
Parameters
- reasonId: string
Returns Promise<ReasonResponse>

get

get(reasonId: string): Promise<ReasonResponse>

- Defined in src/v0/reasons.ts:84
Parameters
- reasonId: string
Returns Promise<ReasonResponse>

getAll

getAll(queryOrOptions?: ReasonsQuery): Promise<ReasonsResponse>

- Defined in src/v0/reasons.ts:65
Parameters
- Optional queryOrOptions: ReasonsQuery
Returns Promise<ReasonsResponse>

put

put(reasonId: string, reason: Reason): Promise<ReasonResponse>

- Defined in src/v0/reasons.ts:102
Parameters
- reasonId: string
- reason: Reason
Returns Promise<ReasonResponse>

Generated using TypeDoc