Class DocumentsApi

DocumentsApi - object-oriented interface

export

Hierarchy

BaseAPI
- DocumentsApi

Index

Constructors

constructor

Properties

Methods

getDocument

Constructors

constructor

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

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 DocumentsApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

getDocument

getDocument(fileName: string, fileType: "pdf" | "pptx" | "xlsx" | "csv", attachmentName?: string, options?: any): Promise<AxiosResponse<any>>

- Defined in api.ts:1660
summary

Retrieve a generated document

throws

{RequiredError}

memberof

DocumentsApi

Parameters
- fileName: string
- fileType: "pdf" | "pptx" | "xlsx" | "csv"
- Optional attachmentName: string
- Optional options: any
Returns Promise<AxiosResponse<any>>

Generated using TypeDoc