Globus-sdk

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

Added
~~~~~

- Added a `session_required_mfa` parameter to the `AuthorizationParameterInfo` error
info object and `oauth2_get_authorize_url` method (:pr:`939`)

Changed
~~~~~~~

- The argument specification for ``AuthClient.create_policy`` was incorrect.
The corrected method will emit deprecation warnings if called with positional
arguments, as the corrected version uses keyword-only arguments. (:pr:`936`)

Deprecated
~~~~~~~~~~

- ``TransferClient.operation_symlink`` is now officially deprecated and will
emit a ``RemovedInV4Warning`` if used. (:pr:`942`)

Fixed
~~~~~

- Included documentation in `AuthorizationParameterInfo` for `session_required_policies`
(:pr:`939`)

.. _changelog-3.34.0:

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

Added
~~~~~

- Add the ``delete_protected`` field to ``MappedCollectionDocument``. (:pr:`920`)

Changed
~~~~~~~

- Minor improvements to handling of paths and URLs. (:pr:`922`)

- Request paths which start with the ``base_path`` of a client are now
normalized to avoid duplicating the ``base_path``.

- When a ``GCSClient`` is initialized with an HTTPS URL, if the URL does not
end with the ``/api`` suffix, that suffix will automatically be appended.
This allows the ``gcs_manager_url`` field from Globus Transfer to be used
verbatim as the address for a ``GCSClient``.

Deprecated
~~~~~~~~~~

- ``NativeAppAuthClient.oauth2_validate_token`` and
``ConfidentialAppAuthClient.oauth2_validate_token`` have been deprecated, as
their usage is discouraged by the Auth service. (:pr:`921`)

Development
~~~~~~~~~~~

- Migrate from a CHANGELOG symlink to the RST ``.. include`` directive. (:pr:`918`)

- Tutorial endpoint references are removed from tests and replaced with
bogus values. (:pr:`919`)

.. _changelog-3.33.0.post0:

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

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

- Remove references to the Tutorial Endpoints from documentation. (:pr:`915`)

.. _changelog-3.33.0:

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

Added
~~~~~

- Support custom CA certificate bundles. (:pr:`903`)

Previously, SSL/TLS verification allowed only a boolean ``True`` or ``False`` value.
It is now possible to specify a CA certificate bundle file
using the existing ``verify_ssl`` parameter
or ``GLOBUS_SDK_VERIFY_SSL`` environment variable.

This may be useful for interacting with Globus through certain proxy firewalls.

Fixed
~~~~~

- Fix the type annotation for ``globus_sdk.IdentityMap`` init,
which incorrectly rejected ``ConfidentialAppAuthClient``. (:pr:`912`)

.. _changelog-3.32.0:

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

Added
~~~~~

.. note::
These changes pertain to methods of the client objects in the SDK which
interact with Globus Auth client registration.
To disambiguate, we refer to the Globus Auth entities below as "Globus Auth
clients" or specify "in Globus Auth", as appropriate.

- Globus Auth clients objects now have methods for interacting with client and
project APIs. (:pr:`884`)

- ``NativeAppAuthClient.create_native_app_instance`` creates a new native app
instance in Globus Auth for a client.

- ``ConfidentialAppAuthClient.create_child_client`` creates a child client in
Globus Auth for a confidential app.

- ``AuthClient.get_project`` looks up a project.

- ``AuthClient.get_policy`` looks up a policy document.

- ``AuthClient.get_policies`` lists all policies in all projects for which
the current user is an admin.

- ``AuthClient.create_policy`` creates a new policy.

- ``AuthClient.update_policy`` updates an existing policy.

- ``AuthClient.delete_policy`` deletes a policy.

- ``AuthClient.get_client`` looks up a Globus Auth client by ID or FQDN.

- ``AuthClient.get_clients`` lists all Globus Auth clients for which the
current user is an admin.

- ``AuthClient.create_client`` creates a new client in Globus Auth.

- ``AuthClient.update_client`` updates an existing client in Globus Auth.

- ``AuthClient.delete_client`` deletes a client in Globus Auth.

- ``AuthClient.get_client_credentials`` lists all client credentials for a
given Globus Auth client.

- ``AuthClient.create_client_credential`` creates a new client credential for
a given Globus Auth client.

- ``AuthClient.delete_client_credential`` deletes a client credential.

- ``AuthClient.get_scope`` looks up a scope.

- ``AuthClient.get_scopes`` lists all scopes in all projects for which the
current user is an admin.

- ``AuthClient.create_scope`` creates a new scope.

- ``AuthClient.update_scope`` updates an existing scope.

- ``AuthClient.delete_scope`` deletes a scope.

- A helper object has been defined for dependent scope manipulation via the
scopes APIs, ``globus_sdk.DependentScopeSpec`` (:pr:`884`)

Fixed
~~~~~

- When serializing ``TransferTimer`` data, do not convert to UTC if the input
was a valid datetime with an offset. (:pr:`900`)

.. _changelog-3.31.0:

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

Added
~~~~~

- Add support for the new Transfer Timer creation method, in the form of a
client method, ``TimerClient.create_timer``, and a payload builder type,
``TransferTimer`` (:pr:`887`)

- ``create_timer`` only supports dict data and ``TransferTimer``, not the
previous ``TimerJob`` type

- Additional helper classes, ``RecurringTimerSchedule`` and
``OneceTimerSchedule``, are provided to help build the ``TransferTimer``
payload

- Request encoding in the SDK will now automatically convert any ``uuid.UUID``
objects into strings. Previously this was functionality provided by certain
methods, but now it is universal. (:pr:`892`)

Deprecated
~~~~~~~~~~

- Creation of timers to run transfers using ``TimerJob`` is now
deprecated (:pr:`887`)

.. _changelog-3.30.0: