Templates | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Templates

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Templates(options: TemplatesOptions, http: Client): Templates

Overrides ThBaseHandler.constructor
- Defined in src/v1/templates.ts:78
Parameters
- options: TemplatesOptions
- http: Client
Returns Templates

Properties

endpoint

endpoint: string

http

http: Client

options

options: TemplatesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(template: Template): Promise<TemplatesResponse>

- Defined in src/v1/templates.ts:93
Parameters
- template: Template
Returns Promise<TemplatesResponse>

getAll

getAll(options?: TemplatesQueryOptions): Promise<TemplatesResponse>

- Defined in src/v1/templates.ts:122
Parameters
- Optional options: TemplatesQueryOptions
Returns Promise<TemplatesResponse>

preview

preview(requestObject: TemplatesPreviewRequestObject): Promise<TemplatesResponse>

- Defined in src/v1/templates.ts:138
Parameters
- requestObject: TemplatesPreviewRequestObject
Returns Promise<TemplatesResponse>

put

put(templateId: string, template: Template): Promise<TemplatesResponse>

- Defined in src/v1/templates.ts:108
Parameters
- templateId: string
- template: Template
Returns Promise<TemplatesResponse>

Generated using TypeDoc