Globus-sdk

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

Added
~~~~~

* Add ``update_group`` method to ``GroupsClient`` (:pr:`506`)

* The ``TransferData`` and ``DeleteData`` helper objects now accept the
following parameters: ``notify_on_succeeded``, ``notify_on_failed``, and
``notify_on_inactive``. All three are boolean parameters with a default
of ``True``. (:pr:`502`)

* Add ``Paginator.wrap`` as a method for getting a paginated methods. This interface is more
verbose than the existing ``paginated`` methods, but correctly preserves type
annotations. It is therefore preferable for users who are using ``mypy`` to do
type checking. (:pr:`494`)

Changed
~~~~~~~

* ``Paginator`` objects are now generics over a type var for their page type. The
page type is bounded by ``GlobusHTTPResponse``, and most type-checker behaviors
will remain unchanged (:pr:`495`)

Fixed
~~~~~

* Several minor bugs have been found and fixed (:pr:`504`)

* Exceptions raised in the SDK always use ``raise ... from`` syntax where
appropriate. This corrects exception chaining in the local endpoint and
several response objects.

* The encoding of files opened by the SDK is now always ``UTF-8``

* ``TransferData`` will now reject unsupported ``sync_level`` values with a
``ValueError`` on initialization, rather than erroring at submission time.
The ``sync_level`` has also had its type annotation fixed to allow for
``int`` values.

* Several instances of undocumented parameters have been discovered, and these
are now rectified.

Documentation
~~~~~~~~~~~~~

* Document ``globus_sdk.config.get_service_url`` and ``globus_sdk.config.get_webapp_url``
(:pr:`496`)

* Internally, these are updated to be able to default to the ``GLOBUS_SDK_ENVIRONMENT`` setting,
so specifying an environment is no longer required

.. _changelog-3.2.1:

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

Python Support
~~~~~~~~~~~~~~

* Update to avoid deprecation warnings on python 3.10 (:pr:`499`)

.. _changelog-3.2.0:

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

Added
~~~~~

* Add ``iter_items`` as a method on ``TransferData`` and ``DeleteData`` (:pr:`488`)

* Add the ``resource_server`` property to client classes and objects. For example,
``TransferClient.resource_server`` and ``GroupsClient().resource_server`` are now usable
to get the resource server string for the relevant services. ``resource_server`` is
documented as part of ``globus_sdk.BaseClient`` and may be ``None``. (:pr:`489`)

* The implementation of several properties of ``GlobusHTTPResponse`` has
changed (:pr:`497`)

* Responses have a new property, ``headers``, a case-insensitive
dict of headers from the response

* Responses now implement ``http_status`` and ``content_type`` as
properties without setters

Changed
~~~~~~~

* ClientCredentialsAuthorizer now accepts ``Union[str, Iterable[str]]``
as the type for scopes (:pr:`498`)

Fixed
~~~~~

* Fix type annotations on client methods with paginated variants (:pr:`491`)

.. _changelog-3.1.0:

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

Added
~~~~~

* Add ``filter`` as a supported parameter to ``TransferClient.task_list`` (:pr:`484`)

* The ``filter`` parameter to ``TransferClient.task_list`` and
``TransferClient.operation_ls`` can now be passed as a ``Dict[str, str | List[str]]``.
Documentation on the ``TransferClient`` explains how this will be formatted,
and is linked from the param docs for ``filter`` on each method (:pr:`484`)

Changed
~~~~~~~

* Adjust package metadata for ``cryptography`` dependency, specifying
``cryptography>=3.3.1`` and no upper bound. This is meant to help mitigate
issues in which an older ``cryptography`` version is installed gets used in
spite of it being incompatible with ``pyjwt[crypto]>=2.0`` (:pr:`486`)

.. _changelog-3.0.3:

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

Fixed
~~~~~

* Fix several internal decorators which were destroying type information about
decorated functions. Type signatures of many methods are therefore corrected (:pr:`485`)

.. _changelog-3.0.2:

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

Changed
~~~~~~~

* Produce more debug logging when SDK logs are enabled (:pr:`480`)

Fixed
~~~~~

* Update the minimum dependency versions to lower bounds which are verified to
work with the testsuite (:pr:`482`)

.. _changelog-3.0.1: