MailSlurp JS

Globals / TemplateControllerApi

Class: TemplateControllerApi

TemplateControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: TemplateControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected 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:20620

summary Create a Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

NameTypeDescription
createTemplateOptionsCreateTemplateOptionscreateTemplateOptions
options?any-

Returns: Promise<TemplateDto>


deleteTemplate

deleteTemplate(templateId: string, options?: any): Promise

Defined in src/generated/api.ts:20638

summary Delete Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

NameTypeDescription
templateIdstringTemplateId
options?any-

Returns: Promise


getAllTemplates

getAllTemplates(page?: number, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageTemplateProjection>

Defined in src/generated/api.ts:20655

summary Get all Templates in paginated format

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

NameType
page?number
size?number
sort?“ASC”
options?any

Returns: Promise<PageTemplateProjection>


getTemplate

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

Defined in src/generated/api.ts:20677

summary Get Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

NameTypeDescription
templateIdstringTemplateId
options?any-

Returns: Promise<TemplateDto>


getTemplates

getTemplates(options?: any): Promise<TemplateProjection[]>

Defined in src/generated/api.ts:20691

summary Get all Templates

throws {RequiredError}

memberof TemplateControllerApi

Parameters:

NameType
options?any

Returns: Promise<TemplateProjection[]>