Globus-sdk

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

Added
~~~~~

* Added ``FlowsClient.update_flow(...)`` (:pr:`710`)

* Support passing "include" as a transfer ``filter_rule`` method (:pr:`712`)

* Make the request-like interface for response objects and errors more uniform. (:pr:`715`)

* Both ``GlobusHTTPResponse`` and ``GlobusAPIError`` are updated to ensure
that they have the following properties in common: ``http_status``,
``http_reason``, ``headers``, ``content_type``, ``text``

* ``GlobusHTTPResponse`` and ``GlobusAPIError`` have both gained a new
property, ``binary_content``, which returns the unencoded response data as
bytes

Deprecated
~~~~~~~~~~

* ``GlobusAPIError.raw_text`` is deprecated in favor of ``text``

Fixed
~~~~~

* The return type of ``AuthClient.get_identities`` is now correctly annotated as
an iterable type, ``globus_sdk.GetIdentitiesResponse`` (:pr:`716`)

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

* Documentation for client methods has been improved to more consistently
format and display examples and other information (:pr:`714`)

.. _changelog-3.18.0:

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

Added
~~~~~

* ``ConfidentialAppAuthClient.oauth2_get_dependent_tokens`` now supports the
``refresh_tokens`` parameter to enable requests for dependent refresh tokens (:pr:`698`)

Changed
~~~~~~~

* Behaviors which will change in version 4.0.0 of the ``globus-sdk`` now emit
deprecation warnings.

* ``TransferData.add_item`` now defaults to omitting ``recursive`` rather than
setting its value to ``False``. This change better matches new Transfer API
behaviors which treat the absence of the ``recursive`` flag as meaning
autodetect, rather than the previous default of ``False``. Setting the
recursive flag can still have beneficial behaviors, but should not be
necessary for many use-cases (:pr:`696`)

Deprecated
~~~~~~~~~~

* Omitting ``requested_scopes`` or specifying it as ``None`` is now deprecated
and will emit a warning. In version 4, users will always be required to
specify their scopes when performing login flows. This applies to the
following methods:

* ``ConfidentialAppAuthClient.oauth2_client_credentials_tokens``
* ``AuthClient.oauth2_start_flow``

* ``SearchClient.update_entry`` and ``SearchClient.create_entry`` are
officially deprecated and will emit a warning. These APIs are aliases of
``SearchClient.ingest``, but their existence has caused confusion. Users are
encouraged to switch to ``SearchClient.ingest`` instead (:pr:`695`)

Fixed
~~~~~

* When users input empty ``requested_scopes`` values, these are now rejected
with a usage error instead of being translated into the default set of
``requested_scopes``

* Fix the type annotation for `max_sleep` on client transports to allow `float`
values (:pr:`697`)

.. _changelog-3.17.0:

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

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

* Remove support for python3.6 (:pr:`681`)

Added
~~~~~

* ``MutableScope`` objects can now be used in the ``oauth2_start_flow`` and
``oauth2_client_credentials_tokens`` methods of ``AuthClient`` classes as part
of ``requested_scopes`` (:pr:`689`)

Changed
~~~~~~~

* Make ``MutableScope.scope_string`` a public instance attribute (was
``_scope_string``) (:pr:`687`)

* Globus Groups methods which required enums as arguments now also accept
a variety of ``Literal`` strings in their annotations as well. This is
coupled with changes to ensure that strings and enums are always serialized
correctly in these cases. (:pr:`691`)

Fixed
~~~~~

* Fix a typo in ``TransferClient.endpoint_manager_task_successful_transfers``
which prevented calls from being made correctly (:pr:`683`)

.. _changelog-3.16.0:

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

Added
~~~~~

* Allow UUID values for the ``client_id`` parameter to ``AuthClient`` and its
subclasses (:pr:`676`)

Changed
~~~~~~~

* Improved GCS Collection datatype detection to support ``collection1.6.0``
and ``collection1.7.0`` documents (:pr:`675`)

* ``guest_auth_policy_id`` is now supported on ``MappedCollectionDcoument``

* ``user_message`` strings over 64 characters are now supported

* The ``session_required_policies`` attribute of ``AuthorizationInfo`` is now
parsed as a list of strings when present, and ``None`` when absent. (:pr:`678`)

* ``globus_sdk.ArrayResponse`` and ``globus_sdk.IterableResponse`` are now
available as names. Previously, these were only importable from
``globus_sdk.response`` (:pr:`680`)

Fixed
~~~~~

* ``ArrayResponse`` and ``IterableResponse`` have better error behaviors when
the API data does not match their expected types (:pr:`680`)

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

* Fix the Timer code example (:pr:`672`)

* New documentation examples for Transfer Task submission in the presence of
``ConsentRequired`` errors (:pr:`673`)

.. _changelog-3.15.1:

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

Added
~~~~~

* AuthorizationParameterInfo now exposes session_required_policies (:pr:`658`)

Fixed
~~~~~

* Fix a bug where ``TransferClient.endpoint_manager_task_list`` didn't handle
the ``last_key`` argument when paginated (:pr:`662`)

.. _changelog-3.15.0:

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

Added
~~~~~

* Scope Names can be set explicitly in a ``ScopeBuilder`` (:pr:`641`)

* Introduced ``ScopeBuilder.scope_names`` property (:pr:`641`)

* Add support for ``interpret_globs`` and ``ignore_missing`` to ``DeleteData`` (:pr:`646`)

* A new object, ``globus_sdk.LocalGlobusConnectServer`` can be used to inspect
the local installation of Globus Connect Server (:pr:`647`)

* The object supports properties for ``endpoint_id`` and ``domain_name``

* This only supports Globus Connect Server version 5

* The filter argument to TransferClient.operation_ls now accepts a list to pass
multiple filter params (:pr:`652`)

* Improvements to ``MutableScope`` objects (:pr:`654`)

* ``MutableScope(...).serialize()`` is added, and ``str(MutableScope(...))`` uses it

* ``MutableScope.add_dependency`` now supports ``MutableScope`` objects as inputs

* ``ScopeBuilder.make_mutable`` now accepts a keyword argument ``optional``.
This allows, for example, ``TransferScopes.make_mutable("all", optional=True)``

Changed
~~~~~~~

* Improve the ``__str__`` implementation for ``OAuthTokenResponse`` (:pr:`640`)

* When ``GlobusHTTPResponse`` contains a list, calls to ``get()`` will no
longer fail with an ``AttributeError`` but will return the default value
(``None`` if unspecified) instead (:pr:`644`)

Deprecated
~~~~~~~~~~

* The ``optional`` argument to ``add_dependency`` is deprecated.
``MutableScope(...).add_dependency(MutableScope("foo", optional=True))``
can be used to add an optional dependency

Fixed
~~~~~

* Fixed SpecificFlowClient scope string (:pr:`641`)

* Fix a bug in the type annotations for transport objects which restricted the
size of status code tuples set as classvars (:pr:`651`)

.. _changelog-3.14.0: