Globus-sdk

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

Added
~~~~~

* Flesh out the ``GroupsClient`` and add helpers for interacting with the
Globus Groups service, including enumerated constants, payload builders, and
a high-level client for doing non-batch operations called the
``GroupsManager`` (:pr:`435`, :pr:`443`)

* globus-sdk now provides much more complete type annotations coverage,
allowing type checkers like ``mypy`` to catch a much wider range of usage
errors (:pr:`442`)

.. _changelog-3.0.0b2:

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

Added
~~~~~

* Add scope constants and scope construction helpers. See new documentation on
:ref:`scopes and ScopeBuilders <scopes>` for details (:pr:`437`, :pr:`440`)

* API Errors now have an attached ``info`` object with parsed error data where
applicable. See the :ref:`ErrorInfo documentation <error_info>` for details
(:pr:`441`)

Changed
~~~~~~~

* Improve the rendering of API exceptions in stack traces to include the
method, URI, and authorization scheme (if recognized) (:pr:`439`)

* Payload helper objects (``TransferData``, ``DeleteData``, and ``SearchQuery``)
now inherit from a custom object, not ``dict``, but they are still dict-like in
behavior (:pr:`438`)

.. _changelog-3.0.0b1:

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

Added
~~~~~

* Add support for ``TransferClient.get_shared_endpoint_list`` (:pr:`434`)

Changed
~~~~~~~

* Passthrough parameters to SDK methods for query params and body params are no
longer accepted as extra keyword arguments. Instead, they must be passed
explicitly in a ``query_params``, ``body_params``, or ``additional_fields``
dictionary, depending on the context (:pr:`433`)

* The interface for retry parameters has been simplified. ``RetryPolicy``
objects have been merged into the transport object, and retry parameters like
``max_retries`` may now be supplied directly as ``transport_params``
(:pr:`430`)

.. _changelog-3.0.0a4:

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

Added
~~~~~

* Add ``BaseClient`` to the top-level exports of ``globus_sdk``, so it can now
be accessed under the name ``globus_sdk.BaseClient``

Fixed
~~~~~

* Fix several paginators which were broken in ``3.0.0a3`` (:pr:`431`)

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

* Autodocumentation of paginated methods (:pr:`432`)

.. _changelog-3.0.0a3:

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

Changed
~~~~~~~

* Pagination has changed significantly. (:pr:`418`)

* Methods which support pagination like ``TransferClient.endpoint_search`` no
longer return an iterable ``PaginatedResource`` type. Instead, these client
methods return ``GlobusHTTPResponse`` objects with a single page of results.

* Paginated variants of these methods are available by renaming a call from
``client.<method>`` to ``client.paginated.<method>``. So, for example, a
``TransferClient`` now supports ``client.paginated.endpoint_search()``.
The arguments to this function are the same as the original method.

* ``client.paginated.<method>`` calls return ``Paginator`` objects, which
support two types of iteration: by ``pages()`` and by ``items()``. To
replicate the same behavior as SDK v1.x and v2.x ``PaginatedResource``
types, use ``items()``, as in
``client.paginated.endpoint_search("query").items()``

.. _changelog-3.0.0a2:

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

Added
~~~~~

* A new subpackage is available for public use,
``globus_sdk.tokenstorage`` (:pr:`405`)

* Add client for Globus Groups API, ``globus_sdk.GroupsClient``. Includes a
dedicated error class, ``globus_sdk.GroupsAPIError``

Changed
~~~~~~~

* Refactor response classes (:pr:`425`)

.. _changelog-3.0.0a1: