Tags | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Tags

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Tags(options: TagsOptions, http: Client): Tags

Overrides ThBaseHandler.constructor
- Defined in src/v0/tags.ts:46
Parameters
- options: TagsOptions
- http: Client
Returns Tags

Properties

endpoint

endpoint: string

http

http: Client

options

options: TagsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(tag: Tag): Promise<TagResponse>

- Defined in src/v0/tags.ts:113
Parameters
- tag: Tag
Returns Promise<TagResponse>

get

get(tagId: string): Promise<TagResponse>

- Defined in src/v0/tags.ts:81
Parameters
- tagId: string
Returns Promise<TagResponse>

getAll

getAll(query?: TagsQuery): Promise<TagsResponse>

- Defined in src/v0/tags.ts:58
Parameters
- Optional query: TagsQuery
Returns Promise<TagsResponse>

meta

meta(): Promise<TagsResponse>

- Defined in src/v0/tags.ts:97
Returns Promise<TagsResponse>

put

put(tagId: string, tag: Tag): Promise<TagResponse>

- Defined in src/v0/tags.ts:127
Parameters
- tagId: string
- tag: Tag
Returns Promise<TagResponse>

Generated using TypeDoc