dropbox.team – Team

class dropbox.team.ActiveWebSession(session_id=None, user_agent=None, os=None, browser=None, ip_address=None, country=None, created=None, updated=None, expires=None)

Bases: dropbox.team.DeviceSession

Information on active web sessions.

Variables:
__init__(session_id=None, user_agent=None, os=None, browser=None, ip_address=None, country=None, created=None, updated=None, expires=None)

x.__init__(…) initializes x; see help(type(x)) for signature

browser
expires
os
user_agent
class dropbox.team.AddSecondaryEmailResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to add a secondary email to a user. ‘success’ is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod already_owned_by_user(val)

Create an instance of this class set to the already_owned_by_user tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod already_pending(val)

Create an instance of this class set to the already_pending tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
get_already_owned_by_user()

Secondary email is already a verified email for the user.

Only call this if is_already_owned_by_user() is true.

Return type:str
get_already_pending()

Secondary email is already a pending email for the user.

Only call this if is_already_pending() is true.

Return type:str
get_rate_limited()

Too many emails are being sent to this email address. Please try again later.

Only call this if is_rate_limited() is true.

Return type:str
get_reached_limit()

User already has the maximum number of secondary emails allowed.

Only call this if is_reached_limit() is true.

Return type:str
get_success()

Describes a secondary email that was successfully added to a user.

Only call this if is_success() is true.

Return type:secondary_emails.SecondaryEmail
get_too_many_updates()

An error occurred due to conflicting updates. Please try again later.

Only call this if is_too_many_updates() is true.

Return type:str
get_transient_error()

A transient error occurred. Please try again later.

Only call this if is_transient_error() is true.

Return type:str
get_unavailable()

Secondary email is not available to be claimed by the user.

Only call this if is_unavailable() is true.

Return type:str
get_unknown_error()

An unknown error occurred.

Only call this if is_unknown_error() is true.

Return type:str
is_already_owned_by_user()

Check if the union tag is already_owned_by_user.

Return type:bool
is_already_pending()

Check if the union tag is already_pending.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_rate_limited()

Check if the union tag is rate_limited.

Return type:bool
is_reached_limit()

Check if the union tag is reached_limit.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
is_too_many_updates()

Check if the union tag is too_many_updates.

Return type:bool
is_transient_error()

Check if the union tag is transient_error.

Return type:bool
is_unavailable()

Check if the union tag is unavailable.

Return type:bool
is_unknown_error()

Check if the union tag is unknown_error.

Return type:bool
other = AddSecondaryEmailResult(u'other', None)
classmethod rate_limited(val)

Create an instance of this class set to the rate_limited tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod reached_limit(val)

Create an instance of this class set to the reached_limit tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (secondary_emails.SecondaryEmail) –
Return type:AddSecondaryEmailResult
classmethod too_many_updates(val)

Create an instance of this class set to the too_many_updates tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod transient_error(val)

Create an instance of this class set to the transient_error tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod unavailable(val)

Create an instance of this class set to the unavailable tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
classmethod unknown_error(val)

Create an instance of this class set to the unknown_error tag with value val.

Parameters:val (str) –
Return type:AddSecondaryEmailResult
class dropbox.team.AddSecondaryEmailsArg(new_secondary_emails=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.AddSecondaryEmailsArg.new_secondary_emails – List of users and secondary emails to add.
__init__(new_secondary_emails=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_secondary_emails
class dropbox.team.AddSecondaryEmailsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned when adding secondary emails fails.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_other()

Check if the union tag is other.

Return type:bool
is_secondary_emails_disabled()

Check if the union tag is secondary_emails_disabled.

Return type:bool
is_too_many_emails()

Check if the union tag is too_many_emails.

Return type:bool
other = AddSecondaryEmailsError(u'other', None)
secondary_emails_disabled = AddSecondaryEmailsError(u'secondary_emails_disabled', None)
too_many_emails = AddSecondaryEmailsError(u'too_many_emails', None)
class dropbox.team.AddSecondaryEmailsResult(results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.AddSecondaryEmailsResult.results – List of users and secondary email results.
__init__(results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
class dropbox.team.AdminTier(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Describes which team-related admin permissions a user has.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_member_only()

Check if the union tag is member_only.

Return type:bool
is_support_admin()

Check if the union tag is support_admin.

Return type:bool
is_team_admin()

Check if the union tag is team_admin.

Return type:bool
is_user_management_admin()

Check if the union tag is user_management_admin.

Return type:bool
member_only = AdminTier(u'member_only', None)
support_admin = AdminTier(u'support_admin', None)
team_admin = AdminTier(u'team_admin', None)
user_management_admin = AdminTier(u'user_management_admin', None)
class dropbox.team.ApiApp(app_id=None, app_name=None, is_app_folder=None, publisher=None, publisher_url=None, linked=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information on linked third party applications.

Variables:
__init__(app_id=None, app_name=None, is_app_folder=None, publisher=None, publisher_url=None, linked=None)

x.__init__(…) initializes x; see help(type(x)) for signature

app_id
app_name
is_app_folder
linked
publisher
publisher_url
class dropbox.team.BaseDfbReport(start_date=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Base report structure.

Variables:team.BaseDfbReport.start_date – First date present in the results as ‘YYYY-MM-DD’ or None.
__init__(start_date=None)

x.__init__(…) initializes x; see help(type(x)) for signature

start_date
class dropbox.team.BaseTeamFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Base error that all errors for existing team folders should extend.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:val (TeamFolderAccessError) –
Return type:BaseTeamFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:TeamFolderAccessError
get_status_error()

Only call this if is_status_error() is true.

Return type:TeamFolderInvalidStatusError
get_team_shared_dropbox_error()

Only call this if is_team_shared_dropbox_error() is true.

Return type:TeamFolderTeamSharedDropboxError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_status_error()

Check if the union tag is status_error.

Return type:bool
is_team_shared_dropbox_error()

Check if the union tag is team_shared_dropbox_error.

Return type:bool
other = BaseTeamFolderError(u'other', None)
classmethod status_error(val)

Create an instance of this class set to the status_error tag with value val.

Parameters:val (TeamFolderInvalidStatusError) –
Return type:BaseTeamFolderError
classmethod team_shared_dropbox_error(val)

Create an instance of this class set to the team_shared_dropbox_error tag with value val.

Parameters:val (TeamFolderTeamSharedDropboxError) –
Return type:BaseTeamFolderError
class dropbox.team.CustomQuotaError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned when getting member custom quota.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.CustomQuotaError.too_many_users – A maximum of 1000 users can be set for a single call.
is_other()

Check if the union tag is other.

Return type:bool
is_too_many_users()

Check if the union tag is too_many_users.

Return type:bool
other = CustomQuotaError(u'other', None)
too_many_users = CustomQuotaError(u'too_many_users', None)
class dropbox.team.CustomQuotaResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

User custom quota.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_invalid_user()

Invalid user (not in team).

Only call this if is_invalid_user() is true.

Return type:UserSelectorArg
get_success()

User’s custom quota.

Only call this if is_success() is true.

Return type:UserCustomQuotaResult
classmethod invalid_user(val)

Create an instance of this class set to the invalid_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:CustomQuotaResult
is_invalid_user()

Check if the union tag is invalid_user.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = CustomQuotaResult(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (UserCustomQuotaResult) –
Return type:CustomQuotaResult
class dropbox.team.CustomQuotaUsersArg(users=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.CustomQuotaUsersArg.users – List of users.
__init__(users=None)

x.__init__(…) initializes x; see help(type(x)) for signature

users
class dropbox.team.DateRange(start_date=None, end_date=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Input arguments that can be provided for most reports.

Variables:
__init__(start_date=None, end_date=None)

x.__init__(…) initializes x; see help(type(x)) for signature

end_date
start_date
class dropbox.team.DateRangeError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Errors that can originate from problems in input arguments to reports.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = DateRangeError(u'other', None)
class dropbox.team.DeleteSecondaryEmailResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to delete a secondary email address. ‘success’ is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod cannot_remove_primary(val)

Create an instance of this class set to the cannot_remove_primary tag with value val.

Parameters:val (str) –
Return type:DeleteSecondaryEmailResult
get_cannot_remove_primary()

The email address is the primary email address of the user, and cannot be removed.

Only call this if is_cannot_remove_primary() is true.

Return type:str
get_not_found()

The email address was not found for the user.

Only call this if is_not_found() is true.

Return type:str
get_success()

The secondary email was successfully deleted.

Only call this if is_success() is true.

Return type:str
is_cannot_remove_primary()

Check if the union tag is cannot_remove_primary.

Return type:bool
is_not_found()

Check if the union tag is not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
classmethod not_found(val)

Create an instance of this class set to the not_found tag with value val.

Parameters:val (str) –
Return type:DeleteSecondaryEmailResult
other = DeleteSecondaryEmailResult(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (str) –
Return type:DeleteSecondaryEmailResult
class dropbox.team.DeleteSecondaryEmailsArg(emails_to_delete=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.DeleteSecondaryEmailsArg.emails_to_delete – List of users and their secondary emails to delete.
__init__(emails_to_delete=None)

x.__init__(…) initializes x; see help(type(x)) for signature

emails_to_delete
class dropbox.team.DeleteSecondaryEmailsResult(results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
class dropbox.team.DesktopClientSession(session_id=None, host_name=None, client_type=None, client_version=None, platform=None, is_delete_on_unlink_supported=None, ip_address=None, country=None, created=None, updated=None)

Bases: dropbox.team.DeviceSession

Information about linked Dropbox desktop client sessions.

Variables:
__init__(session_id=None, host_name=None, client_type=None, client_version=None, platform=None, is_delete_on_unlink_supported=None, ip_address=None, country=None, created=None, updated=None)

x.__init__(…) initializes x; see help(type(x)) for signature

client_type
client_version
host_name
platform
class dropbox.team.DesktopPlatform(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_linux()

Check if the union tag is linux.

Return type:bool
is_mac()

Check if the union tag is mac.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_windows()

Check if the union tag is windows.

Return type:bool
linux = DesktopPlatform(u'linux', None)
mac = DesktopPlatform(u'mac', None)
other = DesktopPlatform(u'other', None)
windows = DesktopPlatform(u'windows', None)
class dropbox.team.DeviceSession(session_id=None, ip_address=None, country=None, created=None, updated=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(session_id=None, ip_address=None, country=None, created=None, updated=None)

x.__init__(…) initializes x; see help(type(x)) for signature

country
created
ip_address
session_id
updated
class dropbox.team.DeviceSessionArg(session_id=None, team_member_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(session_id=None, team_member_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

session_id
team_member_id
class dropbox.team.DevicesActive(windows=None, macos=None, linux=None, ios=None, android=None, other=None, total=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Each of the items is an array of values, one value per day. The value is the number of devices active within a time window, ending with that day. If there is no data for a day, then the value will be None.

Variables:
__init__(windows=None, macos=None, linux=None, ios=None, android=None, other=None, total=None)

x.__init__(…) initializes x; see help(type(x)) for signature

android
ios
linux
macos
other
total
windows
class dropbox.team.ExcludedUsersListArg(limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Excluded users list argument.

Variables:team.ExcludedUsersListArg.limit – Number of results to return per call.
__init__(limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

limit
class dropbox.team.ExcludedUsersListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Excluded users list continue argument.

Variables:team.ExcludedUsersListContinueArg.cursor – Indicates from what point to get the next set of users.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.ExcludedUsersListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Excluded users list continue error.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ExcludedUsersListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = ExcludedUsersListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = ExcludedUsersListContinueError(u'other', None)
class dropbox.team.ExcludedUsersListError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Excluded users list error.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ExcludedUsersListError.list_error – An error occurred.
is_list_error()

Check if the union tag is list_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
list_error = ExcludedUsersListError(u'list_error', None)
other = ExcludedUsersListError(u'other', None)
class dropbox.team.ExcludedUsersListResult(users=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Excluded users list result.

Variables:
  • team.ExcludedUsersListResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.team_member_space_limits_excluded_users_list_continue() to obtain additional excluded users.
  • team.ExcludedUsersListResult.has_more – Is true if there are additional excluded users that have not been returned yet. An additional call to dropbox.dropbox_client.Dropbox.team_member_space_limits_excluded_users_list_continue() can retrieve them.
__init__(users=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
users
class dropbox.team.ExcludedUsersUpdateArg(users=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Argument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users.

Variables:team.ExcludedUsersUpdateArg.users – List of users to be added/removed.
__init__(users=None)

x.__init__(…) initializes x; see help(type(x)) for signature

users
class dropbox.team.ExcludedUsersUpdateError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Excluded users update error.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_other()

Check if the union tag is other.

Return type:bool
is_too_many_users()

Check if the union tag is too_many_users.

Return type:bool
is_users_not_in_team()

Check if the union tag is users_not_in_team.

Return type:bool
other = ExcludedUsersUpdateError(u'other', None)
too_many_users = ExcludedUsersUpdateError(u'too_many_users', None)
users_not_in_team = ExcludedUsersUpdateError(u'users_not_in_team', None)
class dropbox.team.ExcludedUsersUpdateResult(status=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Excluded users update result.

Variables:team.ExcludedUsersUpdateResult.status – Update status.
__init__(status=None)

x.__init__(…) initializes x; see help(type(x)) for signature

status
class dropbox.team.ExcludedUsersUpdateStatus(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Excluded users update operation status.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ExcludedUsersUpdateStatus.success – Update successful.
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = ExcludedUsersUpdateStatus(u'other', None)
success = ExcludedUsersUpdateStatus(u'success', None)
class dropbox.team.Feature(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

A set of features that a Dropbox Business account may support.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
has_team_file_events = Feature(u'has_team_file_events', None)
has_team_selective_sync = Feature(u'has_team_selective_sync', None)
has_team_shared_dropbox = Feature(u'has_team_shared_dropbox', None)
is_has_team_file_events()

Check if the union tag is has_team_file_events.

Return type:bool
is_has_team_selective_sync()

Check if the union tag is has_team_selective_sync.

Return type:bool
is_has_team_shared_dropbox()

Check if the union tag is has_team_shared_dropbox.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_upload_api_rate_limit()

Check if the union tag is upload_api_rate_limit.

Return type:bool
other = Feature(u'other', None)
upload_api_rate_limit = Feature(u'upload_api_rate_limit', None)
class dropbox.team.FeatureValue(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The values correspond to entries in Feature. You may get different value according to your Dropbox Business plan.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_has_team_file_events()

Only call this if is_has_team_file_events() is true.

Return type:HasTeamFileEventsValue
get_has_team_selective_sync()

Only call this if is_has_team_selective_sync() is true.

Return type:HasTeamSelectiveSyncValue
get_has_team_shared_dropbox()

Only call this if is_has_team_shared_dropbox() is true.

Return type:HasTeamSharedDropboxValue
get_upload_api_rate_limit()

Only call this if is_upload_api_rate_limit() is true.

Return type:UploadApiRateLimitValue
classmethod has_team_file_events(val)

Create an instance of this class set to the has_team_file_events tag with value val.

Parameters:val (HasTeamFileEventsValue) –
Return type:FeatureValue
classmethod has_team_selective_sync(val)

Create an instance of this class set to the has_team_selective_sync tag with value val.

Parameters:val (HasTeamSelectiveSyncValue) –
Return type:FeatureValue
classmethod has_team_shared_dropbox(val)

Create an instance of this class set to the has_team_shared_dropbox tag with value val.

Parameters:val (HasTeamSharedDropboxValue) –
Return type:FeatureValue
is_has_team_file_events()

Check if the union tag is has_team_file_events.

Return type:bool
is_has_team_selective_sync()

Check if the union tag is has_team_selective_sync.

Return type:bool
is_has_team_shared_dropbox()

Check if the union tag is has_team_shared_dropbox.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_upload_api_rate_limit()

Check if the union tag is upload_api_rate_limit.

Return type:bool
other = FeatureValue(u'other', None)
classmethod upload_api_rate_limit(val)

Create an instance of this class set to the upload_api_rate_limit tag with value val.

Parameters:val (UploadApiRateLimitValue) –
Return type:FeatureValue
class dropbox.team.FeaturesGetValuesBatchArg(features=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.FeaturesGetValuesBatchArg.features – A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError.
__init__(features=None)

x.__init__(…) initializes x; see help(type(x)) for signature

features
class dropbox.team.FeaturesGetValuesBatchError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.FeaturesGetValuesBatchError.empty_features_list – At least one Feature must be included in the FeaturesGetValuesBatchArg.features list.
empty_features_list = FeaturesGetValuesBatchError(u'empty_features_list', None)
is_empty_features_list()

Check if the union tag is empty_features_list.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = FeaturesGetValuesBatchError(u'other', None)
class dropbox.team.FeaturesGetValuesBatchResult(values=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(values=None)

x.__init__(…) initializes x; see help(type(x)) for signature

values
class dropbox.team.GetActivityReport(start_date=None, adds=None, edits=None, deletes=None, active_users_28_day=None, active_users_7_day=None, active_users_1_day=None, active_shared_folders_28_day=None, active_shared_folders_7_day=None, active_shared_folders_1_day=None, shared_links_created=None, shared_links_viewed_by_team=None, shared_links_viewed_by_outside_user=None, shared_links_viewed_by_not_logged_in=None, shared_links_viewed_total=None)

Bases: dropbox.team.BaseDfbReport

Activity Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

Variables:
__init__(start_date=None, adds=None, edits=None, deletes=None, active_users_28_day=None, active_users_7_day=None, active_users_1_day=None, active_shared_folders_28_day=None, active_shared_folders_7_day=None, active_shared_folders_1_day=None, shared_links_created=None, shared_links_viewed_by_team=None, shared_links_viewed_by_outside_user=None, shared_links_viewed_by_not_logged_in=None, shared_links_viewed_total=None)

x.__init__(…) initializes x; see help(type(x)) for signature

active_shared_folders_1_day
active_shared_folders_28_day
active_shared_folders_7_day
active_users_1_day
active_users_28_day
active_users_7_day
adds
deletes
edits
class dropbox.team.GetDevicesReport(start_date=None, active_1_day=None, active_7_day=None, active_28_day=None)

Bases: dropbox.team.BaseDfbReport

Devices Report Result. Contains subsections for different time ranges of activity. Each of the items in each subsection of the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

Variables:
__init__(start_date=None, active_1_day=None, active_7_day=None, active_28_day=None)

x.__init__(…) initializes x; see help(type(x)) for signature

active_1_day
active_28_day
active_7_day
class dropbox.team.GetMembershipReport(start_date=None, team_size=None, pending_invites=None, members_joined=None, suspended_members=None, licenses=None)

Bases: dropbox.team.BaseDfbReport

Membership Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

Variables:
__init__(start_date=None, team_size=None, pending_invites=None, members_joined=None, suspended_members=None, licenses=None)

x.__init__(…) initializes x; see help(type(x)) for signature

licenses
members_joined
pending_invites
suspended_members
team_size
class dropbox.team.GetStorageReport(start_date=None, total_usage=None, shared_usage=None, unshared_usage=None, shared_folders=None, member_storage_map=None)

Bases: dropbox.team.BaseDfbReport

Storage Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

Variables:
__init__(start_date=None, total_usage=None, shared_usage=None, unshared_usage=None, shared_folders=None, member_storage_map=None)

x.__init__(…) initializes x; see help(type(x)) for signature

member_storage_map
shared_folders
shared_usage
total_usage
unshared_usage
class dropbox.team.GroupAccessType(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Role of a user in group.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_member()

Check if the union tag is member.

Return type:bool
is_owner()

Check if the union tag is owner.

Return type:bool
member = GroupAccessType(u'member', None)
owner = GroupAccessType(u'owner', None)
class dropbox.team.GroupCreateArg(group_name=None, add_creator_as_owner=None, group_external_id=None, group_management_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(group_name=None, add_creator_as_owner=None, group_external_id=None, group_management_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

add_creator_as_owner
group_external_id
group_management_type
group_name
class dropbox.team.GroupCreateError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
external_id_already_in_use = GroupCreateError(u'external_id_already_in_use', None)
group_name_already_used = GroupCreateError(u'group_name_already_used', None)
group_name_invalid = GroupCreateError(u'group_name_invalid', None)
is_external_id_already_in_use()

Check if the union tag is external_id_already_in_use.

Return type:bool
is_group_name_already_used()

Check if the union tag is group_name_already_used.

Return type:bool
is_group_name_invalid()

Check if the union tag is group_name_invalid.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_system_managed_group_disallowed()

Check if the union tag is system_managed_group_disallowed.

Return type:bool
other = GroupCreateError(u'other', None)
system_managed_group_disallowed = GroupCreateError(u'system_managed_group_disallowed', None)
class dropbox.team.GroupDeleteError(tag, value=None)

Bases: dropbox.team.GroupSelectorWithTeamGroupError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupDeleteError.group_already_deleted – This group has already been deleted.
group_already_deleted = GroupDeleteError(u'group_already_deleted', None)
is_group_already_deleted()

Check if the union tag is group_already_deleted.

Return type:bool
class dropbox.team.GroupFullInfo(group_name=None, group_id=None, group_management_type=None, created=None, group_external_id=None, member_count=None, members=None)

Bases: dropbox.team_common.GroupSummary

Full description of a group.

Variables:
__init__(group_name=None, group_id=None, group_management_type=None, created=None, group_external_id=None, member_count=None, members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

created
members
class dropbox.team.GroupMemberInfo(profile=None, access_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Profile of group member, and role in group.

Variables:
__init__(profile=None, access_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type
profile
class dropbox.team.GroupMemberSelector(group=None, user=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Argument for selecting a group and a single user.

Variables:
__init__(group=None, user=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
user
class dropbox.team.GroupMemberSelectorError(tag, value=None)

Bases: dropbox.team.GroupSelectorWithTeamGroupError

Error that can be raised when GroupMemberSelector is used, and the user is required to be a member of the specified group.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupMemberSelectorError.member_not_in_group – The specified user is not a member of this group.
is_member_not_in_group()

Check if the union tag is member_not_in_group.

Return type:bool
member_not_in_group = GroupMemberSelectorError(u'member_not_in_group', None)
class dropbox.team.GroupMemberSetAccessTypeError(tag, value=None)

Bases: dropbox.team.GroupMemberSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar
team.GroupMemberSetAccessTypeError.user_cannot_be_manager_of_company_managed_group: A company managed group cannot be managed by a user.
is_user_cannot_be_manager_of_company_managed_group()

Check if the union tag is user_cannot_be_manager_of_company_managed_group.

Return type:bool
user_cannot_be_manager_of_company_managed_group = GroupMemberSetAccessTypeError(u'user_cannot_be_manager_of_company_managed_group', None)
class dropbox.team.GroupMembersAddArg(group=None, members=None, return_members=None)

Bases: dropbox.team.IncludeMembersArg

Variables:
__init__(group=None, members=None, return_members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
members
class dropbox.team.GroupMembersAddError(tag, value=None)

Bases: dropbox.team.GroupSelectorWithTeamGroupError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
:ivar list of [str]
team.GroupMembersAddError.user_cannot_be_manager_of_company_managed_group: A company-managed group cannot be managed by a user.
duplicate_user = GroupMembersAddError(u'duplicate_user', None)
get_members_not_in_team()

These members are not part of your team. Currently, you cannot add members to a group if they are not part of your team, though this may change in a subsequent version. To add new members to your Dropbox Business team, use the dropbox.dropbox_client.Dropbox.team_members_add() endpoint.

Only call this if is_members_not_in_team() is true.

Return type:list of [str]
get_user_cannot_be_manager_of_company_managed_group()

A company-managed group cannot be managed by a user.

Only call this if is_user_cannot_be_manager_of_company_managed_group() is true.

Return type:list of [str]
get_users_not_found()

These users were not found in Dropbox.

Only call this if is_users_not_found() is true.

Return type:list of [str]
group_not_in_team = GroupMembersAddError(u'group_not_in_team', None)
is_duplicate_user()

Check if the union tag is duplicate_user.

Return type:bool
is_group_not_in_team()

Check if the union tag is group_not_in_team.

Return type:bool
is_members_not_in_team()

Check if the union tag is members_not_in_team.

Return type:bool
is_user_cannot_be_manager_of_company_managed_group()

Check if the union tag is user_cannot_be_manager_of_company_managed_group.

Return type:bool
is_user_must_be_active_to_be_owner()

Check if the union tag is user_must_be_active_to_be_owner.

Return type:bool
is_users_not_found()

Check if the union tag is users_not_found.

Return type:bool
classmethod members_not_in_team(val)

Create an instance of this class set to the members_not_in_team tag with value val.

Parameters:of [str] val (list) –
Return type:GroupMembersAddError
classmethod user_cannot_be_manager_of_company_managed_group(val)

Create an instance of this class set to the user_cannot_be_manager_of_company_managed_group tag with value val.

Parameters:of [str] val (list) –
Return type:GroupMembersAddError
user_must_be_active_to_be_owner = GroupMembersAddError(u'user_must_be_active_to_be_owner', None)
classmethod users_not_found(val)

Create an instance of this class set to the users_not_found tag with value val.

Parameters:of [str] val (list) –
Return type:GroupMembersAddError
class dropbox.team.GroupMembersChangeResult(group_info=None, async_job_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Result returned by dropbox.dropbox_client.Dropbox.team_groups_members_add() and dropbox.dropbox_client.Dropbox.team_groups_members_remove().

Variables:
  • team.GroupMembersChangeResult.group_info – The group info after member change operation has been performed.
  • team.GroupMembersChangeResult.async_job_id – For legacy purposes async_job_id will always return one space ‘ ‘. Formerly, it was an ID that was used to obtain the status of granting/revoking group-owned resources. It’s no longer necessary because the async processing now happens automatically.
__init__(group_info=None, async_job_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

async_job_id
group_info
class dropbox.team.GroupMembersRemoveArg(group=None, users=None, return_members=None)

Bases: dropbox.team.IncludeMembersArg

Variables:
__init__(group=None, users=None, return_members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
users
class dropbox.team.GroupMembersRemoveError(tag, value=None)

Bases: dropbox.team.GroupMembersSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_members_not_in_team()

These members are not part of your team.

Only call this if is_members_not_in_team() is true.

Return type:list of [str]
get_users_not_found()

These users were not found in Dropbox.

Only call this if is_users_not_found() is true.

Return type:list of [str]
group_not_in_team = GroupMembersRemoveError(u'group_not_in_team', None)
is_group_not_in_team()

Check if the union tag is group_not_in_team.

Return type:bool
is_members_not_in_team()

Check if the union tag is members_not_in_team.

Return type:bool
is_users_not_found()

Check if the union tag is users_not_found.

Return type:bool
classmethod members_not_in_team(val)

Create an instance of this class set to the members_not_in_team tag with value val.

Parameters:of [str] val (list) –
Return type:GroupMembersRemoveError
classmethod users_not_found(val)

Create an instance of this class set to the users_not_found tag with value val.

Parameters:of [str] val (list) –
Return type:GroupMembersRemoveError
class dropbox.team.GroupMembersSelector(group=None, users=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Argument for selecting a group and a list of users.

Variables:
__init__(group=None, users=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
users
class dropbox.team.GroupMembersSelectorError(tag, value=None)

Bases: dropbox.team.GroupSelectorWithTeamGroupError

Error that can be raised when GroupMembersSelector is used, and the users are required to be members of the specified group.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupMembersSelectorError.member_not_in_group – At least one of the specified users is not a member of the group.
is_member_not_in_group()

Check if the union tag is member_not_in_group.

Return type:bool
member_not_in_group = GroupMembersSelectorError(u'member_not_in_group', None)
class dropbox.team.GroupMembersSetAccessTypeArg(group=None, user=None, access_type=None, return_members=None)

Bases: dropbox.team.GroupMemberSelector

Variables:
__init__(group=None, user=None, access_type=None, return_members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type
return_members
class dropbox.team.GroupSelector(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Argument for selecting a single group, either by group_id or by external group ID.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_group_external_id()

External ID of the group.

Only call this if is_group_external_id() is true.

Return type:str
get_group_id()

Group ID.

Only call this if is_group_id() is true.

Return type:str
classmethod group_external_id(val)

Create an instance of this class set to the group_external_id tag with value val.

Parameters:val (str) –
Return type:GroupSelector
classmethod group_id(val)

Create an instance of this class set to the group_id tag with value val.

Parameters:val (str) –
Return type:GroupSelector
is_group_external_id()

Check if the union tag is group_external_id.

Return type:bool
is_group_id()

Check if the union tag is group_id.

Return type:bool
class dropbox.team.GroupSelectorError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error that can be raised when GroupSelector is used.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupSelectorError.group_not_found – No matching group found. No groups match the specified group ID.
group_not_found = GroupSelectorError(u'group_not_found', None)
is_group_not_found()

Check if the union tag is group_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = GroupSelectorError(u'other', None)
class dropbox.team.GroupSelectorWithTeamGroupError(tag, value=None)

Bases: dropbox.team.GroupSelectorError

Error that can be raised when GroupSelector is used and team groups are disallowed from being used.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupSelectorWithTeamGroupError.system_managed_group_disallowed – This operation is not supported on system-managed groups.
is_system_managed_group_disallowed()

Check if the union tag is system_managed_group_disallowed.

Return type:bool
system_managed_group_disallowed = GroupSelectorWithTeamGroupError(u'system_managed_group_disallowed', None)
class dropbox.team.GroupUpdateArgs(group=None, return_members=None, new_group_name=None, new_group_external_id=None, new_group_management_type=None)

Bases: dropbox.team.IncludeMembersArg

Variables:
__init__(group=None, return_members=None, new_group_name=None, new_group_external_id=None, new_group_management_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
new_group_external_id
new_group_management_type
new_group_name
class dropbox.team.GroupUpdateError(tag, value=None)

Bases: dropbox.team.GroupSelectorWithTeamGroupError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
external_id_already_in_use = GroupUpdateError(u'external_id_already_in_use', None)
group_name_already_used = GroupUpdateError(u'group_name_already_used', None)
group_name_invalid = GroupUpdateError(u'group_name_invalid', None)
is_external_id_already_in_use()

Check if the union tag is external_id_already_in_use.

Return type:bool
is_group_name_already_used()

Check if the union tag is group_name_already_used.

Return type:bool
is_group_name_invalid()

Check if the union tag is group_name_invalid.

Return type:bool
class dropbox.team.GroupsGetInfoError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupsGetInfoError.group_not_on_team – The group is not on your team.
group_not_on_team = GroupsGetInfoError(u'group_not_on_team', None)
is_group_not_on_team()

Check if the union tag is group_not_on_team.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = GroupsGetInfoError(u'other', None)
class dropbox.team.GroupsGetInfoItem(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_group_info()

Info about a group.

Only call this if is_group_info() is true.

Return type:GroupFullInfo
get_id_not_found()

An ID that was provided as a parameter to dropbox.dropbox_client.Dropbox.team_groups_get_info(), and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.

Only call this if is_id_not_found() is true.

Return type:str
classmethod group_info(val)

Create an instance of this class set to the group_info tag with value val.

Parameters:val (GroupFullInfo) –
Return type:GroupsGetInfoItem
classmethod id_not_found(val)

Create an instance of this class set to the id_not_found tag with value val.

Parameters:val (str) –
Return type:GroupsGetInfoItem
is_group_info()

Check if the union tag is group_info.

Return type:bool
is_id_not_found()

Check if the union tag is id_not_found.

Return type:bool
class dropbox.team.GroupsListArg(limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.GroupsListArg.limit – Number of results to return per call.
__init__(limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

limit
class dropbox.team.GroupsListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.GroupsListContinueArg.cursor – Indicates from what point to get the next set of groups.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.GroupsListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupsListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = GroupsListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = GroupsListContinueError(u'other', None)
class dropbox.team.GroupsListResult(groups=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • team.GroupsListResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.team_groups_list_continue() to obtain the additional groups.
  • team.GroupsListResult.has_more – Is true if there are additional groups that have not been returned yet. An additional call to dropbox.dropbox_client.Dropbox.team_groups_list_continue() can retrieve them.
__init__(groups=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
groups
has_more
class dropbox.team.GroupsMembersListArg(group=None, limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(group=None, limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

group
limit
class dropbox.team.GroupsMembersListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.GroupsMembersListContinueArg.cursor – Indicates from what point to get the next set of groups.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.GroupsMembersListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupsMembersListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = GroupsMembersListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = GroupsMembersListContinueError(u'other', None)
class dropbox.team.GroupsMembersListResult(members=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • team.GroupsMembersListResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.team_groups_members_list_continue() to obtain additional group members.
  • team.GroupsMembersListResult.has_more – Is true if there are additional group members that have not been returned yet. An additional call to dropbox.dropbox_client.Dropbox.team_groups_members_list_continue() can retrieve them.
__init__(members=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
members
class dropbox.team.GroupsPollError(tag, value=None)

Bases: dropbox.async_.PollError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.GroupsPollError.access_denied – You are not allowed to poll this job.
access_denied = GroupsPollError(u'access_denied', None)
is_access_denied()

Check if the union tag is access_denied.

Return type:bool
class dropbox.team.GroupsSelector(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Argument for selecting a list of groups, either by group_ids, or external group IDs.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_group_external_ids()

List of external IDs of groups.

Only call this if is_group_external_ids() is true.

Return type:list of [str]
get_group_ids()

List of group IDs.

Only call this if is_group_ids() is true.

Return type:list of [str]
classmethod group_external_ids(val)

Create an instance of this class set to the group_external_ids tag with value val.

Parameters:of [str] val (list) –
Return type:GroupsSelector
classmethod group_ids(val)

Create an instance of this class set to the group_ids tag with value val.

Parameters:of [str] val (list) –
Return type:GroupsSelector
is_group_external_ids()

Check if the union tag is group_external_ids.

Return type:bool
is_group_ids()

Check if the union tag is group_ids.

Return type:bool
class dropbox.team.HasTeamFileEventsValue(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The value for Feature.has_team_file_events.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.HasTeamFileEventsValue.enabled (bool) – Does this team have file events.
classmethod enabled(val)

Create an instance of this class set to the enabled tag with value val.

Parameters:val (bool) –
Return type:HasTeamFileEventsValue
get_enabled()

Does this team have file events.

Only call this if is_enabled() is true.

Return type:bool
is_enabled()

Check if the union tag is enabled.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = HasTeamFileEventsValue(u'other', None)
class dropbox.team.HasTeamSelectiveSyncValue(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The value for Feature.has_team_selective_sync.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.HasTeamSelectiveSyncValue.has_team_selective_sync (bool) – Does this team have team selective sync enabled.
get_has_team_selective_sync()

Does this team have team selective sync enabled.

Only call this if is_has_team_selective_sync() is true.

Return type:bool
classmethod has_team_selective_sync(val)

Create an instance of this class set to the has_team_selective_sync tag with value val.

Parameters:val (bool) –
Return type:HasTeamSelectiveSyncValue
is_has_team_selective_sync()

Check if the union tag is has_team_selective_sync.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = HasTeamSelectiveSyncValue(u'other', None)
class dropbox.team.HasTeamSharedDropboxValue(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The value for Feature.has_team_shared_dropbox.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.HasTeamSharedDropboxValue.has_team_shared_dropbox (bool) – Does this team have a shared team root.
get_has_team_shared_dropbox()

Does this team have a shared team root.

Only call this if is_has_team_shared_dropbox() is true.

Return type:bool
classmethod has_team_shared_dropbox(val)

Create an instance of this class set to the has_team_shared_dropbox tag with value val.

Parameters:val (bool) –
Return type:HasTeamSharedDropboxValue
is_has_team_shared_dropbox()

Check if the union tag is has_team_shared_dropbox.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = HasTeamSharedDropboxValue(u'other', None)
class dropbox.team.IncludeMembersArg(return_members=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.IncludeMembersArg.return_members – Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.
__init__(return_members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

return_members
class dropbox.team.LegalHoldHeldRevisionMetadata(new_filename=None, original_revision_id=None, original_file_path=None, server_modified=None, author_member_id=None, author_member_status=None, author_email=None, file_type=None, size=None, content_hash=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(new_filename=None, original_revision_id=None, original_file_path=None, server_modified=None, author_member_id=None, author_member_status=None, author_email=None, file_type=None, size=None, content_hash=None)

x.__init__(…) initializes x; see help(type(x)) for signature

author_email
author_member_id
author_member_status
content_hash
file_type
new_filename
original_file_path
original_revision_id
server_modified
size
class dropbox.team.LegalHoldPolicy(id=None, name=None, members=None, status=None, start_date=None, description=None, activation_time=None, end_date=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(id=None, name=None, members=None, status=None, start_date=None, description=None, activation_time=None, end_date=None)

x.__init__(…) initializes x; see help(type(x)) for signature

activation_time
description
end_date
id
members
name
start_date
status
class dropbox.team.LegalHoldStatus(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
activating = LegalHoldStatus(u'activating', None)
active = LegalHoldStatus(u'active', None)
exporting = LegalHoldStatus(u'exporting', None)
is_activating()

Check if the union tag is activating.

Return type:bool
is_active()

Check if the union tag is active.

Return type:bool
is_exporting()

Check if the union tag is exporting.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_released()

Check if the union tag is released.

Return type:bool
is_releasing()

Check if the union tag is releasing.

Return type:bool
is_updating()

Check if the union tag is updating.

Return type:bool
other = LegalHoldStatus(u'other', None)
released = LegalHoldStatus(u'released', None)
releasing = LegalHoldStatus(u'releasing', None)
updating = LegalHoldStatus(u'updating', None)
class dropbox.team.LegalHoldsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
insufficient_permissions = LegalHoldsError(u'insufficient_permissions', None)
is_insufficient_permissions()

Check if the union tag is insufficient_permissions.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool

Check if the union tag is unknown_legal_hold_error.

Return type:bool
other = LegalHoldsError(u'other', None)
class dropbox.team.LegalHoldsGetPolicyArg(id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.LegalHoldsGetPolicyArg.id – The legal hold Id.
__init__(id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

id
class dropbox.team.LegalHoldsGetPolicyError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.LegalHoldsGetPolicyError.legal_hold_policy_not_found – Legal hold policy does not exist for LegalHoldsGetPolicyArg.id.

Check if the union tag is legal_hold_policy_not_found.

Return type:bool
legal_hold_policy_not_found = LegalHoldsGetPolicyError(u'legal_hold_policy_not_found', None)
dropbox.team.LegalHoldsGetPolicyResult

alias of dropbox.team.LegalHoldPolicy

class dropbox.team.LegalHoldsListHeldRevisionResult(entries=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(entries=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
entries
has_more
class dropbox.team.LegalHoldsListHeldRevisionsArg(id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.LegalHoldsListHeldRevisionsArg.id – The legal hold Id.
__init__(id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

id
class dropbox.team.LegalHoldsListHeldRevisionsContinueArg(id=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(id=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
id
class dropbox.team.LegalHoldsListHeldRevisionsContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar
team.LegalHoldsListHeldRevisionsContinueError.unknown_legal_hold_error: There has been an unknown legal hold error.
Variables:
is_other()

Check if the union tag is other.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
is_transient_error()

Check if the union tag is transient_error.

Return type:bool

Check if the union tag is unknown_legal_hold_error.

Return type:bool
other = LegalHoldsListHeldRevisionsContinueError(u'other', None)
reset = LegalHoldsListHeldRevisionsContinueError(u'reset', None)
transient_error = LegalHoldsListHeldRevisionsContinueError(u'transient_error', None)
class dropbox.team.LegalHoldsListHeldRevisionsError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

Check if the union tag is inactive_legal_hold.

Return type:bool

Check if the union tag is legal_hold_still_empty.

Return type:bool
is_transient_error()

Check if the union tag is transient_error.

Return type:bool
legal_hold_still_empty = LegalHoldsListHeldRevisionsError(u'legal_hold_still_empty', None)
transient_error = LegalHoldsListHeldRevisionsError(u'transient_error', None)
class dropbox.team.LegalHoldsListPoliciesArg(include_released=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.LegalHoldsListPoliciesArg.include_released – Whether to return holds that were released.
__init__(include_released=None)

x.__init__(…) initializes x; see help(type(x)) for signature

include_released
class dropbox.team.LegalHoldsListPoliciesError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.LegalHoldsListPoliciesError.transient_error – Temporary infrastructure failure, please retry.
is_transient_error()

Check if the union tag is transient_error.

Return type:bool
transient_error = LegalHoldsListPoliciesError(u'transient_error', None)
class dropbox.team.LegalHoldsListPoliciesResult(policies=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(policies=None)

x.__init__(…) initializes x; see help(type(x)) for signature

policies
class dropbox.team.LegalHoldsPolicyCreateArg(name=None, members=None, description=None, start_date=None, end_date=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(name=None, members=None, description=None, start_date=None, end_date=None)

x.__init__(…) initializes x; see help(type(x)) for signature

description
end_date
members
name
start_date
class dropbox.team.LegalHoldsPolicyCreateError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
:ivar
team.LegalHoldsPolicyCreateError.number_of_users_on_hold_is_greater_than_hold_limitation: You cannot add more than 5 users in a legal hold.
Variables:
empty_members_list = LegalHoldsPolicyCreateError(u'empty_members_list', None)
invalid_date = LegalHoldsPolicyCreateError(u'invalid_date', None)
invalid_members = LegalHoldsPolicyCreateError(u'invalid_members', None)
is_empty_members_list()

Check if the union tag is empty_members_list.

Return type:bool
is_invalid_date()

Check if the union tag is invalid_date.

Return type:bool
is_invalid_members()

Check if the union tag is invalid_members.

Return type:bool
is_name_must_be_unique()

Check if the union tag is name_must_be_unique.

Return type:bool
is_number_of_users_on_hold_is_greater_than_hold_limitation()

Check if the union tag is number_of_users_on_hold_is_greater_than_hold_limitation.

Return type:bool
is_start_date_is_later_than_end_date()

Check if the union tag is start_date_is_later_than_end_date.

Return type:bool

Check if the union tag is team_exceeded_legal_hold_quota.

Return type:bool
is_transient_error()

Check if the union tag is transient_error.

Return type:bool
name_must_be_unique = LegalHoldsPolicyCreateError(u'name_must_be_unique', None)
number_of_users_on_hold_is_greater_than_hold_limitation = LegalHoldsPolicyCreateError(u'number_of_users_on_hold_is_greater_than_hold_limitation', None)
start_date_is_later_than_end_date = LegalHoldsPolicyCreateError(u'start_date_is_later_than_end_date', None)
transient_error = LegalHoldsPolicyCreateError(u'transient_error', None)
dropbox.team.LegalHoldsPolicyCreateResult

alias of dropbox.team.LegalHoldPolicy

class dropbox.team.LegalHoldsPolicyReleaseArg(id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.LegalHoldsPolicyReleaseArg.id – The legal hold Id.
__init__(id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

id
class dropbox.team.LegalHoldsPolicyReleaseError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar
team.LegalHoldsPolicyReleaseError.legal_hold_performing_another_operation: Legal hold is currently performing another operation.
Variables:

Check if the union tag is legal_hold_already_releasing.

Return type:bool

Check if the union tag is legal_hold_performing_another_operation.

Return type:bool

Check if the union tag is legal_hold_policy_not_found.

Return type:bool
legal_hold_already_releasing = LegalHoldsPolicyReleaseError(u'legal_hold_already_releasing', None)
legal_hold_performing_another_operation = LegalHoldsPolicyReleaseError(u'legal_hold_performing_another_operation', None)
legal_hold_policy_not_found = LegalHoldsPolicyReleaseError(u'legal_hold_policy_not_found', None)
class dropbox.team.LegalHoldsPolicyUpdateArg(id=None, name=None, description=None, members=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(id=None, name=None, description=None, members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

description
id
members
name
class dropbox.team.LegalHoldsPolicyUpdateError(tag, value=None)

Bases: dropbox.team.LegalHoldsError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
:ivar
team.LegalHoldsPolicyUpdateError.legal_hold_performing_another_operation: Legal hold is currently performing another operation.
Variables:team.LegalHoldsPolicyUpdateError.invalid_members – Some members in the members list are not valid to be placed under legal hold.
:ivar
team.LegalHoldsPolicyUpdateError.number_of_users_on_hold_is_greater_than_hold_limitation: You cannot add more than 5 users in a legal hold.
Variables:
empty_members_list = LegalHoldsPolicyUpdateError(u'empty_members_list', None)
invalid_members = LegalHoldsPolicyUpdateError(u'invalid_members', None)
is_empty_members_list()

Check if the union tag is empty_members_list.

Return type:bool

Check if the union tag is inactive_legal_hold.

Return type:bool
is_invalid_members()

Check if the union tag is invalid_members.

Return type:bool

Check if the union tag is legal_hold_performing_another_operation.

Return type:bool

Check if the union tag is legal_hold_policy_not_found.

Return type:bool
is_name_must_be_unique()

Check if the union tag is name_must_be_unique.

Return type:bool
is_number_of_users_on_hold_is_greater_than_hold_limitation()

Check if the union tag is number_of_users_on_hold_is_greater_than_hold_limitation.

Return type:bool
is_transient_error()

Check if the union tag is transient_error.

Return type:bool
legal_hold_performing_another_operation = LegalHoldsPolicyUpdateError(u'legal_hold_performing_another_operation', None)
legal_hold_policy_not_found = LegalHoldsPolicyUpdateError(u'legal_hold_policy_not_found', None)
name_must_be_unique = LegalHoldsPolicyUpdateError(u'name_must_be_unique', None)
number_of_users_on_hold_is_greater_than_hold_limitation = LegalHoldsPolicyUpdateError(u'number_of_users_on_hold_is_greater_than_hold_limitation', None)
transient_error = LegalHoldsPolicyUpdateError(u'transient_error', None)
dropbox.team.LegalHoldsPolicyUpdateResult

alias of dropbox.team.LegalHoldPolicy

class dropbox.team.ListMemberAppsArg(team_member_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.ListMemberAppsArg.team_member_id – The team member id.
__init__(team_member_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

team_member_id
class dropbox.team.ListMemberAppsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_linked_apps_list_member_linked_apps().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListMemberAppsError.member_not_found – Member not found.
is_member_not_found()

Check if the union tag is member_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
member_not_found = ListMemberAppsError(u'member_not_found', None)
other = ListMemberAppsError(u'other', None)
class dropbox.team.ListMemberAppsResult(linked_api_apps=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.ListMemberAppsResult.linked_api_apps – List of third party applications linked by this team member.
__init__(linked_api_apps=None)

x.__init__(…) initializes x; see help(type(x)) for signature

linked_api_apps
class dropbox.team.ListMemberDevicesArg(team_member_id=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(team_member_id=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

x.__init__(…) initializes x; see help(type(x)) for signature

include_desktop_clients
include_mobile_clients
include_web_sessions
team_member_id
class dropbox.team.ListMemberDevicesError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListMemberDevicesError.member_not_found – Member not found.
is_member_not_found()

Check if the union tag is member_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
member_not_found = ListMemberDevicesError(u'member_not_found', None)
other = ListMemberDevicesError(u'other', None)
class dropbox.team.ListMemberDevicesResult(active_web_sessions=None, desktop_client_sessions=None, mobile_client_sessions=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(active_web_sessions=None, desktop_client_sessions=None, mobile_client_sessions=None)

x.__init__(…) initializes x; see help(type(x)) for signature

active_web_sessions
desktop_client_sessions
mobile_client_sessions
class dropbox.team.ListMembersAppsArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.team_linked_apps_list_members_linked_apps().

Variables:team.ListMembersAppsArg.cursor – At the first call to the dropbox.dropbox_client.Dropbox.team_linked_apps_list_members_linked_apps() the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.ListMembersAppsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_linked_apps_list_members_linked_apps().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListMembersAppsError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.team_linked_apps_list_members_linked_apps() again with an empty cursor to obtain a new cursor.
is_other()

Check if the union tag is other.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
other = ListMembersAppsError(u'other', None)
reset = ListMembersAppsError(u'reset', None)
class dropbox.team.ListMembersAppsResult(apps=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information returned by dropbox.dropbox_client.Dropbox.team_linked_apps_list_members_linked_apps().

Variables:
__init__(apps=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

apps
cursor
has_more
class dropbox.team.ListMembersDevicesArg(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
include_desktop_clients
include_mobile_clients
include_web_sessions
class dropbox.team.ListMembersDevicesError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListMembersDevicesError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.team_devices_list_members_devices() again with an empty cursor to obtain a new cursor.
is_other()

Check if the union tag is other.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
other = ListMembersDevicesError(u'other', None)
reset = ListMembersDevicesError(u'reset', None)
class dropbox.team.ListMembersDevicesResult(devices=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(devices=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
devices
has_more
class dropbox.team.ListTeamAppsArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps().

Variables:team.ListTeamAppsArg.cursor – At the first call to the dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps() the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.ListTeamAppsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListTeamAppsError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps() again with an empty cursor to obtain a new cursor.
is_other()

Check if the union tag is other.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
other = ListTeamAppsError(u'other', None)
reset = ListTeamAppsError(u'reset', None)
class dropbox.team.ListTeamAppsResult(apps=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information returned by dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps().

Variables:
  • team.ListTeamAppsResult.apps – The linked applications of each member of the team.
  • team.ListTeamAppsResult.has_more – If true, then there are more apps available. Pass the cursor to dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps() to retrieve the rest.
  • team.ListTeamAppsResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.team_linked_apps_list_team_linked_apps() to receive the next sub list of team’s applications.
__init__(apps=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

apps
cursor
has_more
class dropbox.team.ListTeamDevicesArg(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
include_desktop_clients
include_mobile_clients
include_web_sessions
class dropbox.team.ListTeamDevicesError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.ListTeamDevicesError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.team_devices_list_team_devices() again with an empty cursor to obtain a new cursor.
is_other()

Check if the union tag is other.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
other = ListTeamDevicesError(u'other', None)
reset = ListTeamDevicesError(u'reset', None)
class dropbox.team.ListTeamDevicesResult(devices=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(devices=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
devices
has_more
class dropbox.team.MemberAccess(user=None, access_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Specify access type a member should have when joined to a group.

Variables:
__init__(user=None, access_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type
user
class dropbox.team.MemberAddArg(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None, role=None)

Bases: dropbox.team.MemberAddArgBase

__init__(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None, role=None)

x.__init__(…) initializes x; see help(type(x)) for signature

role
class dropbox.team.MemberAddArgBase(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None)

x.__init__(…) initializes x; see help(type(x)) for signature

is_directory_restricted
member_email
member_external_id
member_given_name
member_persistent_id
member_surname
send_welcome_email
class dropbox.team.MemberAddResult(tag, value=None)

Bases: dropbox.team.MemberAddResultBase

Describes the result of attempting to add a single user to the team. ‘success’ is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:MemberAddResult.success (TeamMemberInfo) – Describes a user that was successfully added to the team.
get_success()

Describes a user that was successfully added to the team.

Only call this if is_success() is true.

Return type:TeamMemberInfo
is_success()

Check if the union tag is success.

Return type:bool
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (TeamMemberInfo) –
Return type:MemberAddResult
class dropbox.team.MemberAddResultBase(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod duplicate_external_member_id(val)

Create an instance of this class set to the duplicate_external_member_id tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod duplicate_member_persistent_id(val)

Create an instance of this class set to the duplicate_member_persistent_id tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod free_team_member_limit_reached(val)

Create an instance of this class set to the free_team_member_limit_reached tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
get_duplicate_external_member_id()

A user with the given external member ID already exists on the team (including in recoverable state).

Only call this if is_duplicate_external_member_id() is true.

Return type:str
get_duplicate_member_persistent_id()

A user with the given persistent ID already exists on the team (including in recoverable state).

Only call this if is_duplicate_member_persistent_id() is true.

Return type:str
get_free_team_member_limit_reached()

Team is already full. The free team member limit has been reached.

Only call this if is_free_team_member_limit_reached() is true.

Return type:str
get_persistent_id_disabled()

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

Only call this if is_persistent_id_disabled() is true.

Return type:str
get_team_license_limit()

Team is already full. The organization has no available licenses.

Only call this if is_team_license_limit() is true.

Return type:str
get_user_already_on_team()

User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

Only call this if is_user_already_on_team() is true.

Return type:str
get_user_already_paired()

User is already paired.

Only call this if is_user_already_paired() is true.

Return type:str
get_user_creation_failed()

User creation has failed.

Only call this if is_user_creation_failed() is true.

Return type:str
get_user_migration_failed()

User migration has failed.

Only call this if is_user_migration_failed() is true.

Return type:str
get_user_on_another_team()

User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

Only call this if is_user_on_another_team() is true.

Return type:str
is_duplicate_external_member_id()

Check if the union tag is duplicate_external_member_id.

Return type:bool
is_duplicate_member_persistent_id()

Check if the union tag is duplicate_member_persistent_id.

Return type:bool
is_free_team_member_limit_reached()

Check if the union tag is free_team_member_limit_reached.

Return type:bool
is_persistent_id_disabled()

Check if the union tag is persistent_id_disabled.

Return type:bool
is_team_license_limit()

Check if the union tag is team_license_limit.

Return type:bool
is_user_already_on_team()

Check if the union tag is user_already_on_team.

Return type:bool
is_user_already_paired()

Check if the union tag is user_already_paired.

Return type:bool
is_user_creation_failed()

Check if the union tag is user_creation_failed.

Return type:bool
is_user_migration_failed()

Check if the union tag is user_migration_failed.

Return type:bool
is_user_on_another_team()

Check if the union tag is user_on_another_team.

Return type:bool
classmethod persistent_id_disabled(val)

Create an instance of this class set to the persistent_id_disabled tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod team_license_limit(val)

Create an instance of this class set to the team_license_limit tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod user_already_on_team(val)

Create an instance of this class set to the user_already_on_team tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod user_already_paired(val)

Create an instance of this class set to the user_already_paired tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod user_creation_failed(val)

Create an instance of this class set to the user_creation_failed tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod user_migration_failed(val)

Create an instance of this class set to the user_migration_failed tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
classmethod user_on_another_team(val)

Create an instance of this class set to the user_on_another_team tag with value val.

Parameters:val (str) –
Return type:MemberAddResultBase
class dropbox.team.MemberAddV2Arg(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None, role_ids=None)

Bases: dropbox.team.MemberAddArgBase

__init__(member_email=None, member_given_name=None, member_surname=None, member_external_id=None, member_persistent_id=None, send_welcome_email=None, is_directory_restricted=None, role_ids=None)

x.__init__(…) initializes x; see help(type(x)) for signature

role_ids
class dropbox.team.MemberAddV2Result(tag, value=None)

Bases: dropbox.team.MemberAddResultBase

Describes the result of attempting to add a single user to the team. ‘success’ is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:MemberAddV2Result.success (TeamMemberInfoV2) – Describes a user that was successfully added to the team.
get_success()

Describes a user that was successfully added to the team.

Only call this if is_success() is true.

Return type:TeamMemberInfoV2
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = MemberAddV2Result(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (TeamMemberInfoV2) –
Return type:MemberAddV2Result
class dropbox.team.MemberDevices(team_member_id=None, web_sessions=None, desktop_clients=None, mobile_clients=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information on devices of a team’s member.

Variables:
__init__(team_member_id=None, web_sessions=None, desktop_clients=None, mobile_clients=None)

x.__init__(…) initializes x; see help(type(x)) for signature

desktop_clients
mobile_clients
team_member_id
web_sessions
class dropbox.team.MemberLinkedApps(team_member_id=None, linked_api_apps=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information on linked applications of a team member.

Variables:
__init__(team_member_id=None, linked_api_apps=None)

x.__init__(…) initializes x; see help(type(x)) for signature

linked_api_apps
team_member_id
class dropbox.team.MemberProfile(team_member_id=None, email=None, email_verified=None, status=None, name=None, membership_type=None, external_id=None, account_id=None, secondary_emails=None, invited_on=None, joined_on=None, suspended_on=None, persistent_id=None, is_directory_restricted=None, profile_photo_url=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Basic member profile.

Variables:
__init__(team_member_id=None, email=None, email_verified=None, status=None, name=None, membership_type=None, external_id=None, account_id=None, secondary_emails=None, invited_on=None, joined_on=None, suspended_on=None, persistent_id=None, is_directory_restricted=None, profile_photo_url=None)

x.__init__(…) initializes x; see help(type(x)) for signature

account_id
email
email_verified
external_id
invited_on
is_directory_restricted
joined_on
membership_type
name
persistent_id
profile_photo_url
secondary_emails
status
suspended_on
team_member_id
class dropbox.team.MemberSelectorError(tag, value=None)

Bases: dropbox.team.UserSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MemberSelectorError.user_not_in_team – The user is not a member of the team.
is_user_not_in_team()

Check if the union tag is user_not_in_team.

Return type:bool
user_not_in_team = MemberSelectorError(u'user_not_in_team', None)
class dropbox.team.MembersAddArg(new_members=None, force_async=None)

Bases: dropbox.team.MembersAddArgBase

Variables:team.MembersAddArg.new_members – Details of new members to be added to the team.
__init__(new_members=None, force_async=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_members
class dropbox.team.MembersAddArgBase(force_async=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersAddArgBase.force_async – Whether to force the add to happen asynchronously.
__init__(force_async=None)

x.__init__(…) initializes x; see help(type(x)) for signature

force_async
class dropbox.team.MembersAddJobStatus(tag, value=None)

Bases: dropbox.async_.PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:of [MemberAddResult] val (list) –
Return type:MembersAddJobStatus
classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:val (str) –
Return type:MembersAddJobStatus
get_complete()

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to dropbox.dropbox_client.Dropbox.team_members_add(), a corresponding item is returned in this list.

Only call this if is_complete() is true.

Return type:list of [MemberAddResult]
get_failed()

The asynchronous job returned an error. The string contains an error message.

Only call this if is_failed() is true.

Return type:str
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

Return type:bool
class dropbox.team.MembersAddJobStatusV2Result(tag, value=None)

Bases: dropbox.async_.PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:of [MemberAddV2Result] val (list) –
Return type:MembersAddJobStatusV2Result
classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:val (str) –
Return type:MembersAddJobStatusV2Result
get_complete()

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to dropbox.dropbox_client.Dropbox.team_members_add(), a corresponding item is returned in this list.

Only call this if is_complete() is true.

Return type:list of [MemberAddV2Result]
get_failed()

The asynchronous job returned an error. The string contains an error message.

Only call this if is_failed() is true.

Return type:str
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = MembersAddJobStatusV2Result(u'other', None)
class dropbox.team.MembersAddLaunch(tag, value=None)

Bases: dropbox.async_.LaunchResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:of [MemberAddResult] val (list) –
Return type:MembersAddLaunch
get_complete()

Only call this if is_complete() is true.

Return type:list of [MemberAddResult]
is_complete()

Check if the union tag is complete.

Return type:bool
class dropbox.team.MembersAddLaunchV2Result(tag, value=None)

Bases: dropbox.async_.LaunchResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:of [MemberAddV2Result] val (list) –
Return type:MembersAddLaunchV2Result
get_complete()

Only call this if is_complete() is true.

Return type:list of [MemberAddV2Result]
is_complete()

Check if the union tag is complete.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = MembersAddLaunchV2Result(u'other', None)
class dropbox.team.MembersAddV2Arg(new_members=None, force_async=None)

Bases: dropbox.team.MembersAddArgBase

Variables:team.MembersAddV2Arg.new_members – Details of new members to be added to the team.
__init__(new_members=None, force_async=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_members
class dropbox.team.MembersDataTransferArg(user=None, transfer_dest_id=None, transfer_admin_id=None)

Bases: dropbox.team.MembersDeactivateBaseArg

Variables:
__init__(user=None, transfer_dest_id=None, transfer_admin_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

transfer_admin_id
transfer_dest_id
class dropbox.team.MembersDeactivateArg(user=None, wipe_data=None)

Bases: dropbox.team.MembersDeactivateBaseArg

Variables:team.MembersDeactivateArg.wipe_data – If provided, controls if the user’s data will be deleted on their linked devices.
__init__(user=None, wipe_data=None)

x.__init__(…) initializes x; see help(type(x)) for signature

wipe_data
class dropbox.team.MembersDeactivateBaseArg(user=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Variables:team.MembersDeactivateBaseArg.user – Identity of user to remove/suspend/have their files moved.
__init__(user=None)

x.__init__(…) initializes x; see help(type(x)) for signature

user
class dropbox.team.MembersDeactivateError(tag, value=None)

Bases: dropbox.team.UserSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MembersDeactivateError.user_not_in_team – The user is not a member of the team.
is_other()

Check if the union tag is other.

Return type:bool
is_user_not_in_team()

Check if the union tag is user_not_in_team.

Return type:bool
other = MembersDeactivateError(u'other', None)
user_not_in_team = MembersDeactivateError(u'user_not_in_team', None)
class dropbox.team.MembersDeleteProfilePhotoArg(user=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersDeleteProfilePhotoArg.user – Identity of the user whose profile photo will be deleted.
__init__(user=None)

x.__init__(…) initializes x; see help(type(x)) for signature

user
class dropbox.team.MembersDeleteProfilePhotoError(tag, value=None)

Bases: dropbox.team.MemberSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MembersDeleteProfilePhotoError.set_profile_disallowed – Modifying deleted users is not allowed.
is_other()

Check if the union tag is other.

Return type:bool
is_set_profile_disallowed()

Check if the union tag is set_profile_disallowed.

Return type:bool
other = MembersDeleteProfilePhotoError(u'other', None)
set_profile_disallowed = MembersDeleteProfilePhotoError(u'set_profile_disallowed', None)
class dropbox.team.MembersGetAvailableTeamMemberRolesResult(roles=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Available TeamMemberRole for the connected team. To be used with dropbox.dropbox_client.Dropbox.team_members_set_admin_permissions().

Variables:team.MembersGetAvailableTeamMemberRolesResult.roles – Available roles.
__init__(roles=None)

x.__init__(…) initializes x; see help(type(x)) for signature

roles
class dropbox.team.MembersGetInfoArgs(members=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersGetInfoArgs.members – List of team members.
__init__(members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

members
class dropbox.team.MembersGetInfoError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = MembersGetInfoError(u'other', None)
class dropbox.team.MembersGetInfoItem(tag, value=None)

Bases: dropbox.team.MembersGetInfoItemBase

Describes a result obtained for a single user whose id was specified in the parameter of dropbox.dropbox_client.Dropbox.team_members_get_info().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:MembersGetInfoItem.member_info (TeamMemberInfo) – Info about a team member.
get_member_info()

Info about a team member.

Only call this if is_member_info() is true.

Return type:TeamMemberInfo
is_member_info()

Check if the union tag is member_info.

Return type:bool
classmethod member_info(val)

Create an instance of this class set to the member_info tag with value val.

Parameters:val (TeamMemberInfo) –
Return type:MembersGetInfoItem
class dropbox.team.MembersGetInfoItemBase(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MembersGetInfoItemBase.id_not_found (str) – An ID that was provided as a parameter to :route:`members/get_info` or :route:`members/get_info:2`, and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.
get_id_not_found()

An ID that was provided as a parameter to dropbox.dropbox_client.Dropbox.team_members_get_info() or dropbox.dropbox_client.Dropbox.team_members_get_info(), and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.

Only call this if is_id_not_found() is true.

Return type:str
classmethod id_not_found(val)

Create an instance of this class set to the id_not_found tag with value val.

Parameters:val (str) –
Return type:MembersGetInfoItemBase
is_id_not_found()

Check if the union tag is id_not_found.

Return type:bool
class dropbox.team.MembersGetInfoItemV2(tag, value=None)

Bases: dropbox.team.MembersGetInfoItemBase

Describes a result obtained for a single user whose id was specified in the parameter of dropbox.dropbox_client.Dropbox.team_members_get_info().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:MembersGetInfoItemV2.member_info (TeamMemberInfoV2) – Info about a team member.
get_member_info()

Info about a team member.

Only call this if is_member_info() is true.

Return type:TeamMemberInfoV2
is_member_info()

Check if the union tag is member_info.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod member_info(val)

Create an instance of this class set to the member_info tag with value val.

Parameters:val (TeamMemberInfoV2) –
Return type:MembersGetInfoItemV2
other = MembersGetInfoItemV2(u'other', None)
class dropbox.team.MembersGetInfoV2Arg(members=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersGetInfoV2Arg.members – List of team members.
__init__(members=None)

x.__init__(…) initializes x; see help(type(x)) for signature

members
class dropbox.team.MembersGetInfoV2Result(members_info=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersGetInfoV2Result.members_info – List of team members info.
__init__(members_info=None)

x.__init__(…) initializes x; see help(type(x)) for signature

members_info
class dropbox.team.MembersInfo(team_member_ids=None, permanently_deleted_users=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(team_member_ids=None, permanently_deleted_users=None)

x.__init__(…) initializes x; see help(type(x)) for signature

permanently_deleted_users
team_member_ids
class dropbox.team.MembersListArg(limit=None, include_removed=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(limit=None, include_removed=None)

x.__init__(…) initializes x; see help(type(x)) for signature

include_removed
limit
class dropbox.team.MembersListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.MembersListContinueArg.cursor – Indicates from what point to get the next set of members.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.MembersListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MembersListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = MembersListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = MembersListContinueError(u'other', None)
class dropbox.team.MembersListError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = MembersListError(u'other', None)
class dropbox.team.MembersListResult(members=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(members=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
members
class dropbox.team.MembersListV2Result(members=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(members=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
members
class dropbox.team.MembersRecoverArg(user=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Variables:team.MembersRecoverArg.user – Identity of user to recover.
__init__(user=None)

x.__init__(…) initializes x; see help(type(x)) for signature

user
class dropbox.team.MembersRecoverError(tag, value=None)

Bases: dropbox.team.UserSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_other()

Check if the union tag is other.

Return type:bool
is_team_license_limit()

Check if the union tag is team_license_limit.

Return type:bool
is_user_not_in_team()

Check if the union tag is user_not_in_team.

Return type:bool
is_user_unrecoverable()

Check if the union tag is user_unrecoverable.

Return type:bool
other = MembersRecoverError(u'other', None)
team_license_limit = MembersRecoverError(u'team_license_limit', None)
user_not_in_team = MembersRecoverError(u'user_not_in_team', None)
user_unrecoverable = MembersRecoverError(u'user_unrecoverable', None)
class dropbox.team.MembersRemoveArg(user=None, wipe_data=None, transfer_dest_id=None, transfer_admin_id=None, keep_account=None, retain_team_shares=None)

Bases: dropbox.team.MembersDeactivateArg

Variables:
  • team.MembersRemoveArg.transfer_dest_id – If provided, files from the deleted member account will be transferred to this user.
  • team.MembersRemoveArg.transfer_admin_id – If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well.
  • team.MembersRemoveArg.keep_account – Downgrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument wipe_data should be set to False.
  • team.MembersRemoveArg.retain_team_shares – If provided, allows removed users to keep access to Dropbox folders (not Dropbox Paper folders) already explicitly shared with them (not via a group) when they are downgraded to a Basic account. Users will not retain access to folders that do not allow external sharing. In order to keep the sharing relationships, the arguments wipe_data should be set to False and keep_account should be set to True.
__init__(user=None, wipe_data=None, transfer_dest_id=None, transfer_admin_id=None, keep_account=None, retain_team_shares=None)

x.__init__(…) initializes x; see help(type(x)) for signature

keep_account
retain_team_shares
transfer_admin_id
transfer_dest_id
class dropbox.team.MembersRemoveError(tag, value=None)

Bases: dropbox.team.MembersTransferFilesError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
:ivar
team.MembersRemoveError.cannot_retain_shares_when_team_external_sharing_off: Externally sharing files, folders, and links must be enabled in team settings in order to retain team shares for the user.
Variables:
cannot_keep_account = MembersRemoveError(u'cannot_keep_account', None)
cannot_keep_account_and_delete_data = MembersRemoveError(u'cannot_keep_account_and_delete_data', None)
cannot_keep_account_and_transfer = MembersRemoveError(u'cannot_keep_account_and_transfer', None)
cannot_keep_account_required_to_sign_tos = MembersRemoveError(u'cannot_keep_account_required_to_sign_tos', None)
cannot_keep_invited_user_account = MembersRemoveError(u'cannot_keep_invited_user_account', None)
cannot_retain_shares_when_data_wiped = MembersRemoveError(u'cannot_retain_shares_when_data_wiped', None)
cannot_retain_shares_when_no_account_kept = MembersRemoveError(u'cannot_retain_shares_when_no_account_kept', None)
cannot_retain_shares_when_team_external_sharing_off = MembersRemoveError(u'cannot_retain_shares_when_team_external_sharing_off', None)
email_address_too_long_to_be_disabled = MembersRemoveError(u'email_address_too_long_to_be_disabled', None)
is_cannot_keep_account()

Check if the union tag is cannot_keep_account.

Return type:bool
is_cannot_keep_account_and_delete_data()

Check if the union tag is cannot_keep_account_and_delete_data.

Return type:bool
is_cannot_keep_account_and_transfer()

Check if the union tag is cannot_keep_account_and_transfer.

Return type:bool
is_cannot_keep_account_required_to_sign_tos()

Check if the union tag is cannot_keep_account_required_to_sign_tos.

Return type:bool

Check if the union tag is cannot_keep_account_under_legal_hold.

Return type:bool
is_cannot_keep_invited_user_account()

Check if the union tag is cannot_keep_invited_user_account.

Return type:bool
is_cannot_retain_shares_when_data_wiped()

Check if the union tag is cannot_retain_shares_when_data_wiped.

Return type:bool
is_cannot_retain_shares_when_no_account_kept()

Check if the union tag is cannot_retain_shares_when_no_account_kept.

Return type:bool
is_cannot_retain_shares_when_team_external_sharing_off()

Check if the union tag is cannot_retain_shares_when_team_external_sharing_off.

Return type:bool
is_email_address_too_long_to_be_disabled()

Check if the union tag is email_address_too_long_to_be_disabled.

Return type:bool
is_remove_last_admin()

Check if the union tag is remove_last_admin.

Return type:bool
remove_last_admin = MembersRemoveError(u'remove_last_admin', None)
class dropbox.team.MembersSendWelcomeError(tag, value=None)

Bases: dropbox.team.MemberSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = MembersSendWelcomeError(u'other', None)
class dropbox.team.MembersSetPermissions2Arg(user=None, new_roles=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Variables:
__init__(user=None, new_roles=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_roles
user
class dropbox.team.MembersSetPermissions2Error(tag, value=None)

Bases: dropbox.team.UserSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
cannot_set_permissions = MembersSetPermissions2Error(u'cannot_set_permissions', None)
is_cannot_set_permissions()

Check if the union tag is cannot_set_permissions.

Return type:bool
is_last_admin()

Check if the union tag is last_admin.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_role_not_found()

Check if the union tag is role_not_found.

Return type:bool
is_user_not_in_team()

Check if the union tag is user_not_in_team.

Return type:bool
last_admin = MembersSetPermissions2Error(u'last_admin', None)
other = MembersSetPermissions2Error(u'other', None)
role_not_found = MembersSetPermissions2Error(u'role_not_found', None)
user_not_in_team = MembersSetPermissions2Error(u'user_not_in_team', None)
class dropbox.team.MembersSetPermissions2Result(team_member_id=None, roles=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(team_member_id=None, roles=None)

x.__init__(…) initializes x; see help(type(x)) for signature

roles
team_member_id
class dropbox.team.MembersSetPermissionsArg(user=None, new_role=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Variables:
__init__(user=None, new_role=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_role
user
class dropbox.team.MembersSetPermissionsError(tag, value=None)

Bases: dropbox.team.UserSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
cannot_set_permissions = MembersSetPermissionsError(u'cannot_set_permissions', None)
is_cannot_set_permissions()

Check if the union tag is cannot_set_permissions.

Return type:bool
is_last_admin()

Check if the union tag is last_admin.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_team_license_limit()

Check if the union tag is team_license_limit.

Return type:bool
is_user_not_in_team()

Check if the union tag is user_not_in_team.

Return type:bool
last_admin = MembersSetPermissionsError(u'last_admin', None)
other = MembersSetPermissionsError(u'other', None)
team_license_limit = MembersSetPermissionsError(u'team_license_limit', None)
user_not_in_team = MembersSetPermissionsError(u'user_not_in_team', None)
class dropbox.team.MembersSetPermissionsResult(team_member_id=None, role=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(team_member_id=None, role=None)

x.__init__(…) initializes x; see help(type(x)) for signature

role
team_member_id
class dropbox.team.MembersSetProfileArg(user=None, new_email=None, new_external_id=None, new_given_name=None, new_surname=None, new_persistent_id=None, new_is_directory_restricted=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account. At least one of new_email, new_external_id, new_given_name, and/or new_surname must be provided.

Variables:
__init__(user=None, new_email=None, new_external_id=None, new_given_name=None, new_surname=None, new_persistent_id=None, new_is_directory_restricted=None)

x.__init__(…) initializes x; see help(type(x)) for signature

new_email
new_external_id
new_given_name
new_is_directory_restricted
new_persistent_id
new_surname
user
class dropbox.team.MembersSetProfileError(tag, value=None)

Bases: dropbox.team.MemberSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
directory_restricted_off = MembersSetProfileError(u'directory_restricted_off', None)
email_reserved_for_other_user = MembersSetProfileError(u'email_reserved_for_other_user', None)
external_id_and_new_external_id_unsafe = MembersSetProfileError(u'external_id_and_new_external_id_unsafe', None)
external_id_used_by_other_user = MembersSetProfileError(u'external_id_used_by_other_user', None)
is_directory_restricted_off()

Check if the union tag is directory_restricted_off.

Return type:bool
is_email_reserved_for_other_user()

Check if the union tag is email_reserved_for_other_user.

Return type:bool
is_external_id_and_new_external_id_unsafe()

Check if the union tag is external_id_and_new_external_id_unsafe.

Return type:bool
is_external_id_used_by_other_user()

Check if the union tag is external_id_used_by_other_user.

Return type:bool
is_no_new_data_specified()

Check if the union tag is no_new_data_specified.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_param_cannot_be_empty()

Check if the union tag is param_cannot_be_empty.

Return type:bool
is_persistent_id_disabled()

Check if the union tag is persistent_id_disabled.

Return type:bool
is_persistent_id_used_by_other_user()

Check if the union tag is persistent_id_used_by_other_user.

Return type:bool
is_set_profile_disallowed()

Check if the union tag is set_profile_disallowed.

Return type:bool
no_new_data_specified = MembersSetProfileError(u'no_new_data_specified', None)
other = MembersSetProfileError(u'other', None)
param_cannot_be_empty = MembersSetProfileError(u'param_cannot_be_empty', None)
persistent_id_disabled = MembersSetProfileError(u'persistent_id_disabled', None)
persistent_id_used_by_other_user = MembersSetProfileError(u'persistent_id_used_by_other_user', None)
set_profile_disallowed = MembersSetProfileError(u'set_profile_disallowed', None)
class dropbox.team.MembersSetProfilePhotoArg(user=None, photo=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(user=None, photo=None)

x.__init__(…) initializes x; see help(type(x)) for signature

photo
user
class dropbox.team.MembersSetProfilePhotoError(tag, value=None)

Bases: dropbox.team.MemberSelectorError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.MembersSetProfilePhotoError.set_profile_disallowed – Modifying deleted users is not allowed.
get_photo_error()

Only call this if is_photo_error() is true.

Return type:account.SetProfilePhotoError
is_other()

Check if the union tag is other.

Return type:bool
is_photo_error()

Check if the union tag is photo_error.

Return type:bool
is_set_profile_disallowed()

Check if the union tag is set_profile_disallowed.

Return type:bool
other = MembersSetProfilePhotoError(u'other', None)
classmethod photo_error(val)

Create an instance of this class set to the photo_error tag with value val.

Parameters:val (account.SetProfilePhotoError) –
Return type:MembersSetProfilePhotoError
set_profile_disallowed = MembersSetProfilePhotoError(u'set_profile_disallowed', None)
class dropbox.team.MembersSuspendError(tag, value=None)

Bases: dropbox.team.MembersDeactivateError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_suspend_inactive_user()

Check if the union tag is suspend_inactive_user.

Return type:bool
is_suspend_last_admin()

Check if the union tag is suspend_last_admin.

Return type:bool
is_team_license_limit()

Check if the union tag is team_license_limit.

Return type:bool
suspend_inactive_user = MembersSuspendError(u'suspend_inactive_user', None)
suspend_last_admin = MembersSuspendError(u'suspend_last_admin', None)
team_license_limit = MembersSuspendError(u'team_license_limit', None)
class dropbox.team.MembersTransferFilesError(tag, value=None)

Bases: dropbox.team.MembersDeactivateError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar
team.MembersTransferFilesError.removed_and_transfer_dest_should_differ: Expected removed user and transfer_dest user to be different.
:ivar
team.MembersTransferFilesError.removed_and_transfer_admin_should_differ: Expected removed user and transfer_admin user to be different.
Variables:
is_recipient_not_verified()

Check if the union tag is recipient_not_verified.

Return type:bool
is_removed_and_transfer_admin_should_differ()

Check if the union tag is removed_and_transfer_admin_should_differ.

Return type:bool
is_removed_and_transfer_dest_should_differ()

Check if the union tag is removed_and_transfer_dest_should_differ.

Return type:bool
is_transfer_admin_is_not_admin()

Check if the union tag is transfer_admin_is_not_admin.

Return type:bool
is_transfer_admin_user_not_found()

Check if the union tag is transfer_admin_user_not_found.

Return type:bool
is_transfer_admin_user_not_in_team()

Check if the union tag is transfer_admin_user_not_in_team.

Return type:bool
is_transfer_dest_user_not_found()

Check if the union tag is transfer_dest_user_not_found.

Return type:bool
is_transfer_dest_user_not_in_team()

Check if the union tag is transfer_dest_user_not_in_team.

Return type:bool
is_unspecified_transfer_admin_id()

Check if the union tag is unspecified_transfer_admin_id.

Return type:bool
recipient_not_verified = MembersTransferFilesError(u'recipient_not_verified', None)
removed_and_transfer_admin_should_differ = MembersTransferFilesError(u'removed_and_transfer_admin_should_differ', None)
removed_and_transfer_dest_should_differ = MembersTransferFilesError(u'removed_and_transfer_dest_should_differ', None)
transfer_admin_is_not_admin = MembersTransferFilesError(u'transfer_admin_is_not_admin', None)
transfer_admin_user_not_found = MembersTransferFilesError(u'transfer_admin_user_not_found', None)
transfer_admin_user_not_in_team = MembersTransferFilesError(u'transfer_admin_user_not_in_team', None)
transfer_dest_user_not_found = MembersTransferFilesError(u'transfer_dest_user_not_found', None)
transfer_dest_user_not_in_team = MembersTransferFilesError(u'transfer_dest_user_not_in_team', None)
unspecified_transfer_admin_id = MembersTransferFilesError(u'unspecified_transfer_admin_id', None)
class dropbox.team.MembersTransferFormerMembersFilesError(tag, value=None)

Bases: dropbox.team.MembersTransferFilesError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar
team.MembersTransferFormerMembersFilesError.user_data_is_being_transferred: The user’s data is being transferred. Please wait some time before retrying.
Variables:team.MembersTransferFormerMembersFilesError.user_not_removed – No matching removed user found for the argument user.
:ivar
team.MembersTransferFormerMembersFilesError.user_data_cannot_be_transferred: User files aren’t transferable anymore.
:ivar
team.MembersTransferFormerMembersFilesError.user_data_already_transferred: User’s data has already been transferred to another user.
is_user_data_already_transferred()

Check if the union tag is user_data_already_transferred.

Return type:bool
is_user_data_cannot_be_transferred()

Check if the union tag is user_data_cannot_be_transferred.

Return type:bool
is_user_data_is_being_transferred()

Check if the union tag is user_data_is_being_transferred.

Return type:bool
is_user_not_removed()

Check if the union tag is user_not_removed.

Return type:bool
user_data_already_transferred = MembersTransferFormerMembersFilesError(u'user_data_already_transferred', None)
user_data_cannot_be_transferred = MembersTransferFormerMembersFilesError(u'user_data_cannot_be_transferred', None)
user_data_is_being_transferred = MembersTransferFormerMembersFilesError(u'user_data_is_being_transferred', None)
user_not_removed = MembersTransferFormerMembersFilesError(u'user_not_removed', None)
class dropbox.team.MembersUnsuspendArg(user=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

Variables:team.MembersUnsuspendArg.user – Identity of user to unsuspend.
__init__(user=None)

x.__init__(…) initializes x; see help(type(x)) for signature

user
class dropbox.team.MembersUnsuspendError(tag, value=None)

Bases: dropbox.team.MembersDeactivateError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_team_license_limit()

Check if the union tag is team_license_limit.

Return type:bool
is_unsuspend_non_suspended_member()

Check if the union tag is unsuspend_non_suspended_member.

Return type:bool
team_license_limit = MembersUnsuspendError(u'team_license_limit', None)
unsuspend_non_suspended_member = MembersUnsuspendError(u'unsuspend_non_suspended_member', None)
class dropbox.team.MobileClientPlatform(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
android = MobileClientPlatform(u'android', None)
blackberry = MobileClientPlatform(u'blackberry', None)
ipad = MobileClientPlatform(u'ipad', None)
iphone = MobileClientPlatform(u'iphone', None)
is_android()

Check if the union tag is android.

Return type:bool
is_blackberry()

Check if the union tag is blackberry.

Return type:bool
is_ipad()

Check if the union tag is ipad.

Return type:bool
is_iphone()

Check if the union tag is iphone.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_windows_phone()

Check if the union tag is windows_phone.

Return type:bool
other = MobileClientPlatform(u'other', None)
windows_phone = MobileClientPlatform(u'windows_phone', None)
class dropbox.team.MobileClientSession(session_id=None, device_name=None, client_type=None, ip_address=None, country=None, created=None, updated=None, client_version=None, os_version=None, last_carrier=None)

Bases: dropbox.team.DeviceSession

Information about linked Dropbox mobile client sessions.

Variables:
__init__(session_id=None, device_name=None, client_type=None, ip_address=None, country=None, created=None, updated=None, client_version=None, os_version=None, last_carrier=None)

x.__init__(…) initializes x; see help(type(x)) for signature

client_type
client_version
device_name
last_carrier
os_version
class dropbox.team.NamespaceMetadata(name=None, namespace_id=None, namespace_type=None, team_member_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Properties of a namespace.

Variables:
__init__(name=None, namespace_id=None, namespace_type=None, team_member_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

name
namespace_id
namespace_type
team_member_id
class dropbox.team.NamespaceType(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
app_folder = NamespaceType(u'app_folder', None)
is_app_folder()

Check if the union tag is app_folder.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_shared_folder()

Check if the union tag is shared_folder.

Return type:bool
is_team_folder()

Check if the union tag is team_folder.

Return type:bool
is_team_member_folder()

Check if the union tag is team_member_folder.

Return type:bool
other = NamespaceType(u'other', None)
shared_folder = NamespaceType(u'shared_folder', None)
team_folder = NamespaceType(u'team_folder', None)
team_member_folder = NamespaceType(u'team_member_folder', None)
class dropbox.team.RemoveCustomQuotaResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

User result for setting member custom quota.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_invalid_user()

Invalid user (not in team).

Only call this if is_invalid_user() is true.

Return type:UserSelectorArg
get_success()

Successfully removed user.

Only call this if is_success() is true.

Return type:UserSelectorArg
classmethod invalid_user(val)

Create an instance of this class set to the invalid_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:RemoveCustomQuotaResult
is_invalid_user()

Check if the union tag is invalid_user.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = RemoveCustomQuotaResult(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (UserSelectorArg) –
Return type:RemoveCustomQuotaResult
class dropbox.team.RemovedStatus(is_recoverable=None, is_disconnected=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(is_recoverable=None, is_disconnected=None)

x.__init__(…) initializes x; see help(type(x)) for signature

is_disconnected
is_recoverable
class dropbox.team.ResendSecondaryEmailResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to resend verification email to a secondary email address. ‘success’ is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_not_pending()

This secondary email address is not pending for the user.

Only call this if is_not_pending() is true.

Return type:str
get_rate_limited()

Too many emails are being sent to this email address. Please try again later.

Only call this if is_rate_limited() is true.

Return type:str
get_success()

A verification email was successfully sent to the secondary email address.

Only call this if is_success() is true.

Return type:str
is_not_pending()

Check if the union tag is not_pending.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_rate_limited()

Check if the union tag is rate_limited.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
classmethod not_pending(val)

Create an instance of this class set to the not_pending tag with value val.

Parameters:val (str) –
Return type:ResendSecondaryEmailResult
other = ResendSecondaryEmailResult(u'other', None)
classmethod rate_limited(val)

Create an instance of this class set to the rate_limited tag with value val.

Parameters:val (str) –
Return type:ResendSecondaryEmailResult
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (str) –
Return type:ResendSecondaryEmailResult
class dropbox.team.ResendVerificationEmailArg(emails_to_resend=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.ResendVerificationEmailArg.emails_to_resend – List of users and secondary emails to resend verification emails to.
__init__(emails_to_resend=None)

x.__init__(…) initializes x; see help(type(x)) for signature

emails_to_resend
class dropbox.team.ResendVerificationEmailResult(results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

List of users and resend results.

__init__(results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
class dropbox.team.RevokeDesktopClientArg(session_id=None, team_member_id=None, delete_on_unlink=None)

Bases: dropbox.team.DeviceSessionArg

Variables:team.RevokeDesktopClientArg.delete_on_unlink – Whether to delete all files of the account (this is possible only if supported by the desktop client and will be made the next time the client access the account).
__init__(session_id=None, team_member_id=None, delete_on_unlink=None)

x.__init__(…) initializes x; see help(type(x)) for signature

class dropbox.team.RevokeDeviceSessionArg(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod desktop_client(val)

Create an instance of this class set to the desktop_client tag with value val.

Parameters:val (RevokeDesktopClientArg) –
Return type:RevokeDeviceSessionArg
get_desktop_client()

Unlink a linked desktop device.

Only call this if is_desktop_client() is true.

Return type:RevokeDesktopClientArg
get_mobile_client()

Unlink a linked mobile device.

Only call this if is_mobile_client() is true.

Return type:DeviceSessionArg
get_web_session()

End an active session.

Only call this if is_web_session() is true.

Return type:DeviceSessionArg
is_desktop_client()

Check if the union tag is desktop_client.

Return type:bool
is_mobile_client()

Check if the union tag is mobile_client.

Return type:bool
is_web_session()

Check if the union tag is web_session.

Return type:bool
classmethod mobile_client(val)

Create an instance of this class set to the mobile_client tag with value val.

Parameters:val (DeviceSessionArg) –
Return type:RevokeDeviceSessionArg
classmethod web_session(val)

Create an instance of this class set to the web_session tag with value val.

Parameters:val (DeviceSessionArg) –
Return type:RevokeDeviceSessionArg
class dropbox.team.RevokeDeviceSessionBatchArg(revoke_devices=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(revoke_devices=None)

x.__init__(…) initializes x; see help(type(x)) for signature

revoke_devices
class dropbox.team.RevokeDeviceSessionBatchError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = RevokeDeviceSessionBatchError(u'other', None)
class dropbox.team.RevokeDeviceSessionBatchResult(revoke_devices_status=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(revoke_devices_status=None)

x.__init__(…) initializes x; see help(type(x)) for signature

revoke_devices_status
class dropbox.team.RevokeDeviceSessionError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
device_session_not_found = RevokeDeviceSessionError(u'device_session_not_found', None)
is_device_session_not_found()

Check if the union tag is device_session_not_found.

Return type:bool
is_member_not_found()

Check if the union tag is member_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
member_not_found = RevokeDeviceSessionError(u'member_not_found', None)
other = RevokeDeviceSessionError(u'other', None)
class dropbox.team.RevokeDeviceSessionStatus(success=None, error_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(success=None, error_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

error_type
success
class dropbox.team.RevokeLinkedApiAppArg(app_id=None, team_member_id=None, keep_app_folder=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(app_id=None, team_member_id=None, keep_app_folder=None)

x.__init__(…) initializes x; see help(type(x)) for signature

app_id
keep_app_folder
team_member_id
class dropbox.team.RevokeLinkedApiAppBatchArg(revoke_linked_app=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(revoke_linked_app=None)

x.__init__(…) initializes x; see help(type(x)) for signature

revoke_linked_app
class dropbox.team.RevokeLinkedAppBatchError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_linked_apps_revoke_linked_app_batch().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_other()

Check if the union tag is other.

Return type:bool
other = RevokeLinkedAppBatchError(u'other', None)
class dropbox.team.RevokeLinkedAppBatchResult(revoke_linked_app_status=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(revoke_linked_app_status=None)

x.__init__(…) initializes x; see help(type(x)) for signature

revoke_linked_app_status
class dropbox.team.RevokeLinkedAppError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_linked_apps_revoke_linked_app().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
app_folder_removal_not_supported = RevokeLinkedAppError(u'app_folder_removal_not_supported', None)
app_not_found = RevokeLinkedAppError(u'app_not_found', None)
is_app_folder_removal_not_supported()

Check if the union tag is app_folder_removal_not_supported.

Return type:bool
is_app_not_found()

Check if the union tag is app_not_found.

Return type:bool
is_member_not_found()

Check if the union tag is member_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
member_not_found = RevokeLinkedAppError(u'member_not_found', None)
other = RevokeLinkedAppError(u'other', None)
class dropbox.team.RevokeLinkedAppStatus(success=None, error_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(success=None, error_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

error_type
success
class dropbox.team.SetCustomQuotaArg(users_and_quotas=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.SetCustomQuotaArg.users_and_quotas – List of users and their custom quotas.
__init__(users_and_quotas=None)

x.__init__(…) initializes x; see help(type(x)) for signature

users_and_quotas
class dropbox.team.SetCustomQuotaError(tag, value=None)

Bases: dropbox.team.CustomQuotaError

Error returned when setting member custom quota.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.SetCustomQuotaError.some_users_are_excluded – Some of the users are on the excluded users list and can’t have custom quota set.
is_some_users_are_excluded()

Check if the union tag is some_users_are_excluded.

Return type:bool
some_users_are_excluded = SetCustomQuotaError(u'some_users_are_excluded', None)
class dropbox.team.SharingAllowlistAddArgs(domains=None, emails=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Structure representing Approve List entries. Domain and emails are supported. At least one entry of any supported type is required.

Variables:
__init__(domains=None, emails=None)

x.__init__(…) initializes x; see help(type(x)) for signature

domains
emails
class dropbox.team.SharingAllowlistAddError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod entries_already_exist(val)

Create an instance of this class set to the entries_already_exist tag with value val.

Parameters:val (str) –
Return type:SharingAllowlistAddError
get_entries_already_exist()

Entries already exists.

Only call this if is_entries_already_exist() is true.

Return type:str
get_malformed_entry()

One of provided values is not valid.

Only call this if is_malformed_entry() is true.

Return type:str
is_entries_already_exist()

Check if the union tag is entries_already_exist.

Return type:bool
is_malformed_entry()

Check if the union tag is malformed_entry.

Return type:bool
is_no_entries_provided()

Check if the union tag is no_entries_provided.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_team_limit_reached()

Check if the union tag is team_limit_reached.

Return type:bool
is_too_many_entries_provided()

Check if the union tag is too_many_entries_provided.

Return type:bool
is_unknown_error()

Check if the union tag is unknown_error.

Return type:bool
classmethod malformed_entry(val)

Create an instance of this class set to the malformed_entry tag with value val.

Parameters:val (str) –
Return type:SharingAllowlistAddError
no_entries_provided = SharingAllowlistAddError(u'no_entries_provided', None)
other = SharingAllowlistAddError(u'other', None)
team_limit_reached = SharingAllowlistAddError(u'team_limit_reached', None)
too_many_entries_provided = SharingAllowlistAddError(u'too_many_entries_provided', None)
unknown_error = SharingAllowlistAddError(u'unknown_error', None)
class dropbox.team.SharingAllowlistAddResponse

Bases: stone.backends.python_rsrc.stone_base.Struct

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

class dropbox.team.SharingAllowlistListArg(limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.SharingAllowlistListArg.limit – The number of entries to fetch at one time.
__init__(limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

limit
class dropbox.team.SharingAllowlistListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.SharingAllowlistListContinueArg.cursor – The cursor returned from a previous call to dropbox.dropbox_client.Dropbox.team_sharing_allowlist_list() or dropbox.dropbox_client.Dropbox.team_sharing_allowlist_list_continue().
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.SharingAllowlistListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.SharingAllowlistListContinueError.invalid_cursor – Provided cursor is not valid.
invalid_cursor = SharingAllowlistListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = SharingAllowlistListContinueError(u'other', None)
class dropbox.team.SharingAllowlistListError

Bases: stone.backends.python_rsrc.stone_base.Struct

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

class dropbox.team.SharingAllowlistListResponse(domains=None, emails=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(domains=None, emails=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
domains
emails
has_more
class dropbox.team.SharingAllowlistRemoveArgs(domains=None, emails=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(domains=None, emails=None)

x.__init__(…) initializes x; see help(type(x)) for signature

domains
emails
class dropbox.team.SharingAllowlistRemoveError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod entries_do_not_exist(val)

Create an instance of this class set to the entries_do_not_exist tag with value val.

Parameters:val (str) –
Return type:SharingAllowlistRemoveError
get_entries_do_not_exist()

One or more provided values do not exist.

Only call this if is_entries_do_not_exist() is true.

Return type:str
get_malformed_entry()

One of provided values is not valid.

Only call this if is_malformed_entry() is true.

Return type:str
is_entries_do_not_exist()

Check if the union tag is entries_do_not_exist.

Return type:bool
is_malformed_entry()

Check if the union tag is malformed_entry.

Return type:bool
is_no_entries_provided()

Check if the union tag is no_entries_provided.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_too_many_entries_provided()

Check if the union tag is too_many_entries_provided.

Return type:bool
is_unknown_error()

Check if the union tag is unknown_error.

Return type:bool
classmethod malformed_entry(val)

Create an instance of this class set to the malformed_entry tag with value val.

Parameters:val (str) –
Return type:SharingAllowlistRemoveError
no_entries_provided = SharingAllowlistRemoveError(u'no_entries_provided', None)
other = SharingAllowlistRemoveError(u'other', None)
too_many_entries_provided = SharingAllowlistRemoveError(u'too_many_entries_provided', None)
unknown_error = SharingAllowlistRemoveError(u'unknown_error', None)
class dropbox.team.SharingAllowlistRemoveResponse

Bases: stone.backends.python_rsrc.stone_base.Struct

This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

class dropbox.team.StorageBucket(bucket=None, users=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Describes the number of users in a specific storage bucket.

Variables:
__init__(bucket=None, users=None)

x.__init__(…) initializes x; see help(type(x)) for signature

bucket
users
class dropbox.team.TeamFolderAccessError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
invalid_team_folder_id = TeamFolderAccessError(u'invalid_team_folder_id', None)
is_invalid_team_folder_id()

Check if the union tag is invalid_team_folder_id.

Return type:bool
is_no_access()

Check if the union tag is no_access.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
no_access = TeamFolderAccessError(u'no_access', None)
other = TeamFolderAccessError(u'other', None)
class dropbox.team.TeamFolderActivateError(tag, value=None)

Bases: dropbox.team.BaseTeamFolderError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.team.TeamFolderArchiveArg(team_folder_id=None, force_async_off=None)

Bases: dropbox.team.TeamFolderIdArg

Variables:team.TeamFolderArchiveArg.force_async_off – Whether to force the archive to happen synchronously.
__init__(team_folder_id=None, force_async_off=None)

x.__init__(…) initializes x; see help(type(x)) for signature

force_async_off
class dropbox.team.TeamFolderArchiveError(tag, value=None)

Bases: dropbox.team.BaseTeamFolderError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.team.TeamFolderArchiveJobStatus(tag, value=None)

Bases: dropbox.async_.PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:val (TeamFolderMetadata) –
Return type:TeamFolderArchiveJobStatus
classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:val (TeamFolderArchiveError) –
Return type:TeamFolderArchiveJobStatus
get_complete()

The archive job has finished. The value is the metadata for the resulting team folder.

Only call this if is_complete() is true.

Return type:TeamFolderMetadata
get_failed()

Error occurred while performing an asynchronous job from dropbox.dropbox_client.Dropbox.team_team_folder_archive().

Only call this if is_failed() is true.

Return type:TeamFolderArchiveError
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

Return type:bool
class dropbox.team.TeamFolderArchiveLaunch(tag, value=None)

Bases: dropbox.async_.LaunchResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:val (TeamFolderMetadata) –
Return type:TeamFolderArchiveLaunch
get_complete()

Only call this if is_complete() is true.

Return type:TeamFolderMetadata
is_complete()

Check if the union tag is complete.

Return type:bool
class dropbox.team.TeamFolderCreateArg(name=None, sync_setting=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(name=None, sync_setting=None)

x.__init__(…) initializes x; see help(type(x)) for signature

name
sync_setting
class dropbox.team.TeamFolderCreateError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
folder_name_already_used = TeamFolderCreateError(u'folder_name_already_used', None)
folder_name_reserved = TeamFolderCreateError(u'folder_name_reserved', None)
get_sync_settings_error()

An error occurred setting the sync settings.

Only call this if is_sync_settings_error() is true.

Return type:files.SyncSettingsError
invalid_folder_name = TeamFolderCreateError(u'invalid_folder_name', None)
is_folder_name_already_used()

Check if the union tag is folder_name_already_used.

Return type:bool
is_folder_name_reserved()

Check if the union tag is folder_name_reserved.

Return type:bool
is_invalid_folder_name()

Check if the union tag is invalid_folder_name.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_sync_settings_error()

Check if the union tag is sync_settings_error.

Return type:bool
other = TeamFolderCreateError(u'other', None)
classmethod sync_settings_error(val)

Create an instance of this class set to the sync_settings_error tag with value val.

Parameters:val (files.SyncSettingsError) –
Return type:TeamFolderCreateError
class dropbox.team.TeamFolderGetInfoItem(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_id_not_found()

An ID that was provided as a parameter to dropbox.dropbox_client.Dropbox.team_team_folder_get_info() did not match any of the team’s team folders.

Only call this if is_id_not_found() is true.

Return type:str
get_team_folder_metadata()

Properties of a team folder.

Only call this if is_team_folder_metadata() is true.

Return type:TeamFolderMetadata
classmethod id_not_found(val)

Create an instance of this class set to the id_not_found tag with value val.

Parameters:val (str) –
Return type:TeamFolderGetInfoItem
is_id_not_found()

Check if the union tag is id_not_found.

Return type:bool
is_team_folder_metadata()

Check if the union tag is team_folder_metadata.

Return type:bool
classmethod team_folder_metadata(val)

Create an instance of this class set to the team_folder_metadata tag with value val.

Parameters:val (TeamFolderMetadata) –
Return type:TeamFolderGetInfoItem
class dropbox.team.TeamFolderIdArg(team_folder_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamFolderIdArg.team_folder_id – The ID of the team folder.
__init__(team_folder_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

team_folder_id
class dropbox.team.TeamFolderIdListArg(team_folder_ids=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamFolderIdListArg.team_folder_ids – The list of team folder IDs.
__init__(team_folder_ids=None)

x.__init__(…) initializes x; see help(type(x)) for signature

team_folder_ids
class dropbox.team.TeamFolderInvalidStatusError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
active = TeamFolderInvalidStatusError(u'active', None)
archive_in_progress = TeamFolderInvalidStatusError(u'archive_in_progress', None)
archived = TeamFolderInvalidStatusError(u'archived', None)
is_active()

Check if the union tag is active.

Return type:bool
is_archive_in_progress()

Check if the union tag is archive_in_progress.

Return type:bool
is_archived()

Check if the union tag is archived.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = TeamFolderInvalidStatusError(u'other', None)
class dropbox.team.TeamFolderListArg(limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamFolderListArg.limit – The maximum number of results to return per request.
__init__(limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

limit
class dropbox.team.TeamFolderListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamFolderListContinueArg.cursor – Indicates from what point to get the next set of team folders.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.TeamFolderListContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.TeamFolderListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = TeamFolderListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = TeamFolderListContinueError(u'other', None)
class dropbox.team.TeamFolderListError(access_error=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(access_error=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_error
class dropbox.team.TeamFolderListResult(team_folders=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.team_team_folder_list() and dropbox.dropbox_client.Dropbox.team_team_folder_list_continue().

Variables:
__init__(team_folders=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
team_folders
class dropbox.team.TeamFolderMetadata(team_folder_id=None, name=None, status=None, is_team_shared_dropbox=None, sync_setting=None, content_sync_settings=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Properties of a team folder.

Variables:
__init__(team_folder_id=None, name=None, status=None, is_team_shared_dropbox=None, sync_setting=None, content_sync_settings=None)

x.__init__(…) initializes x; see help(type(x)) for signature

content_sync_settings
is_team_shared_dropbox
name
status
sync_setting
team_folder_id
class dropbox.team.TeamFolderPermanentlyDeleteError(tag, value=None)

Bases: dropbox.team.BaseTeamFolderError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.team.TeamFolderRenameArg(team_folder_id=None, name=None)

Bases: dropbox.team.TeamFolderIdArg

Variables:team.TeamFolderRenameArg.name – New team folder name.
__init__(team_folder_id=None, name=None)

x.__init__(…) initializes x; see help(type(x)) for signature

name
class dropbox.team.TeamFolderRenameError(tag, value=None)

Bases: dropbox.team.BaseTeamFolderError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
folder_name_already_used = TeamFolderRenameError(u'folder_name_already_used', None)
folder_name_reserved = TeamFolderRenameError(u'folder_name_reserved', None)
invalid_folder_name = TeamFolderRenameError(u'invalid_folder_name', None)
is_folder_name_already_used()

Check if the union tag is folder_name_already_used.

Return type:bool
is_folder_name_reserved()

Check if the union tag is folder_name_reserved.

Return type:bool
is_invalid_folder_name()

Check if the union tag is invalid_folder_name.

Return type:bool
class dropbox.team.TeamFolderStatus(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
active = TeamFolderStatus(u'active', None)
archive_in_progress = TeamFolderStatus(u'archive_in_progress', None)
archived = TeamFolderStatus(u'archived', None)
is_active()

Check if the union tag is active.

Return type:bool
is_archive_in_progress()

Check if the union tag is archive_in_progress.

Return type:bool
is_archived()

Check if the union tag is archived.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = TeamFolderStatus(u'other', None)
class dropbox.team.TeamFolderTeamSharedDropboxError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.TeamFolderTeamSharedDropboxError.disallowed – This action is not allowed for a shared team root.
disallowed = TeamFolderTeamSharedDropboxError(u'disallowed', None)
is_disallowed()

Check if the union tag is disallowed.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = TeamFolderTeamSharedDropboxError(u'other', None)
class dropbox.team.TeamFolderUpdateSyncSettingsArg(team_folder_id=None, sync_setting=None, content_sync_settings=None)

Bases: dropbox.team.TeamFolderIdArg

Variables:
__init__(team_folder_id=None, sync_setting=None, content_sync_settings=None)

x.__init__(…) initializes x; see help(type(x)) for signature

content_sync_settings
sync_setting
class dropbox.team.TeamFolderUpdateSyncSettingsError(tag, value=None)

Bases: dropbox.team.BaseTeamFolderError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar SyncSettingsError
TeamFolderUpdateSyncSettingsError.sync_settings_error: An error occurred setting the sync settings.
get_sync_settings_error()

An error occurred setting the sync settings.

Only call this if is_sync_settings_error() is true.

Return type:files.SyncSettingsError
is_sync_settings_error()

Check if the union tag is sync_settings_error.

Return type:bool
classmethod sync_settings_error(val)

Create an instance of this class set to the sync_settings_error tag with value val.

Parameters:val (files.SyncSettingsError) –
Return type:TeamFolderUpdateSyncSettingsError
class dropbox.team.TeamGetInfoResult(name=None, team_id=None, num_licensed_users=None, num_provisioned_users=None, num_used_licenses=None, policies=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(name=None, team_id=None, num_licensed_users=None, num_provisioned_users=None, num_used_licenses=None, policies=None)

x.__init__(…) initializes x; see help(type(x)) for signature

name
num_licensed_users
num_provisioned_users
num_used_licenses
policies
team_id
class dropbox.team.TeamMemberInfo(profile=None, role=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information about a team member.

Variables:
__init__(profile=None, role=None)

x.__init__(…) initializes x; see help(type(x)) for signature

profile
role
class dropbox.team.TeamMemberInfoV2(profile=None, roles=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information about a team member.

Variables:
__init__(profile=None, roles=None)

x.__init__(…) initializes x; see help(type(x)) for signature

profile
roles
class dropbox.team.TeamMemberInfoV2Result(member_info=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Information about a team member, after the change, like at dropbox.dropbox_client.Dropbox.team_members_set_profile().

Variables:team.TeamMemberInfoV2Result.member_info – Member info, after the change.
__init__(member_info=None)

x.__init__(…) initializes x; see help(type(x)) for signature

member_info
class dropbox.team.TeamMemberProfile(team_member_id=None, email=None, email_verified=None, status=None, name=None, membership_type=None, groups=None, member_folder_id=None, external_id=None, account_id=None, secondary_emails=None, invited_on=None, joined_on=None, suspended_on=None, persistent_id=None, is_directory_restricted=None, profile_photo_url=None)

Bases: dropbox.team.MemberProfile

Profile of a user as a member of a team.

Variables:
__init__(team_member_id=None, email=None, email_verified=None, status=None, name=None, membership_type=None, groups=None, member_folder_id=None, external_id=None, account_id=None, secondary_emails=None, invited_on=None, joined_on=None, suspended_on=None, persistent_id=None, is_directory_restricted=None, profile_photo_url=None)

x.__init__(…) initializes x; see help(type(x)) for signature

groups
member_folder_id
class dropbox.team.TeamMemberRole(role_id=None, name=None, description=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

A role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name.

Variables:
__init__(role_id=None, name=None, description=None)

x.__init__(…) initializes x; see help(type(x)) for signature

description
name
role_id
class dropbox.team.TeamMemberStatus(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The user’s status as a member of a specific team.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
active = TeamMemberStatus(u'active', None)
get_removed()

User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.

Only call this if is_removed() is true.

Return type:RemovedStatus
invited = TeamMemberStatus(u'invited', None)
is_active()

Check if the union tag is active.

Return type:bool
is_invited()

Check if the union tag is invited.

Return type:bool
is_removed()

Check if the union tag is removed.

Return type:bool
is_suspended()

Check if the union tag is suspended.

Return type:bool
classmethod removed(val)

Create an instance of this class set to the removed tag with value val.

Parameters:val (RemovedStatus) –
Return type:TeamMemberStatus
suspended = TeamMemberStatus(u'suspended', None)
class dropbox.team.TeamMembershipType(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
full = TeamMembershipType(u'full', None)
is_full()

Check if the union tag is full.

Return type:bool
is_limited()

Check if the union tag is limited.

Return type:bool
limited = TeamMembershipType(u'limited', None)
class dropbox.team.TeamNamespacesListArg(limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamNamespacesListArg.limit – Specifying a value here has no effect.
__init__(limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

limit
class dropbox.team.TeamNamespacesListContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:team.TeamNamespacesListContinueArg.cursor – Indicates from what point to get the next set of team-accessible namespaces.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.team.TeamNamespacesListContinueError(tag, value=None)

Bases: dropbox.team.TeamNamespacesListError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.TeamNamespacesListContinueError.invalid_cursor – The cursor is invalid.
invalid_cursor = TeamNamespacesListContinueError(u'invalid_cursor', None)
is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:bool
class dropbox.team.TeamNamespacesListError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.TeamNamespacesListError.invalid_arg – Argument passed in is invalid.
invalid_arg = TeamNamespacesListError(u'invalid_arg', None)
is_invalid_arg()

Check if the union tag is invalid_arg.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = TeamNamespacesListError(u'other', None)
class dropbox.team.TeamNamespacesListResult(namespaces=None, cursor=None, has_more=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Result for dropbox.dropbox_client.Dropbox.team_namespaces_list().

Variables:
__init__(namespaces=None, cursor=None, has_more=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
namespaces
class dropbox.team.TeamReportFailureReason(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
is_many_reports_at_once()

Check if the union tag is many_reports_at_once.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_temporary_error()

Check if the union tag is temporary_error.

Return type:bool
is_too_much_data()

Check if the union tag is too_much_data.

Return type:bool
many_reports_at_once = TeamReportFailureReason(u'many_reports_at_once', None)
other = TeamReportFailureReason(u'other', None)
temporary_error = TeamReportFailureReason(u'temporary_error', None)
too_much_data = TeamReportFailureReason(u'too_much_data', None)
class dropbox.team.TokenGetAuthenticatedAdminError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error returned by dropbox.dropbox_client.Dropbox.team_token_get_authenticated_admin().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
admin_not_active = TokenGetAuthenticatedAdminError(u'admin_not_active', None)
is_admin_not_active()

Check if the union tag is admin_not_active.

Return type:bool
is_mapping_not_found()

Check if the union tag is mapping_not_found.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
mapping_not_found = TokenGetAuthenticatedAdminError(u'mapping_not_found', None)
other = TokenGetAuthenticatedAdminError(u'other', None)
class dropbox.team.TokenGetAuthenticatedAdminResult(admin_profile=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Results for dropbox.dropbox_client.Dropbox.team_token_get_authenticated_admin().

Variables:team.TokenGetAuthenticatedAdminResult.admin_profile – The admin who authorized the token.
__init__(admin_profile=None)

x.__init__(…) initializes x; see help(type(x)) for signature

admin_profile
class dropbox.team.UploadApiRateLimitValue(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

The value for Feature.upload_api_rate_limit.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_limit()

The number of upload API calls allowed per month.

Only call this if is_limit() is true.

Return type:int
is_limit()

Check if the union tag is limit.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_unlimited()

Check if the union tag is unlimited.

Return type:bool
classmethod limit(val)

Create an instance of this class set to the limit tag with value val.

Parameters:val (int) –
Return type:UploadApiRateLimitValue
other = UploadApiRateLimitValue(u'other', None)
unlimited = UploadApiRateLimitValue(u'unlimited', None)
class dropbox.team.UserAddResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to add secondary emails to a user. ‘success’ is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_invalid_user()

Specified user is not a valid target for adding secondary emails.

Only call this if is_invalid_user() is true.

Return type:UserSelectorArg
get_placeholder_user()

Secondary emails cannot be added to placeholder users.

Only call this if is_placeholder_user() is true.

Return type:UserSelectorArg
get_success()

Describes a user and the results for each attempt to add a secondary email.

Only call this if is_success() is true.

Return type:UserSecondaryEmailsResult
get_unverified()

Secondary emails can only be added to verified users.

Only call this if is_unverified() is true.

Return type:UserSelectorArg
classmethod invalid_user(val)

Create an instance of this class set to the invalid_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:UserAddResult
is_invalid_user()

Check if the union tag is invalid_user.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_placeholder_user()

Check if the union tag is placeholder_user.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
is_unverified()

Check if the union tag is unverified.

Return type:bool
other = UserAddResult(u'other', None)
classmethod placeholder_user(val)

Create an instance of this class set to the placeholder_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:UserAddResult
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (UserSecondaryEmailsResult) –
Return type:UserAddResult
classmethod unverified(val)

Create an instance of this class set to the unverified tag with value val.

Parameters:val (UserSelectorArg) –
Return type:UserAddResult
class dropbox.team.UserCustomQuotaArg(user=None, quota_gb=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

User and their required custom quota in GB (1 TB = 1024 GB).

__init__(user=None, quota_gb=None)

x.__init__(…) initializes x; see help(type(x)) for signature

quota_gb
user
class dropbox.team.UserCustomQuotaResult(user=None, quota_gb=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.

__init__(user=None, quota_gb=None)

x.__init__(…) initializes x; see help(type(x)) for signature

quota_gb
user
class dropbox.team.UserDeleteEmailsResult(user=None, results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(user=None, results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
user
class dropbox.team.UserDeleteResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to delete a user’s secondary emails. ‘success’ is the only value indicating that a user was successfully retrieved for deleting secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_invalid_user()

Specified user is not a valid target for deleting secondary emails.

Only call this if is_invalid_user() is true.

Return type:UserSelectorArg
get_success()

Describes a user and the results for each attempt to delete a secondary email.

Only call this if is_success() is true.

Return type:UserDeleteEmailsResult
classmethod invalid_user(val)

Create an instance of this class set to the invalid_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:UserDeleteResult
is_invalid_user()

Check if the union tag is invalid_user.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = UserDeleteResult(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (UserDeleteEmailsResult) –
Return type:UserDeleteResult
class dropbox.team.UserResendEmailsResult(user=None, results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(user=None, results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
user
class dropbox.team.UserResendResult(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Result of trying to resend verification emails to a user. ‘success’ is the only value indicating that a user was successfully retrieved for sending verification emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
get_invalid_user()

Specified user is not a valid target for resending verification emails.

Only call this if is_invalid_user() is true.

Return type:UserSelectorArg
get_success()

Describes a user and the results for each attempt to resend verification emails.

Only call this if is_success() is true.

Return type:UserResendEmailsResult
classmethod invalid_user(val)

Create an instance of this class set to the invalid_user tag with value val.

Parameters:val (UserSelectorArg) –
Return type:UserResendResult
is_invalid_user()

Check if the union tag is invalid_user.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
other = UserResendResult(u'other', None)
classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:val (UserResendEmailsResult) –
Return type:UserResendResult
class dropbox.team.UserSecondaryEmailsArg(user=None, secondary_emails=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

User and a list of secondary emails.

__init__(user=None, secondary_emails=None)

x.__init__(…) initializes x; see help(type(x)) for signature

secondary_emails
user
class dropbox.team.UserSecondaryEmailsResult(user=None, results=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(user=None, results=None)

x.__init__(…) initializes x; see help(type(x)) for signature

results
user
class dropbox.team.UserSelectorArg(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Argument for selecting a single user, either by team_member_id, external_id or email.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod email(val)

Create an instance of this class set to the email tag with value val.

Parameters:val (str) –
Return type:UserSelectorArg
classmethod external_id(val)

Create an instance of this class set to the external_id tag with value val.

Parameters:val (str) –
Return type:UserSelectorArg
get_email()

Only call this if is_email() is true.

Return type:str
get_external_id()

Only call this if is_external_id() is true.

Return type:str
get_team_member_id()

Only call this if is_team_member_id() is true.

Return type:str
is_email()

Check if the union tag is email.

Return type:bool
is_external_id()

Check if the union tag is external_id.

Return type:bool
is_team_member_id()

Check if the union tag is team_member_id.

Return type:bool
classmethod team_member_id(val)

Create an instance of this class set to the team_member_id tag with value val.

Parameters:val (str) –
Return type:UserSelectorArg
class dropbox.team.UserSelectorError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Error that can be returned whenever a struct derived from UserSelectorArg is used.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:team.UserSelectorError.user_not_found – No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
is_user_not_found()

Check if the union tag is user_not_found.

Return type:bool
user_not_found = UserSelectorError(u'user_not_found', None)
class dropbox.team.UsersSelectorArg(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Argument for selecting a list of users, either by team_member_ids, external_ids or emails.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:
classmethod emails(val)

Create an instance of this class set to the emails tag with value val.

Parameters:of [str] val (list) –
Return type:UsersSelectorArg
classmethod external_ids(val)

Create an instance of this class set to the external_ids tag with value val.

Parameters:of [str] val (list) –
Return type:UsersSelectorArg
get_emails()

List of email addresses.

Only call this if is_emails() is true.

Return type:list of [str]
get_external_ids()

List of external user IDs.

Only call this if is_external_ids() is true.

Return type:list of [str]
get_team_member_ids()

List of member IDs.

Only call this if is_team_member_ids() is true.

Return type:list of [str]
is_emails()

Check if the union tag is emails.

Return type:bool
is_external_ids()

Check if the union tag is external_ids.

Return type:bool
is_team_member_ids()

Check if the union tag is team_member_ids.

Return type:bool
classmethod team_member_ids(val)

Create an instance of this class set to the team_member_ids tag with value val.

Parameters:of [str] val (list) –
Return type:UsersSelectorArg