parseur.cli
===========

.. py:module:: parseur.cli


Functions
---------

.. autoapisummary::

   parseur.cli.headers_to_dict
   parseur.cli.cli
   parseur.cli.init
   parseur.cli.list_mailboxes
   parseur.cli.get_mailbox
   parseur.cli.get_mailbox_schema
   parseur.cli.list_documents
   parseur.cli.get_document
   parseur.cli.reprocess_document
   parseur.cli.skip_document
   parseur.cli.copy_document
   parseur.cli.get_document_logs
   parseur.cli.delete_document
   parseur.cli.upload_file
   parseur.cli.upload_folder
   parseur.cli.upload_text
   parseur.cli.create_webhook
   parseur.cli.get_webhook
   parseur.cli.delete_webhook
   parseur.cli.enable_webhook
   parseur.cli.pause_webhook
   parseur.cli.list_webhooks
   parseur.cli.listen


Module Contents
---------------

.. py:function:: headers_to_dict(headers)

.. py:function:: cli()

   Parseur CLI - manage Parseur.com from the command line.


.. py:function:: init(api_key, api_base)

   Initialize the CLI with your API token and optional base URL.


.. py:function:: list_mailboxes(search, order_by, descending)

   List all mailboxes with optional filtering and sorting.


.. py:function:: get_mailbox(mailbox_id)

   Get details of a mailbox.


.. py:function:: get_mailbox_schema(mailbox_id)

   Get schema of a mailbox.


.. py:function:: list_documents(mailbox_id, search, order_by, descending, received_after, received_before, with_result)

   List all documents in a mailbox with optional filtering, sorting, and result inclusion.


.. py:function:: get_document(document_id)

   Get details of a document.


.. py:function:: reprocess_document(document_id)

   Reprocess a document.


.. py:function:: skip_document(document_id)

   Skip a document.


.. py:function:: copy_document(document_id, target_mailbox_id)

   Copy a document to another mailbox.


.. py:function:: get_document_logs(document_id)

   Get logs of a document.


.. py:function:: delete_document(document_id)

   Delete a document.


.. py:function:: upload_file(mailbox_id, file_path)

   Upload a document file to a mailbox.


.. py:function:: upload_folder(mailbox_id, folder_path)

   Upload all files from a glob path.


.. py:function:: upload_text(recipient, subject, sender, body_html, body_plain)

   Upload text content to a mailbox by email address.


.. py:function:: create_webhook(event, target_url, mailbox_id, table_field_id, header, name)

   Create a new custom webhook for your Parseur account.


.. py:function:: get_webhook(webhook_id)

   Get details of a webhook.


.. py:function:: delete_webhook(webhook_id)

   Delete a registered webhook by its ID.

   This command permanently removes the webhook from your Parseur account.


.. py:function:: enable_webhook(mailbox_id, webhook_id)

   Enable a webhook for the specified mailbox.

   Activates the webhook by adding it to the mailbox.


.. py:function:: pause_webhook(mailbox_id, webhook_id)

   Pause a webhook for the specified mailbox.

   Removes the webhook from the mailbox without deleting it.


.. py:function:: list_webhooks()

   List all registered webhooks.


.. py:function:: listen(event, mailbox_id, table_field_id, header, name, redirect_url, redirect_port, silent)

   Listen to a Parseur event in real time with a temporary webhook.
   Example:
     parseur listen --event document.parsed_ok --mailbox-id 12345
     parseur listen --event document.processed --mailbox-id 12345 --redirect-url http://localhost --redirect-port 8000