Function DocumentsApiAxiosParamCreator

Returns {
    bulkSubmitDocuments: ((tilled_account, BulkDocumentSubmitRequestParams, options?) => Promise<RequestArgs>);
    getDocument: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listDocuments: ((tilled_account, status?, offset?, limit?, options?) => Promise<RequestArgs>);
    submitDocument: ((tilled_account, id, DocumentSubmitRequestParams, options?) => Promise<RequestArgs>);
}

• bulkSubmitDocuments: ((tilled_account, BulkDocumentSubmitRequestParams, options?) => Promise<RequestArgs>)

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

    • Submit multiple Documents at once.

      Summary

      Bulk Submit Documents

      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.

      • BulkDocumentSubmitRequestParams: BulkDocumentSubmitRequestParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

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

    • Retrieves the details of an existing Document.

      Summary

      Get a Document

      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

        The id of the document to be retrieved.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listDocuments: ((tilled_account, status?, offset?, limit?, options?) => Promise<RequestArgs>)

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

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

      Summary

      List all Documents

      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 status: ListDocumentsStatus

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

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

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

    • Submits a Document.

      Summary

      Submit a Document

      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

        The id of the document to be updated.

      • DocumentSubmitRequestParams: DocumentSubmitRequestParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>