Function FilesApiAxiosParamCreator

Returns {
    createFile: ((tilled_account, file, purpose, title?, options?) => Promise<RequestArgs>);
    deleteFile: ((tilled_account, id, options?) => Promise<RequestArgs>);
    getContentsOfFile: ((tilled_account, id, options?) => Promise<RequestArgs>);
    getFile: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listFiles: ((tilled_account, purposes?, offset?, limit?, options?) => Promise<RequestArgs>);
}

• createFile: ((tilled_account, file, purpose, title?, options?) => Promise<RequestArgs>)

  • • (tilled_account, file, purpose, title?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• deleteFile: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getContentsOfFile: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getFile: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listFiles: ((tilled_account, purposes?, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, purposes?, offset?, limit?, options?): Promise<RequestArgs>

    • 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<RequestArgs>