Function FilesApiFp

Returns {
    createFile(tilled_account, file, purpose, title?, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    deleteFile(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
    getContentsOfFile(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<File>)>;
    getFile(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    listFiles(tilled_account, purposes?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListFiles200Response>)>;
}

• createFile:function

  • createFile(tilled_account, file, purpose, title?, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Creates a File.

    Summary

    Create a File

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • file: File

      A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the multipart/form-data protocol).

    • purpose: CreateFilePurpose

      The file purpose.

    • Optional title: string

      The user friendly file title.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

• deleteFile:function

  • deleteFile(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<object>)>

  • Deletes a File. This cannot be undone.

    Summary

    Delete a File

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<object>)>

• getContentsOfFile:function

  • getContentsOfFile(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<File>)>

  • Gets the contents of a File.

    Summary

    Get the Contents of a File

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<File>)>

• getFile:function

  • getFile(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Retrieves the details of an existing File.

    Summary

    Get a File

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

• listFiles:function

  • listFiles(tilled_account, purposes?, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListFiles200Response>)>

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

    Summary

    List all Files

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional purposes: ListFilesPurposes[]

      A list of file purposes to filter on.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListFiles200Response>)>