Issue-88: Add advanced reporting support (#89)

* feat: Add the reporting features
* docs: Update the Readme.md
*fix: Update the unit tests

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ZPascal

README.md

@@ -226,7 +226,15 @@ In general, my focus on this project is to implement and deliver old and new fea
 - Delete playlist by uid
 
 ### Reporting
+- Get reports
+- Get report by id
+- Create report
+- Update report
+- Delete report
 - Send report
+- Get report branding settings
+- Save report branding settings
+- Send report test email
 
 ### Query History
 - Add query to history

docs/content/grafana_api/model.md

@@ -38,6 +38,9 @@
   * [DatasourceCache](#model.DatasourceCache)
   * [PublicDashboard](#model.PublicDashboard)
   * [SSOSetting](#model.SSOSetting)
+  * [DashboardSchema](#model.DashboardSchema)
+  * [Report](#model.Report)
+  * [ReportBrandingSettings](#model.ReportBrandingSettings)
 
 <a id="model"></a>
 
@@ -746,3 +749,70 @@ The class includes all necessary variables to generate an SSO setting object
 - `enabled` _bool_ - Specify if the SSO provider is enabled or not
 - `scopes` _str_ - Specify the SSO scopes
 
+<a id="model.DashboardSchema"></a>
+
+## DashboardSchema Objects
+
+```python
+@dataclass
+class DashboardSchema()
+```
+
+The class includes all necessary variables to generate a dashboard schema object that is used for the reporting functionality
+
+**Arguments**:
+
+- `dashboard_uid` _str_ - Specify the dashboard uid
+- `time_range_from` _str_ - Specify the dashboard time range from
+- `time_range_to` _str_ - Specify the dashboard time range to
+- `report_variables` _dict_ - Specify the key-value pairs containing the template variables for this report, in dict format. If the value is None, the template variables from the reports dashboard will be used (default None)
+
+<a id="model.Report"></a>
+
+## Report Objects
+
+```python
+@dataclass
+class Report()
+```
+
+The class includes all necessary variables to generate a report object
+
+**Arguments**:
+
+- `name` _str_ - Specify the name of the report that is used as an email subject
+- `recipients` _str_ - Specify the comma-separated list of emails to which to send the report to
+- `reply_to` _str_ - Specify the comma-separated list of emails used in a reply-to field of the report email
+- `message` _str_ - Specify the text message used for the body of the report email
+- `start_date` _str_ - Specify the distribution starts from this date
+- `end_date` _str_ - Specify the distribution end from this date
+- `time_zone` _str_ - Specify the time zone used to schedule report execution
+- `orientation` _str_ - Specify if the orientation should be portrait or landscape
+- `layout` _str_ - Specify if the layout should be grid or simple
+- `enable_dashboard_url` _str_ - Specify if the dashboard url should be added to the bottom of the report email
+- `dashboards` _List[DashboardSchema]_ - Specify the dashboards for which the reports should be generated
+- `frequency` _str_ - Specify how often the report should be sent. Can be once, hourly, daily, weekly, monthly, last or custom. The value last schedules the report for the last day of the month. The value custom schedules the report to be sent on a custom interval. It requires interval_frequency and interval_amount to be specified e.g. every 2 weeks, where 2 is an interval_amount and weeks is an interval_frequency (default last)
+- `interval_frequency` _str_ - Specify the type of the custom interval hours, days, weeks, months (default None)
+- `interval_amount` _int_ - Specify the interval amount of the custom type (default 0)
+- `workdays_only` _bool_ - Specify if the report only on Monday-Friday should be sent. Applicable to hourly and daily types of schedule (default None)
+- `formats` _List[str]_ - Specify what kind of attachment to generate for the report. Available report formats are csv, pdf and image. The type csv attaches a CSV file for each table panel and the type image embeds an image of a dashboard into the emails body (default List["pdf"])
+
+<a id="model.ReportBrandingSettings"></a>
+
+## ReportBrandingSettings Objects
+
+```python
+@dataclass
+class ReportBrandingSettings()
+```
+
+The class includes all necessary variables to generate a report branding settings object
+
+**Arguments**:
+
+- `report_logo_url` _str_ - Specify the url of an image used as a logo on every page of the report
+- `email_logo_url` _str_ - Specify the url of an image used as a logo in the email
+- `email_footer_mode` _str_ - Specify the email footer mode. Can be sent-by or none. The value sent-by adds a 'Sent by email footer text' footer link to the email. Requires specifying values in the email_footer_text and email_footer_link fields. The value none suppresses adding a 'Sent by' footer link to the email
+- `email_footer_text` _str_ - Specify the text of a URL added to the email 'Sent by' footer (default None)
+- `email_footer_link` _str_ - Specify the url address value added to the email 'Sent by' footer (default None)
+

docs/content/grafana_api/reporting.md

@@ -2,7 +2,15 @@
 
 * [reporting](#reporting)
   * [Reporting](#reporting.Reporting)
+    * [get\_reports](#reporting.Reporting.get_reports)
+    * [get\_report\_by\_id](#reporting.Reporting.get_report_by_id)
+    * [create\_report](#reporting.Reporting.create_report)
+    * [update\_report](#reporting.Reporting.update_report)
+    * [delete\_report](#reporting.Reporting.delete_report)
     * [send\_report](#reporting.Reporting.send_report)
+    * [get\_report\_branding\_settings](#reporting.Reporting.get_report_branding_settings)
+    * [save\_report\_branding\_settings](#reporting.Reporting.save_report_branding_settings)
+    * [send\_report\_test\_email](#reporting.Reporting.send_report_test_email)
 
 <a id="reporting"></a>
 
@@ -29,6 +37,146 @@ HINT: Note Grafana Enterprise API need required permissions if fine-grained acce
 
 - `grafana_api_model` _APIModel_ - This is where we store the grafana_api_model
 
+<a id="reporting.Reporting.get_reports"></a>
+
+#### get\_reports
+
+```python
+def get_reports() -> list
+```
+
+The method includes a functionality to get all reports
+
+Required Permissions:
+Action: reports:read
+Scope: [reports:*, reports:id:*]
+
+**Raises**:
+
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _list_ - Returns all reports
+
+<a id="reporting.Reporting.get_report_by_id"></a>
+
+#### get\_report\_by\_id
+
+```python
+def get_report_by_id(id: int) -> dict
+```
+
+The method includes a functionality to get a report specified by the report id
+
+**Arguments**:
+
+- `id` _int_ - Specify the report id
+  
+  Required Permissions:
+- `Action` - reports:read
+- `Scope` - [reports:*, reports:id:*, reports:id:<report_id>]
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns the report
+
+<a id="reporting.Reporting.create_report"></a>
+
+#### create\_report
+
+```python
+def create_report(report: Report) -> int
+```
+
+The method includes a functionality to create a report
+
+**Arguments**:
+
+- `report` _Report_ - Specify the report object
+  
+  Required Permissions:
+- `Action` - reports:create
+- `Scope` - N/A
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _int_ - Returns the report id
+
+<a id="reporting.Reporting.update_report"></a>
+
+#### update\_report
+
+```python
+def update_report(id: int, report: Report)
+```
+
+The method includes a functionality to update a report
+
+**Arguments**:
+
+- `id` _int_ - Specify the report id
+- `report` _Report_ - Specify the report object
+  
+  Required Permissions:
+- `Action` - reports:write
+- `Scope` - [reports:*, reports:id:*, reports:id:<report_id>]
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+  None
+
+<a id="reporting.Reporting.delete_report"></a>
+
+#### delete\_report
+
+```python
+def delete_report(id: int)
+```
+
+The method includes a functionality to delete a report specified by the report id
+
+**Arguments**:
+
+- `id` _int_ - Specify the report id
+  
+  Required Permissions:
+- `Action` - reports:delete
+- `Scope` - [reports:*, reports:id:*, reports:id:<report_id>]
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+  None
+
 <a id="reporting.Reporting.send_report"></a>
 
 #### send\_report
@@ -43,9 +191,9 @@ The method includes a functionality to send a report to a specified email addres
 
 **Arguments**:
 
-- `id` _int_ - Specify the id of sented report. It is the same as in the URL when editing a report, not to be confused with the id of the dashboard.
+- `id` _int_ - Specify the id of forwarded report. It is the same as in the URL when editing a report, not to be confused with the id of the dashboard.
 - `emails` _str_ - Specify the comma-separated list of emails to which to send the report to. Overrides the emails from the report. Required if useEmailsFromReport is not present (default None)
-- `use_emails_from_report` _bool_ - Specify the if the emails inside the report should be used. Required if emails is not present (default None)
+- `use_emails_from_report` _bool_ - Specify if the emails inside the report should be used. Required if emails is not present (default None)
 
   Required Permissions:
 - `Action` - reports:send
@@ -58,6 +206,87 @@ The method includes a functionality to send a report to a specified email addres
 - `Exception` - Unspecified error by executing the API call
 
 
+**Returns**:
+
+  None
+
+<a id="reporting.Reporting.get_report_branding_settings"></a>
+
+#### get\_report\_branding\_settings
+
+```python
+def get_report_branding_settings() -> dict
+```
+
+The method includes a functionality to get the report branding settings
+
+Required Permissions:
+Action: reports.settings:read
+Scope: N/A
+
+**Raises**:
+
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _dict_ - Returns the report branding settings
+
+<a id="reporting.Reporting.save_report_branding_settings"></a>
+
+#### save\_report\_branding\_settings
+
+```python
+def save_report_branding_settings(branding_settings: ReportBrandingSettings)
+```
+
+The method includes a functionality to save the report branding settings
+
+**Arguments**:
+
+- `branding_settings` _ReportBrandingSettings_ - Specify the report branding settings object.
+  
+  Required Permissions:
+- `Action` - reports.settings:write
+- `Scope` - N/A
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+  None
+
+<a id="reporting.Reporting.send_report_test_email"></a>
+
+#### send\_report\_test\_email
+
+```python
+def send_report_test_email(report: Report)
+```
+
+The method includes a functionality to send a test report email
+
+**Arguments**:
+
+- `report` _Report_ - Specify the report object
+  
+  Required Permissions:
+- `Action` - reports: send
+- `Scope` - N/A
+  
+
+**Raises**:
+
+- `ValueError` - Missed specifying a necessary value
+- `Exception` - Unspecified error by executing the API call
+  
+
 **Returns**:
 
   None