Globals / TemplateControllerApi
# Class: TemplateControllerApi
TemplateControllerApi - object-oriented interface
export
# Hierarchy
-
↳ TemplateControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new TemplateControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): TemplateControllerApi
Inherited from BaseAPI.constructor
Defined in src/generated/api.ts:57 (opens new window)
# Parameters:
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | - |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Returns: TemplateControllerApi
# Properties
# basePath
• Protected basePath: string
Inherited from BaseAPI.basePath
Defined in src/generated/api.ts:61 (opens new window)
# configuration
• Protected configuration: Configuration
Inherited from BaseAPI.configuration
Defined in src/generated/api.ts:57 (opens new window)
# fetch
• Protected fetch: FetchAPI
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# createTemplate
▸ createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any): Promise<TemplateDto>
Defined in src/generated/api.ts:16104 (opens new window)
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:16122 (opens new window)
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:16139 (opens new window)
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:16161 (opens new window)
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:16175 (opens new window)
summary Get all Templates
throws {RequiredError}
memberof TemplateControllerApi
# Parameters:
| Name | Type |
|---|---|
options? | any |
Returns: Promise<TemplateProjection[]>
