Class BaseTemplatesApi

BaseTemplatesApi - object-oriented interface

export

Hierarchy

BaseAPI
- BaseTemplatesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseTemplatesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): BaseTemplatesApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value axios: AxiosInstance = globalAxios
Returns BaseTemplatesApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

duplicateBaseTemplate

duplicateBaseTemplate(id: string, options?: any): Promise<AxiosResponse<Template>>

- Defined in api.ts:1469
Duplicate a base template by its ID

summary

Duplicate a base template

throws

{RequiredError}

memberof

BaseTemplatesApi

Parameters
- id: string
- Optional options: any
Returns Promise<AxiosResponse<Template>>

getBaseTemplates

getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<AxiosResponse<InlineResponse200>>

- Defined in api.ts:1482
summary

List base templates

throws

{RequiredError}

memberof

BaseTemplatesApi

Parameters
- Optional pageNum: number
- Optional page: number
- Optional options: any
Returns Promise<AxiosResponse<InlineResponse200>>

Generated using TypeDoc