# Class: TemplateControllerApi

TemplateControllerApi - object-oriented interface

export

class TemplateControllerApi

extends {BaseAPI}

# Hierarchy

# Constructors

# constructor

+ new TemplateControllerApi(configuration?: Configuration, basePath: string, fetch: FetchAPI): TemplateControllerApi

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

Name Type Default
configuration? Configuration -
basePath string BASE_PATH
fetch FetchAPI portableFetch

Returns: TemplateControllerApi

# Properties

# Protected basePath

basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


# Protected configuration

configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


# Protected fetch

fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

# Methods

# createTemplate

createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any): Promise‹TemplateDto

Defined in src/generated/api.ts:11118

summary Create a Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

Name Type Description
createTemplateOptions CreateTemplateOptions createTemplateOptions
options? any -

Returns: Promise‹TemplateDto


# deleteTemplate

deleteTemplate(templateId: string, options?: any): Promise‹Response›

Defined in src/generated/api.ts:11136

summary Delete Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

Name Type Description
templateId string TemplateId
options? any -

Returns: Promise‹Response›


# getAllTemplates

getAllTemplates(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise‹PageTemplateProjection

Defined in src/generated/api.ts:11153

summary Get all Templates in paginated format

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

Name Type
page? number
size? number
sort? "ASC" | "DESC"
options? any

Returns: Promise‹PageTemplateProjection


# getTemplate

getTemplate(templateId: string, options?: any): Promise‹TemplateDto

Defined in src/generated/api.ts:11175

summary Get Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

Name Type Description
templateId string TemplateId
options? any -

Returns: Promise‹TemplateDto


# getTemplates

getTemplates(options?: any): Promise‹TemplateProjection[]›

Defined in src/generated/api.ts:11189

summary Get all Templates

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

Name Type
options? any

Returns: Promise‹TemplateProjection[]›