Function FilesApiFactory

  • FilesApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        createFile(requestParameters, options?) => AxiosPromise<any>;
        deleteFile(requestParameters, options?) => AxiosPromise<object>;
        getContentsOfFile(requestParameters, options?) => AxiosPromise<File>;
        getFile(requestParameters, options?) => AxiosPromise<any>;
        listFiles(requestParameters, options?) => AxiosPromise<ListFiles200Response>;
    }

    • createFile:function
      • createFile(requestParameters, options?): AxiosPromise<any>

      • Creates a File.

        Summary

        Create a File

        Throws

        Parameters

        • requestParameters: FilesApiCreateFileRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<any>

    • deleteFile:function
      • deleteFile(requestParameters, options?): AxiosPromise<object>

      • Deletes a File. This cannot be undone.

        Summary

        Delete a File

        Throws

        Parameters

        • requestParameters: FilesApiDeleteFileRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<object>

    • getContentsOfFile:function
      • getContentsOfFile(requestParameters, options?): AxiosPromise<File>

      • Gets the contents of a File.

        Summary

        Get the Contents of a File

        Throws

        Parameters

        Returns AxiosPromise<File>

    • getFile:function
      • getFile(requestParameters, options?): AxiosPromise<any>

      • Retrieves the details of an existing File.

        Summary

        Get a File

        Throws

        Parameters

        • requestParameters: FilesApiGetFileRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<any>

    • listFiles:function
      • listFiles(requestParameters, options?): AxiosPromise<ListFiles200Response>

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

        Summary

        List all Files

        Throws

        Parameters

        • requestParameters: FilesApiListFilesRequest

          Request parameters.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<ListFiles200Response>

Settings

Member Visibility

Theme

Generated using TypeDoc