Globus-sdk

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

Fixed
~~~~~

* The ``typing_extensions`` requirement in package metadata now sets a lower
bound of ``4.0``, to force upgrades of installations to get a new enough version
(:pr:`518`)

.. _changelog-3.4.0:

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

Added
~~~~~

* Support pagination on ``SearchClient.post_search`` (:pr:`507`)

* Add support for scroll queries to ``SearchClient``. ``SearchClient.scroll``
and ``SearchClient.paginated.scroll`` are now available as methods, and a new
helper class, ``SearchScrollQuery``, can be used to easily construct
scrolling queries. (:pr:`507`)

* Add methods to ``SearchClient`` for managing index roles. ``create_role``,
``delete_role``, and ``get_role_list`` (:pr:`507`)

* Add ``mapped_collection`` and ``filter`` query arguments to ``GCSClient.get_collection_list`` (:pr:`510`)

* Add role methods to ``GCSClient`` (:pr:`513`)

* ``GCSClient.get_role_list`` lists endpoint or collection roles
* ``GCSClient.create_role`` creates a role
* ``GCSClient.get_role`` gets a single role
* ``GCSClient.delete_role`` deletes a role

* The response from ``AuthClient.get_identities`` now supports iteration,
returning results from the ``"identities"`` array (:pr:`514`)

.. _changelog-3.3.1:

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

Fixed
~~~~~

* Packaging bugfix. ``globus-sdk`` is now built with pypa's ``build`` tool, to
resolve issues with wheel builds.

.. _changelog-3.3.0:

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

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: