Class FilesApi

FilesApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • FilesApi

Constructors

constructor

Properties

axios basePath configuration

Methods

createFile deleteFile getContentsOfFile getFile listFiles

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns FilesApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createFile

  • Creates a File.

    Summary

    Create a File

    Throws

    Memberof

    FilesApi

    Parameters

    • requestParameters: FilesApiCreateFileRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<any, any>>

deleteFile

  • Deletes a File. This cannot be undone.

    Summary

    Delete a File

    Throws

    Memberof

    FilesApi

    Parameters

    • requestParameters: FilesApiDeleteFileRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<object, any>>

getContentsOfFile

  • Gets the contents of a File.

    Summary

    Get the Contents of a File

    Throws

    Memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<File, any>>

getFile

  • Retrieves the details of an existing File.

    Summary

    Get a File

    Throws

    Memberof

    FilesApi

    Parameters

    • requestParameters: FilesApiGetFileRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<any, any>>

listFiles

  • Returns a list of Files. The Files are sorted with the most recently created appearing first.

    Summary

    List all Files

    Throws

    Memberof

    FilesApi

    Parameters

    • requestParameters: FilesApiListFilesRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListFiles200Response, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc