Airslate

--------------------

Features
^^^^^^^^

* Added support for Python 3.11.


Improvements
^^^^^^^^^^^^

* Changed additional groups of dependencies declared in ``setup.py`` so that
``develop`` is superset now for ``testing`` and ``docs``.


Bug Fixes
^^^^^^^^^

* Don't include ``tests`` package in wheel. Previously ``pip install airslate``
used to install a top-level package ``tests``. This was fixed.
* Fixed package description.


----

--------------------

Features
^^^^^^^^

* Provided ability to get and assign Tags for a given Slate.
* Provided ability to get and update Fields for a given Document.
* Introduced ``airslate.exceptions.NotFoundError`` to raise from client
when the server can not find the requested resource.
* Introduced ``airslate.facades`` facade module to provide an easy to access API resources:

* ``client.addons.auth()`` - get access token for an Addon installed in an Organization
* ``client.addons.files.get()`` - get the requested Slate Addon File
* ``client.addons.files.download()`` - download contents of the requested Slate Addon File
* ``client.documents.fields()`` - get Fields for a given Document
* ``client.documents.update_fields()`` - update Fields for a given Document
* ``client.flows.documents.collection()`` - get supported Documents for a given Flow
* ``client.slates.tags.assign()`` - assign Tags to a given Slate
* ``client.slates.tags.collection()`` - get all Slate Tags for a given Flow

* Entity attributes are now accessible via dot notation,
i.e. ``entity['id']`` is the same as ``entity.id``.
* Implement ``airslate.entities.base.BaseEntity.to_dict()`` to convert entities
to a dictionary.
* Implement ``airslate.entities.base.BaseEntity.__getstate__()`` as well as
``airslate.entities.base.BaseEntity.__setstate__()`` to provide ability to persist
and load entities state.
* Implement ``airslate.client.Client.patch()`` to send ``PATCH`` requests.


Breaking Changes
^^^^^^^^^^^^^^^^

* Moved ``client.addons.access_token()`` to ``client.addons.auth()`` facade.
* Moved ``client.slate_addon_files`` to ``client.addons.files()`` facade.
* Moved ``client.flow_documents`` to ``client.flows.documents()`` facade.
* ``BaseEntity.set_attributes()`` from ``airslate.entities.base`` module has been
removed. Users are recommended to use ``entity.attributes.update(dict)``.
* ``BaseEntity.original_included`` from ``airslate.entities.base`` module has been
removed.


Bug Fixes
^^^^^^^^^

* Fixed ``included`` parsing for ``BaseEntity.from_one`` and ``BaseEntity.from_collection``
when call ``filter_included``.


Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^

* Provided ``utils`` utility module for be use within ``airslate`` package:

* ``airslate.client.Client.DEFAULT_HEADERS`` was moved to ``airslate.utils.default_headers()``
* ``airslate.session.USER_AGENT`` was moved to ``airslate.utils.default_user_agent()``


----

------------------

Features
^^^^^^^^

* Provided ability to get slate addon file.

* Added new resources:

* ``airslate.resources.slate_addon.SlateAddonFiles`` - represent slate addon files resource

* Added new entities:

* ``airslate.entities.addons.SlateAddon`` - represent slate addon entity
* ``airslate.entities.addons.SlateAddonFile`` - represent slate addon file entity


* The base entity class as well as all derived classes now provide the following methods:

* ``has_one()`` - create an instance of the related entity
* ``from_one()`` - create an instance of the current class from the provided data


Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^

* Change default string representation of entities. Now it has the
following form: ``<EntityName: id=ID, type=TYPE>``.


----

------------------

* Initial release.