mailbox-org-api 0.2.2__tar.gz → 0.4__tar.gz

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mailbox-org-api
-Version: 0.2.2
+Version: 0.4
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
@@ -61,7 +61,7 @@ The implemented functions follow the naming scheme of the API, but with undersco
 1. I'm not a programmer. I'm not very good at this. Be aware of my incompetence.
 2. Implementation is not complete. Not all functions of the API have been implemented
 3. Type hinting is available for most functions, but not all of them.  
-E.g. `mail_add()` accepts kwargs due to the number of available attributes. 
+E.g. `mail_set()` accepts kwargs due to the number of available attributes. 
 In that case type errors will be returned if wrong types are provided.
 
 ## API documentation

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/README.md

@@ -46,7 +46,7 @@ The implemented functions follow the naming scheme of the API, but with undersco
 1. I'm not a programmer. I'm not very good at this. Be aware of my incompetence.
 2. Implementation is not complete. Not all functions of the API have been implemented
 3. Type hinting is available for most functions, but not all of them.  
-E.g. `mail_add()` accepts kwargs due to the number of available attributes. 
+E.g. `mail_set()` accepts kwargs due to the number of available attributes. 
 In that case type errors will be returned if wrong types are provided.
 
 ## API documentation

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/mailbox_org_api/APIClient.py

@@ -161,6 +161,69 @@ class APIClient:
         """
         return self.api_request('account.del', {'account':account})
 
+    def account_invoice_list(self, account: str) -> dict:
+        """
+        Function to list all invoices for a specific account
+        :param account: the account name to list
+        :return: the response from the mailbox.org Business API
+        """
+        return self.api_request('account.invoice.list', {'account':account})
+
+    def account_invoice_get(self, account: str, token: str) -> dict:
+        """
+        Function to get a specific of all invoices for an account
+        :param account: the account name
+        :param token: the token for the invoice
+        :return: the response from the mailbox.org Business API - the invoice as a Base64 encoded gzipped string
+        """
+        return self.api_request('account.invoice.get', {'account':account, 'token':token})
+
+    def account_invoice_get_list(self, account: str) -> list:
+        """
+        Function to get a list of all invoices for a specific account
+        """
+        response = self.api_request('account.invoice.list', {'account':account})
+        invoices = []
+
+        for invoice in response:
+            invoices.append(invoice['invoice_id'])
+
+        return invoices
+
+    def account_invoice_get_token(self, account: str, invoice_id: str) -> str:
+        """
+        Function to get the token for a specific invoices of an account
+        :param account: the account name
+        :param invoice_id: the id of the invoice
+        :return: the response from the mailbox.org Business API - the token to get the invoice
+        """
+        response = self.api_request('account.invoice.list', {'account': account})
+        for invoice in response:
+            if invoice['invoice_id'] == invoice_id:
+                return invoice['token']
+        raise ValueError('Invoice not found')
+
+    def account_invoice_get_pdf(self, account: str, token: str) -> bytes:
+        """
+        Function to get a specific invoice as a PDf-file
+        :param account: the account name
+        :param token: the token for the invoice
+        :return: the PDF as bytes
+        """
+        import base64
+        import zlib
+
+        # Get the invoice data
+        response = self.api_request('account.invoice.get', {'account': account, 'token': token})
+
+        # Get the Base64 encoded data and decode it Decode string to gzip
+        compressed_data = base64.b64decode(response['bin'])
+
+        # Decompress the gzipped data
+        decompressed_data = zlib.decompress(compressed_data)
+
+        return decompressed_data
+
     def domain_list(self, account: str) -> dict:
         """
         Function to list all domains
@@ -392,6 +455,60 @@ class APIClient:
         """
         return self.api_request('mail.externaluid', {'mail':mail})
 
+    def mail_backup_list(self, mail: str) -> dict:
+        """
+        Function to list all backups for a given mail
+        :param mail: the mail to list backups for
+        :return: the response for the request - a list of backups
+        """
+        return self.api_request('mail.backup.list', {'mail':mail})
+
+    def mail_backup_import(self, mail: str, id: str, time: str, filter: str) -> dict:
+        """
+        Function to import a backup for a mail
+        :param mail: the mail to import
+        :param id: the id of the backup
+        :param time: the time of the backup
+        :param filter: the filter of the backup - "all" or an IMAP foldername
+        """
+        return self.api_request('mail.backup.import',
+                                {'mail':mail, 'id':id, 'time':time, 'filter':filter})
+
+    def group_list(self) -> dict:
+        """
+        Function to list all groups for an account
+        """
+        return self.api_request('group.list', {})
+
+    def group_add(self, name: str, display_name: str, mail_addresses_to_add: list) -> dict:
+        """
+        Function to add a group
+        :param name: the group name
+        :param display_name: the group's display name
+        :param mail_addresses_to_add: a list of mail addresses to add
+        """
+        return self.api_request('group.add', {'name':name, 'display_name':display_name,
+                                              'mail_addresses_to_add':mail_addresses_to_add})
+
+    def group_set(self, name: str, display_name: str, mail_addresses_to_add: list, mail_addresses_to_remove: list) -> dict:
+        """
+        Function to modify a group
+        :param name: the group name
+        :param display_name: the group's display name
+        :param mail_addresses_to_add: a list of mail addresses to add
+        :param mail_addresses_to_remove: a list of mail addresses to remove
+        """
+        return self.api_request('group.set', {'name':name, 'display_name':display_name,
+                                              'mail_addresses_to_add':mail_addresses_to_add,
+                                              'mail_addresses_to_remove':mail_addresses_to_remove})
+
+    def group_del(self, name: str) -> dict:
+        """
+        Function to delete a group
+        :param name: the group's name
+        """
+        return self.api_request('group.delete', {'name':name})
+
     def context_list(self, account: str) -> dict:
         """
         Function to list all contexts of a given account

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/mailbox_org_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mailbox-org-api
-Version: 0.2.2
+Version: 0.4
 Summary: A library to access the mailbox.org Business API.
 Author: Hendrik Schlange
 Author-email: Hendrik Schlange <mail@heshsum.de>
@@ -61,7 +61,7 @@ The implemented functions follow the naming scheme of the API, but with undersco
 1. I'm not a programmer. I'm not very good at this. Be aware of my incompetence.
 2. Implementation is not complete. Not all functions of the API have been implemented
 3. Type hinting is available for most functions, but not all of them.  
-E.g. `mail_add()` accepts kwargs due to the number of available attributes. 
+E.g. `mail_set()` accepts kwargs due to the number of available attributes. 
 In that case type errors will be returned if wrong types are provided.
 
 ## API documentation

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mailbox-org-api"
-version = "0.2.2"
+version = "0.4"
 authors = [
   { name="Hendrik Schlange", email="mail@heshsum.de" },
 ]

{mailbox_org_api-0.2.2 → mailbox_org_api-0.4}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages, setup
 setup(
     name='mailbox_org_api',
     packages=find_packages(),
-    version='0.2.2',
+    version='0.4',
     description='A library to access the mailbox.org Business API',
     author='Hendrik Schlange',
     install_requires=['requests'],