Services | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Services

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Services(options: ServicesOptions, http: Client): Services

Overrides ThBaseHandler.constructor
- Defined in src/v1/services.ts:89
Parameters
- options: ServicesOptions
- http: Client
Returns Services

Properties

endpoint

endpoint: string

http

http: Client

options

options: ServicesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/services'

Methods

create

create(service: Service): Promise<ServiceResponse>

- Defined in src/v1/services.ts:231
Parameters
- service: Service
Returns Promise<ServiceResponse>

delete

delete(serviceId: string): Promise<ServiceResponse>

- Defined in src/v1/services.ts:259
Parameters
- serviceId: string
Returns Promise<ServiceResponse>

get

get(serviceId: string): Promise<ServiceResponse>

- Defined in src/v1/services.ts:213
Parameters
- serviceId: string
Returns Promise<ServiceResponse>

getAll

getAll(query?: ServicesQuery): Promise<ServicesResponse>

- Defined in src/v1/services.ts:104
Parameters
- Optional query: ServicesQuery
Returns Promise<ServicesResponse>

meta

meta(q?: ServicesMetaQuery): Promise<ServicesMetaResponse>

- Defined in src/v1/services.ts:128
Parameters
- Optional q: ServicesMetaQuery
Returns Promise<ServicesMetaResponse>

put

put(serviceId: string, service: Service): Promise<ServiceResponse>

- Defined in src/v1/services.ts:245
Parameters
- serviceId: string
- service: Service
Returns Promise<ServiceResponse>

query

query(options?: ServicesOptions): Promise<ServicesResponse>

- Defined in src/v1/services.ts:151
Parameters
- Optional options: ServicesOptions
Returns Promise<ServicesResponse>

Generated using TypeDoc