MailSlurp JS / TemplateControllerApi

Class: TemplateControllerApi

TemplateControllerApi - object-oriented interface

export

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new TemplateControllerApi(configuration?, basePath?, fetch?)

Parameters

NameType
configuration?Configuration
basePathstring
fetchFetchAPI

Inherited from

BaseAPI.constructor

Defined in

src/generated/api.ts:59

Properties

basePath

Protected basePath: string

Inherited from

BaseAPI.basePath


configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from

BaseAPI.fetch

Methods

createTemplate

createTemplate(createTemplateOptions, options?): Promise<TemplateDto>

summary Create a Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameTypeDescription
createTemplateOptionsCreateTemplateOptionscreateTemplateOptions
options?any-

Returns

Promise<TemplateDto>

Defined in

src/generated/api.ts:28644


deleteTemplate

deleteTemplate(templateId, options?): Promise<Response>

summary Delete Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameTypeDescription
templateIdstringtemplateId
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:28662


getAllTemplates

getAllTemplates(before?, page?, since?, size?, sort?, options?): Promise<PageTemplateProjection>

summary Get all Templates in paginated format

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameType
before?Date
page?number
since?Date
size?number
sort?"ASC"
options?any

Returns

Promise<PageTemplateProjection>

Defined in

src/generated/api.ts:28681


getTemplate

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

summary Get Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameTypeDescription
templateIdstringtemplateId
options?any-

Returns

Promise<TemplateDto>

Defined in

src/generated/api.ts:28707


getTemplates

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

summary Get all Templates

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameType
options?any

Returns

Promise<TemplateProjection[]>

Defined in

src/generated/api.ts:28721


updateTemplate

updateTemplate(createTemplateOptions, templateId, options?): Promise<TemplateDto>

summary Update a Template

throws {RequiredError}

memberof TemplateControllerApi

Parameters

NameTypeDescription
createTemplateOptionsCreateTemplateOptionscreateTemplateOptions
templateIdstringtemplateId
options?any-

Returns

Promise<TemplateDto>

Defined in

src/generated/api.ts:28736