Mattermostautodriver

"""""

Code
''''

- ``driver.disconnect()`` no longer errors if not connected or initialized
- Add ``jobs.update_job_status``
- New endpoints ``Logs`` and ``RemoteClusters``
- Rename ``permissions.get_ancillary_permissions`` to ``permissions.get_ancillary_permissions_post``
- Add ``shared_channels.get_shared_channel_remotes_by_remote_cluster``
- Add ``shared_channels.invite_remote_cluster_to_channel``
- Add ``shared_channels.uninvite_remote_cluster_to_channel``
- New attribute ``default_team_id`` in ``remote_clusters.patch_remote_cluster``
- New attribute ``include_total_count`` in ``webhooks.get_incoming_webhoooks``
- New attribute ``timezone`` in ``users.update_user`` and ``users.patch_user``
- New attribute ``position`` in ``users.patch_user``
- Rename attribute ``pageSize`` to ``per_page`` in ``threads.get_user_threads`` and ``users.get_users``
- Add ``files.search_files`` and ``search.search_files``
- Add ``system.test_notification``
- Rename ``users.attach_device_id`` to ``users.attach_device_extra_props``
- Fix trailing slash in URL used in ``timeline.remove_timeline_event``
- New endpoints ``Metrics`` and ``Scheduled Post``

Documentation
'''''''''''''

- Update ``channels.add_channel_member``
- Update ``channels.search_all_channels`` - document ``exclude_remote``
- Update ``jobs.get_jobs``
- Update ``remote_clusters.accept_remote_cluster_invite`` - add ``default_team_id``
- Update ``remote_clusters.create_remote_cluster`` - add ``default_team_id``
- Update ``remote_clusters.get_remote_clusters`` - document ``included_deleted``
- Update ``schemes.create_scheme`` - document ``display_name``
- Update ``shared_channels.get_shared_channel_remotes_by_remote_cluster`` - document ``include_unconfirmed``, ``exclude_confirmed``, ``include_deleted``
- Add ``Metrics`` automodule
- Add ``Scheduled Post`` automodule

Maintenance
'''''''''''

- Pin ``httpx`` to 0.28.0 to address removed argument - see issue 15
- Tolerate but warn about missing tags in mattermost documentation

"""""

Code
''''

- Add ``params`` argument to ``system.generate_support_packet``
- Rename ``users.get_user_limits`` to ``users.get_server_limits``

Documentation
'''''''''''''

- Update descriptions and remove mention of limit of 200 users per page

"""""

Code
''''

- New endpoints ``Bookmarks``, ``OutgoingConnections``, ``OutgoingOauthConnections`` and ``Reports``
- Modified ``oauth.Oauth`` endpoints extensively
- Renamed ``posts.save_acknowledgement_for_post`` to ``posts.delete_acknowledgement_for_post``
- Add ``posts.move_thread``
- Add option ``use_rest_semantics`` to ``system.get_ping``
- Remove ``system.get_warn_metrics_status``
- Remove ``system.send_warn_metric_ack``
- Remove ``system.send_trial_license_warn_metric_ack``
- Add ``users.get_users_for_reporting``
- Add ``users.get_user_count_for_reporting``
- Add ``users.get_user_limits``

Documentation
'''''''''''''

- Minor typos corrected and slight reformatting

"""""

Code
''''

- Remove non-standard "TRACE" debug level in httpx code
- Fix logging output when passing ``debug=True`` to ``Driver()``
- Include API cnanges as of 2023-12-01
- Add ``cloud.get_endpoint_for_installation_information``
- Add ``emoji.get_emojis_by_names``
- Add ``groups.restore_group``
- Add ``users.get_users_with_invalid_emails``
- Fix URL of ``commands.list_command_autocomplete_suggestions``
- Fix URL of ``files.get_file_public``
- Remove ``insights`` and ``opengraph`` endpoints
- New endpoints ``filtering`` and ``ip``
- ``threads.set_thread_unread_by_post_id`` now uses POST

Documentation
'''''''''''''

- Updated README API clone instructions. API is now part of main mattermost repository.

Maintenance
'''''''''''

- Rename GitHub Actions for clarity
- Force upgrade of pip in sphinx build GitHub Action - fixes docutils incompatibility resolution

"""""

Release 1.2.3 and 1.2.4 should have been made under a new minor digit.
This release addresses this mistake.

Code
''''

- Minor refactor to avoid using basepath in hook calls
- Fix missing /api/v4 in websocket handcrafted URL

Maintenance
'''''''''''

- Update GitHub Actions to resolve deprecation warnings
- Fix GitHub Action Python 3.10 related failures
- Add possiblity to manually release to PyPi

"""""

Code
''''

- Include playbook API interface changes as of 2023-05-31
- Remove basepath to accomodate API changes due to the inclusion of playbook endpoints
- Endpoint root paths now include the full API path

Documentation
'''''''''''''

- Hide table of contents from index page

Maintenance
'''''''''''

- GitHub action renamed to clarify purpose and action taken
- Restart CHANGELOG.md to reflect mattermostautodriver changes and releases
- Add Python 3.11 to list of supported versions