Function DocumentsApiFp

  • DocumentsApi - functional programming interface

    Export

    Parameters

    Returns {
        bulkSubmitDocuments(tilled_account, BulkDocumentSubmitRequestParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<BulkDocumentSubmitResponse>)>;
        getDocument(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<DocumentDto>)>;
        listDocuments(tilled_account, status?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListDocuments200Response>)>;
        submitDocument(tilled_account, id, DocumentSubmitRequestParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<DocumentDto>)>;
    }

    • bulkSubmitDocuments:function
      • bulkSubmitDocuments(tilled_account, BulkDocumentSubmitRequestParams, options?): Promise<((axios?, basePath?) => AxiosPromise<BulkDocumentSubmitResponse>)>

      • 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<((axios?, basePath?) => AxiosPromise<BulkDocumentSubmitResponse>)>

    • getDocument:function
      • getDocument(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<DocumentDto>)>

      • 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<((axios?, basePath?) => AxiosPromise<DocumentDto>)>

    • listDocuments:function
      • listDocuments(tilled_account, status?, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListDocuments200Response>)>

      • 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<((axios?, basePath?) => AxiosPromise<ListDocuments200Response>)>

    • submitDocument:function
      • submitDocument(tilled_account, id, DocumentSubmitRequestParams, options?): Promise<((axios?, basePath?) => AxiosPromise<DocumentDto>)>

      • 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<((axios?, basePath?) => AxiosPromise<DocumentDto>)>

Settings

Member Visibility

Theme

Generated using TypeDoc