Class: TemplateControllerApi
Hierarchy
-
↳
TemplateControllerApi
Table of contents
Constructors
Properties
Methods
- createTemplate
- createTemplateRaw
- deleteTemplate
- deleteTemplateRaw
- getAllTemplates
- getAllTemplatesRaw
- getTemplate
- getTemplateRaw
- getTemplates
- getTemplatesRaw
- request
- updateTemplate
- updateTemplateRaw
- withMiddleware
- withPostMiddleware
- withPreMiddleware
Constructors
constructor
• new TemplateControllerApi(configuration?
)
Parameters
Name | Type |
---|---|
configuration | Configuration |
Inherited from
Properties
configuration
• Protected
configuration: Configuration
Inherited from
Methods
createTemplate
▸ createTemplate(requestParameters
, initOverrides?
): Promise
<TemplateDto
>
Create a Template
Parameters
Name | Type |
---|---|
requestParameters | CreateTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<TemplateDto
>
createTemplateRaw
▸ createTemplateRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<TemplateDto
>>
Create a Template
Parameters
Name | Type |
---|---|
requestParameters | CreateTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TemplateDto
>>
deleteTemplate
▸ deleteTemplate(requestParameters
, initOverrides?
): Promise
<void
>
Delete Template
Parameters
Name | Type |
---|---|
requestParameters | DeleteTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
deleteTemplateRaw
▸ deleteTemplateRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
Delete Template
Parameters
Name | Type |
---|---|
requestParameters | DeleteTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
getAllTemplates
▸ getAllTemplates(requestParameters
, initOverrides?
): Promise
<PageTemplateProjection
>
Get all Templates in paginated format
Parameters
Name | Type |
---|---|
requestParameters | GetAllTemplatesRequest |
initOverrides? | RequestInit |
Returns
Promise
<PageTemplateProjection
>
getAllTemplatesRaw
▸ getAllTemplatesRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<PageTemplateProjection
>>
Get all Templates in paginated format
Parameters
Name | Type |
---|---|
requestParameters | GetAllTemplatesRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<PageTemplateProjection
>>
getTemplate
▸ getTemplate(requestParameters
, initOverrides?
): Promise
<TemplateDto
>
Get Template
Parameters
Name | Type |
---|---|
requestParameters | GetTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<TemplateDto
>
getTemplateRaw
▸ getTemplateRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<TemplateDto
>>
Get Template
Parameters
Name | Type |
---|---|
requestParameters | GetTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TemplateDto
>>
getTemplates
▸ getTemplates(initOverrides?
): Promise
<TemplateProjection
[]>
Get all Templates
Parameters
Name | Type |
---|---|
initOverrides? | RequestInit |
Returns
Promise
<TemplateProjection
[]>
getTemplatesRaw
▸ getTemplatesRaw(initOverrides?
): Promise
<ApiResponse
<TemplateProjection
[]>>
Get all Templates
Parameters
Name | Type |
---|---|
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TemplateProjection
[]>>
request
▸ Protected
request(context
, initOverrides?
): Promise
<Response
>
Parameters
Name | Type |
---|---|
context | RequestOpts |
initOverrides? | RequestInit |
Returns
Promise
<Response
>
Inherited from
updateTemplate
▸ updateTemplate(requestParameters
, initOverrides?
): Promise
<TemplateDto
>
Update a Template
Parameters
Name | Type |
---|---|
requestParameters | UpdateTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<TemplateDto
>
updateTemplateRaw
▸ updateTemplateRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<TemplateDto
>>
Update a Template
Parameters
Name | Type |
---|---|
requestParameters | UpdateTemplateRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TemplateDto
>>
withMiddleware
▸ withMiddleware<T
>(...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...postMiddlewares | (context : ResponseContext ) => Promise <void |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
...preMiddlewares | (context : RequestContext ) => Promise <void |
Returns
T