Globus-sdk

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

Added
~~~~~

- Add a ``FlowsClient.get_run_definition()`` method. (:pr:`799`)

Changed
~~~~~~~

- ``FlowsClient.get_run_logs()`` now uses an ``IterableRunLogsResponse``. (:pr:`797`)

.. _changelog-3.26.0:

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

Added
~~~~~

- New components are introduced to the experimental subpackage. See the SDK
Experimental documentation for more details.

- Add tools which manipulate Globus Auth Requirements error data.
``globus_sdk.experimental.auth_requirements_error`` provides a data
container class, ``GlobusAuthRequirementsError``, and functions for
converting and validating data against this shape. (:pr:`768`)

- Introduce an experimental Globus Auth scope parser in
``globus_sdk.experimental.scope_parser`` (:pr:`752`)

Changed
~~~~~~~

- The ``scopes`` class attribute of ``SpecificFlowClient`` is now specialized
to ensure that type checkers will allow access to ``SpecificFlowClient``
scopes and ``resource_server`` values without ``cast``\ing. The value used is
a specialized stub which raises useful errors when class-based access is
performed. The ``scopes`` instance attribute is unchanged. (:pr:`793`)

.. _changelog-3.25.0:

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

Added
~~~~~

- The ``jwt_params`` argument to ``decode_id_token()`` now allows ``"leeway"``
to be included to pass a ``leeway`` parameter to pyjwt. (:pr:`790`)

Fixed
~~~~~

- ``decode_id_token()`` defaulted to having no tolerance for clock drift. Slight
clock drift could lead to JWT claim validation errors. The new default is
0.5s which should be sufficient for most cases. (:pr:`790`)

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

- New scripts in the example gallery demonstrate usage of the Globus Auth
Developer APIs to List, Create, Delete, and Update Projects. (:pr:`777`)

.. _changelog-3.24.0:

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

Added
~~~~~

- Add ``FlowsClient.list_runs`` as a method for listing all runs for the
current user, with support for pagination. (:pr:`782`)

- Add ``SearchClient`` methods for managing search index lifecycle:
``create_index``, ``delete_index``, and ``reopen_index`` (:pr:`785`)

Changed
~~~~~~~

- The enforcement logic for URLs in ``BaseClient`` instantiation has been
improved to only require that ``service_name`` be set if ``base_url`` is not
provided. (:pr:`786`)

- This change primarily impacts subclasses, which no longer need to set the
``service_name`` class variable if they ensure that the ``base_url`` is
always passed with a non-null value.

- Direct instantiation of ``BaseClient`` is now possible, although not
recommended for most use-cases.

.. _changelog-3.23.0:

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

Added
~~~~~

- Add ``AuthClient`` methods to support the Projects APIs for listing,
creating, updating, and deleting projects.

- ``AuthClient.get_projects`` (:pr:`766`)
- ``AuthClient.create_project`` (:pr:`772`)
- ``AuthClient.update_project`` (:pr:`774`)
- ``AuthClient.delete_project`` (:pr:`776`)

- ``globus_sdk._testing`` now exposes a method, ``construct_error`` which makes
it simpler to explicitly construct and return a Globus SDK error object for
testing. This is used in the SDK's own testsuite and is available for
``_testing`` users. (:pr:`770`)

- ``AuthClient.oauth2_get_authorize_url`` now supports the following parameters
for session management: ``session_required_identities``,
``session_required_single_domain``, and ``session_required_policies``. Each
of these accept list inputs, as returned by
``ErrorInfo.authorization_parameters``. (:pr:`773`)

Changed
~~~~~~~

* ``AuthClient``, ``NativeAppAuthClient``, and ``ConfidentialAppAuthClient``
have had their init signatures updated to explicitly list available
parameters. (:pr:`764`)

* Type annotations for these classes are now more accurate

* The ``NativeAppAuthClient`` and ``ConfidentialAppAuthClient`` classes do
not accept ``authorizer`` in their init signatures. Previously this was
accepted but raised a ``GlobusSDKUsageError``. Attempting to pass an
``authorizer`` will now result in a ``TypeError``.

- ``session_required_policies`` parsing in ``AuthorizationParameterInfo`` now
supports the policies being returned as a ``list[str]`` in addition to
supporting ``str`` (:pr:`769`)

Fixed
~~~~~

- ``AuthorizationParameterInfo`` is now more type-safe, and will not return
parsed data from a response without checking that the data has correct types
(:pr:`769`)

- Adjust the ``FlowsClient.get_run()`` ``include_flow_description`` parameter
so it is submitted only when it has a value. (:pr:`778`)

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

- The ``_testing`` documentation has been expanded with a dropdown view of the
response contents for each method. In support of this, client method testing
docs have been reorganized into a page per service. (:pr:`767`)

.. _changelog-3.22.0:

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

Added
~~~~~

* Add support for ``AuthClient.get_identity_providers`` for looking up Identity
Providers by domain or ID in Globus Auth (:pr:`757`)

* Add a method to the Globus Search client, ``SearchClient.batch_delete_by_subject`` (:pr:`760`)

* Add ``AuthScopes.manage_projects`` to scope data. This is also accessible as
``AuthClient.scopes.manage_projects`` (:pr:`761`)

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

* Alpha features of globus-sdk are now documented in the "Unstable" doc section (:pr:`753`)

.. _changelog-3.21.0: