v3.58.0

Added

• Add the SpecificFlow.validate_run() method. (#1221)

Fixed

• Fix an error which caused the restrict_transfers_to_high_assurance field
  to be malformed when set on a collection payload type. (#1211)

v4.0.0a2

Breaking Changes

• The SDK version is no longer available in globus_sdk.version.__version__. (#1195)

  Packages that want to query the SDK version must use importlib.metadata:

  import importlib.metadata
  
  GLOBUS_SDK_VERSION = importlib.metadata.distribution("globus_sdk").version

• The legacy MutableScope type has been removed. (#1198)

  • The make_mutable method on ScopeBuilder objects has also been removed as a consequence of this change.

• Defaults of None were converted to globus_sdk.MISSING for multiple client methods and payload types, covering Compute, Flows, Groups, GCS, and Search. (#1205, #1207, #1212, #1214)

Removed

• globus_sdk.experimental.auth_requirements_error has been removed. Use globus_sdk.gare instead. (#1202)

• GlobusAPIError no longer provides a setter for message. The message property is now read-only. (#1204)

• Deprecated aliases for TimersClient, TimersScopes, and TimersAPIError have been removed. (#1206)

v3.57.0

Added

• Globus Connect Server collection document classes now support attributes up to document version 1.15.0. (#1197)

Deprecated

• Importing scope parsing tools from globus_sdk.experimental now emits a deprecation warning. These names were previously deprecated in documentation only. (#1201)

Documentation

• Remove the badges at the top of the README. (#1194)

v4.0.0a1

Breaking Changes

• The SDK no longer sets default scopes for direct use
  of client credentials and auth client login flow methods.
  Users should either use GlobusApp objects,
  which can specify scopes based on the clients in use,
  or else pass a list of scopes explicitly to
  oauth2_client_credentials_tokens or oauth2_start_flow. (#1186)

• The default GlobusAPIError.code value is now None
  when code is not supplied in the error body.
  Previously, the default was "Error". (#1190)

• The default TimersAPIError.code value is now None
  when an error which appears to be validation-related has no code.
  Previously, the default was "ValidationError". (#1191)

• SDK client classes no longer define nor prepend a base_path attribute to paths.
  Make sure to use the full path now when using client methods. (#1185)

• Updated MappedCollectionDoc and GuestCollectionDoc with MissingType. (#1189)

v3.56.1

Fixed

• Fix the type annotation on filter_roles for FlowsClient to allow non-list iterables. (#1183 )

v3.56.0

Added

• Transport objects now provide a close() method for closing resources which
  belong to them, primarily the underlying session. (#1171)

• Add activity_notification_policy to GuestCollectionDocument,
  associating it with GCS collection document version 1.14.0. (#1172)

• FlowsClient.list_flows and FlowsClient.list_runs now support the
  filter_roles parameter to filter results by one or more roles. (#1174)

• AuthLoginClient now supports a session_message when constructing an
  OAuth2 authorization URL. (#1179)

• LoginFlowManager will now use a session_message present in the
  supplied GlobusAuthorizationParameters as part of the login flow. (#1179)

Changed

• When parsing GAREs using to_gare and to_gares, the root document is
  now considered a possible location for a GARE when subdocument errors are
  present on a GlobusAPIError object. Previously, the root document would
  only be considered in the absence of subdocument errors. (#1173)

Deprecated

• filter_role parameter for FlowsClient.list_flows is deprecated. Use
  filter_roles instead. (#1174)

v3.55.0

Added

• FlowsClient.create_flow and FlowsClient.update_flow now support run_managers and run_monitors. (#1164)

• SpecificFlowClient.run_flow() now supports activity_notification_policy as an argument, allowing users to select when their run will notify them. A new helper, RunActivityNotificationPolicy, makes construction of valid policies easier. (#1167)

Changed

• The initialization of a client with a GlobusApp has been improved and is now available under the public attach_globus_app method on client classes. Attaching an app is only valid for clients which were initialized without an app or authorizer. (#1137)

• When a GlobusApp is used with a client, that client's app_scopes attribute will now always be populated with the scopes that it passed back to the app. (#1137)

v3.54.0

Changed

• Added the optional required_mfa field to AuthClient.create_policy() and
  AuthClient.update_policy() request bodies. (#1159)

v3.53.0

Added

• Index listing in Globus Search is now available via SearchClient.index_list. (#1155)

Changed

• The repr for globus_sdk.gare.GARE has been enhanced to be more informative. (#1156)

Documentation

• New sections on Data Transfer and Session & Consents have been added to the User Guide in the docs.
  Initial docs cover transfer submission, timer creation, deadlines, and reauthentication after session timeouts. (#1150, #1154, #1157)

v3.52.0

Added

• The transport attached to clients now exposes headers as a readable
  and writable dict of headers which will be included in every request.
  Headers provided to the transport's request() method overwrite these, as
  before. (#1140)

Changed

• Updates to X-Globus-Client-Info in RequestsTransport.headers are now
  synchronized via a callback mechanism. Direct manipulations of the infos
  list will not result in headers being updated -- callers wishing to modify
  these data should rely only on the add() and clear() methods of the
  GlobusClientInfo object. (#1140)

• globus_sdk logging no longer emits any INFO-level log messages. All INFO
  messages have been downgraded to DEBUG. (#1146)

Documentation

• The tutorial documentation has been rewritten. (#1145)