Processes | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Processes

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Processes(options: ProcessesOptions, http: Client): Processes

Overrides ThBaseHandler.constructor
- Defined in src/v0/processes.ts:64
Parameters
- options: ProcessesOptions
- http: Client
Returns Processes

Properties

endpoint

endpoint: string

http

http: Client

options

options: ProcessesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(process: Process): Promise<ProcessResponse>

- Defined in src/v0/processes.ts:79
Parameters
- process: Process
Returns Promise<ProcessResponse>

delete

delete(processId: string): Promise<ProcessResponse>

- Defined in src/v0/processes.ts:156
Parameters
- processId: string
Returns Promise<ProcessResponse>

get

get(processId: string, query?: ProcessesQueryOptions): Promise<ProcessResponse>

- Defined in src/v0/processes.ts:123
Parameters
- processId: string
- Optional query: ProcessesQueryOptions
Returns Promise<ProcessResponse>

getAll

getAll(query?: ProcessesQueryOptions): Promise<ProcessesResponse>

- Defined in src/v0/processes.ts:97
Parameters
- Optional query: ProcessesQueryOptions
Returns Promise<ProcessesResponse>

getItems

getItems(processId: string, query?: ProcessItemsQueryOptions): Promise<ProcessesItemsResponse>

- Defined in src/v0/processes.ts:171
Parameters
- processId: string
- Optional query: ProcessItemsQueryOptions
Returns Promise<ProcessesItemsResponse>

meta

meta(query?: ProcessesQueryOptions): Promise<ProcessesResponse>

- Defined in src/v0/processes.ts:188
Parameters
- Optional query: ProcessesQueryOptions
Returns Promise<ProcessesResponse>

update

update(processId: string, process: Process): Promise<ProcessResponse>

- Defined in src/v0/processes.ts:140
Parameters
- processId: string
- process: Process
Returns Promise<ProcessResponse>

Generated using TypeDoc