Class DocumentsApi

DocumentsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- DocumentsApi

Index

Constructors

constructor

new DocumentsApi(configuration?, basePath?, axios?): DocumentsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DocumentsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

bulkSubmitDocuments

bulkSubmitDocuments(requestParameters, options?): Promise<AxiosResponse<BulkDocumentSubmitResponse, any>>
Submit multiple Documents at once.

Summary
Bulk Submit Documents

Throws

Memberof
DocumentsApi
Parameters
- requestParameters: DocumentsApiBulkSubmitDocumentsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<BulkDocumentSubmitResponse, any>>
- Defined in api/documents-api.ts:493

getDocument

getDocument(requestParameters, options?): Promise<AxiosResponse<DocumentDto, any>>
Retrieves the details of an existing Document.

Summary
Get a Document

Throws

Memberof
DocumentsApi
Parameters
- requestParameters: DocumentsApiGetDocumentRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<DocumentDto, any>>
- Defined in api/documents-api.ts:505

listDocuments

listDocuments(requestParameters, options?): Promise<AxiosResponse<ListDocuments200Response, any>>
Returns a list of Documents. The Documents are sorted with the most recently created appearing first.

Summary
List all Documents

Throws

Memberof
DocumentsApi
Parameters
- requestParameters: DocumentsApiListDocumentsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListDocuments200Response, any>>
- Defined in api/documents-api.ts:517

submitDocument

submitDocument(requestParameters, options?): Promise<AxiosResponse<DocumentDto, any>>
Submits a Document.

Summary
Submit a Document

Throws

Memberof
DocumentsApi
Parameters
- requestParameters: DocumentsApiSubmitDocumentRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<DocumentDto, any>>
- Defined in api/documents-api.ts:529

Class DocumentsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns DocumentsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

bulkSubmitDocuments

Summary

Throws

Memberof

Parameters

requestParameters: DocumentsApiBulkSubmitDocumentsRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<BulkDocumentSubmitResponse, any>>

getDocument

Summary

Throws

Memberof

Parameters

requestParameters: DocumentsApiGetDocumentRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<DocumentDto, any>>

listDocuments

Summary

Throws

Memberof

Parameters

requestParameters: DocumentsApiListDocumentsRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<ListDocuments200Response, any>>

submitDocument

Summary

Throws

Memberof

Parameters

requestParameters: DocumentsApiSubmitDocumentRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<DocumentDto, any>>

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>