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

Information on the browser used for this web session.

Return type:str
expires

The time this session expires.

Return type:datetime.datetime
os

Information on the hosting operating system.

Return type:str
user_agent

Information on the hosting device.

Return type:str
class dropbox.team.AdminTier(tag, value=None)

Bases: dropbox.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('member_only', None)
support_admin = AdminTier('support_admin', None)
team_admin = AdminTier('team_admin', None)
user_management_admin = AdminTier('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: dropbox.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

The application unique id.

Return type:str
app_name

The application name.

Return type:str
is_app_folder

Whether the linked application uses a dedicated folder.

Return type:bool
linked

The time this application was linked.

Return type:datetime.datetime
publisher

The application publisher name.

Return type:str
publisher_url

The publisher’s URL.

Return type:str
class dropbox.team.BaseDfbReport(start_date=None)

Bases: dropbox.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

First date present in the results as ‘YYYY-MM-DD’ or None.

Return type:str
class dropbox.team.BaseTeamFolderError(tag, value=None)

Bases: dropbox.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 (team.TeamFolderAccessError) –
Return type:team.BaseTeamFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:team.TeamFolderAccessError
get_status_error()

Only call this if is_status_error() is true.

Return type:team.TeamFolderInvalidStatusError
get_team_shared_dropbox_error()

Only call this if is_team_shared_dropbox_error() is true.

Return type:team.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('other', None)
classmethod status_error(val)

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

Parameters:val (team.TeamFolderInvalidStatusError) –
Return type:team.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 (team.TeamFolderTeamSharedDropboxError) –
Return type:team.BaseTeamFolderError
class dropbox.team.CustomQuotaError(tag, value=None)

Bases: dropbox.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('other', None)
too_many_users = CustomQuotaError('too_many_users', None)
class dropbox.team.CustomQuotaResult(tag, value=None)

Bases: dropbox.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:team.UserSelectorArg
get_success()

User’s custom quota.

Only call this if is_success() is true.

Return type:team.UserCustomQuotaResult
classmethod invalid_user(val)

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

Parameters:val (team.UserSelectorArg) –
Return type:team.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('other', None)
classmethod success(val)

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

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

Bases: dropbox.stone_base.Struct

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

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

users

List of users.

Return type:list of [team.UserSelectorArg]
class dropbox.team.DateRange(start_date=None, end_date=None)

Bases: dropbox.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

Optional ending date (exclusive).

Return type:datetime.datetime
start_date

Optional starting date (inclusive).

Return type:datetime.datetime
class dropbox.team.DateRangeError(tag, value=None)

Bases: dropbox.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('other', None)
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

The Dropbox desktop client type.

Return type:team.DesktopPlatform
client_version

The Dropbox client version.

Return type:str
host_name

Name of the hosting desktop.

Return type:str

Whether it’s possible to delete all of the account files upon unlinking.

Return type:bool
platform

Information on the hosting platform.

Return type:str
class dropbox.team.DesktopPlatform(tag, value=None)

Bases: dropbox.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('linux', None)
mac = DesktopPlatform('mac', None)
other = DesktopPlatform('other', None)
windows = DesktopPlatform('windows', None)
class dropbox.team.DeviceSession(session_id=None, ip_address=None, country=None, created=None, updated=None)

Bases: dropbox.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

The country from which the last activity from this session was made.

Return type:str
created

The time this session was created.

Return type:datetime.datetime
ip_address

The IP address of the last activity from this session.

Return type:str
session_id

The session id.

Return type:str
updated

The time of the last activity from this session.

Return type:datetime.datetime
class dropbox.team.DeviceSessionArg(session_id=None, team_member_id=None)

Bases: dropbox.stone_base.Struct

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

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

session_id

The session id.

Return type:str
team_member_id

The unique id of the member owning the device.

Return type:str
class dropbox.team.DevicesActive(windows=None, macos=None, linux=None, ios=None, android=None, other=None, total=None)

Bases: dropbox.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

Array of number of linked android devices with activity.

Return type:list of [Optional[int]]
ios

Array of number of linked ios devices with activity.

Return type:list of [Optional[int]]
linux

Array of number of linked linus (desktop) clients with activity.

Return type:list of [Optional[int]]
macos

Array of number of linked mac (desktop) clients with activity.

Return type:list of [Optional[int]]
other

Array of number of other linked devices (blackberry, windows phone, etc) with activity.

Return type:list of [Optional[int]]
total

Array of total number of linked clients with activity.

Return type:list of [Optional[int]]
windows

Array of number of linked windows (desktop) clients with activity.

Return type:list of [Optional[int]]
class dropbox.team.ExcludedUsersListArg(limit=None)

Bases: dropbox.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

Number of results to return per call.

Return type:int
class dropbox.team.ExcludedUsersListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of users.

Return type:str
class dropbox.team.ExcludedUsersListContinueError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.ExcludedUsersListError(tag, value=None)

Bases: dropbox.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('list_error', None)
other = ExcludedUsersListError('other', None)
class dropbox.team.ExcludedUsersListResult(users=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

Excluded users list result.

Variables:
  • team.ExcludedUsersListResult.cursor – Pass the cursor into dropbox.dropbox.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.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

Pass the cursor into dropbox.dropbox.Dropbox.team_member_space_limits_excluded_users_list_continue() to obtain additional excluded users.

Return type:str
has_more

Is true if there are additional excluded users that have not been returned yet. An additional call to dropbox.dropbox.Dropbox.team_member_space_limits_excluded_users_list_continue() can retrieve them.

Return type:bool
users
Return type:list of [team.MemberProfile]
class dropbox.team.ExcludedUsersUpdateArg(users=None)

Bases: dropbox.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

List of users to be added/removed.

Return type:list of [team.UserSelectorArg]
class dropbox.team.ExcludedUsersUpdateError(tag, value=None)

Bases: dropbox.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('other', None)
too_many_users = ExcludedUsersUpdateError('too_many_users', None)
users_not_in_team = ExcludedUsersUpdateError('users_not_in_team', None)
class dropbox.team.ExcludedUsersUpdateResult(status=None)

Bases: dropbox.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

Update status.

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

Bases: dropbox.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('other', None)
success = ExcludedUsersUpdateStatus('success', None)
class dropbox.team.Feature(tag, value=None)

Bases: dropbox.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('has_team_file_events', None)
has_team_selective_sync = Feature('has_team_selective_sync', None)
has_team_shared_dropbox = Feature('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('other', None)
upload_api_rate_limit = Feature('upload_api_rate_limit', None)
class dropbox.team.FeatureValue(tag, value=None)

Bases: dropbox.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:team.HasTeamFileEventsValue
get_has_team_selective_sync()

Only call this if is_has_team_selective_sync() is true.

Return type:team.HasTeamSelectiveSyncValue
get_has_team_shared_dropbox()

Only call this if is_has_team_shared_dropbox() is true.

Return type:team.HasTeamSharedDropboxValue
get_upload_api_rate_limit()

Only call this if is_upload_api_rate_limit() is true.

Return type:team.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 (team.HasTeamFileEventsValue) –
Return type:team.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 (team.HasTeamSelectiveSyncValue) –
Return type:team.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 (team.HasTeamSharedDropboxValue) –
Return type:team.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('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 (team.UploadApiRateLimitValue) –
Return type:team.FeatureValue
class dropbox.team.FeaturesGetValuesBatchArg(features=None)

Bases: dropbox.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

A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError.

Return type:list of [team.Feature]
class dropbox.team.FeaturesGetValuesBatchError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.FeaturesGetValuesBatchResult(values=None)

Bases: dropbox.stone_base.Struct

__init__(values=None)

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

values
Return type:list of [team.FeatureValue]
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

Array of the number of shared folders with some activity in the last day.

Return type:list of [Optional[int]]
active_shared_folders_28_day

Array of the number of shared folders with some activity in the last 28 days.

Return type:list of [Optional[int]]
active_shared_folders_7_day

Array of the number of shared folders with some activity in the last week.

Return type:list of [Optional[int]]
active_users_1_day

Array of the number of users who have been active in the last day.

Return type:list of [Optional[int]]
active_users_28_day

Array of the number of users who have been active in the last 28 days.

Return type:list of [Optional[int]]
active_users_7_day

Array of the number of users who have been active in the last week.

Return type:list of [Optional[int]]
adds

Array of total number of adds by team members.

Return type:list of [Optional[int]]
deletes

Array of total number of deletes by team members.

Return type:list of [Optional[int]]
edits

Array of number of edits by team members. If the same user edits the same file multiple times this is counted as a single edit.

Return type:list of [Optional[int]]

Array of the number of shared links created.

Return type:list of [Optional[int]]

Array of the number of views by non-logged-in users to shared links created by the team.

Return type:list of [Optional[int]]

Array of the number of views by users outside of the team to shared links created by the team.

Return type:list of [Optional[int]]

Array of the number of views by team users to shared links created by the team.

Return type:list of [Optional[int]]

Array of the total number of views to shared links created by the team.

Return type:list of [Optional[int]]
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

Report of the number of devices active in the last day.

Return type:team.DevicesActive
active_28_day

Report of the number of devices active in the last 28 days.

Return type:team.DevicesActive
active_7_day

Report of the number of devices active in the last 7 days.

Return type:team.DevicesActive
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

The total number of licenses the team has, for each day.

Return type:list of [Optional[int]]
members_joined

The number of members that joined the team, for each day.

Return type:list of [Optional[int]]
pending_invites

The number of pending invites to the team, for each day.

Return type:list of [Optional[int]]
suspended_members

The number of suspended team members, for each day.

Return type:list of [Optional[int]]
team_size

Team size, for each day.

Return type:list of [Optional[int]]
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

Array of storage summaries of team members’ account sizes. Each storage summary is an array of key, value pairs, where each pair describes a storage bucket. The key indicates the upper bound of the bucket and the value is the number of users in that bucket. There is one such summary per day. If there is no data for a day, the storage summary will be empty.

Return type:list of [list of [team.StorageBucket]]
shared_folders

Array of the number of shared folders owned by team members, for each day.

Return type:list of [Optional[int]]
shared_usage

Array of the combined size (bytes) of team members’ shared folders, for each day.

Return type:list of [Optional[int]]
total_usage

Sum of the shared, unshared, and datastore usages, for each day.

Return type:list of [Optional[int]]
unshared_usage

Array of the combined size (bytes) of team members’ root namespaces, for each day.

Return type:list of [Optional[int]]
class dropbox.team.GroupAccessType(tag, value=None)

Bases: dropbox.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('member', None)
owner = GroupAccessType('owner', None)
class dropbox.team.GroupCreateArg(group_name=None, group_external_id=None, group_management_type=None)

Bases: dropbox.stone_base.Struct

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

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

group_external_id

The creator of a team can associate an arbitrary external ID to the group.

Return type:str
group_management_type

Whether the team can be managed by selected users, or only by team admins.

Return type:team_common.GroupManagementType
group_name

Group name.

Return type:str
class dropbox.team.GroupCreateError(tag, value=None)

Bases: dropbox.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('external_id_already_in_use', None)
group_name_already_used = GroupCreateError('group_name_already_used', None)
group_name_invalid = GroupCreateError('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('other', None)
system_managed_group_disallowed = GroupCreateError('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('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

The group creation time as a UTC timestamp in milliseconds since the Unix epoch.

Return type:int
members

List of group members.

Return type:list of [team.GroupMemberInfo]
class dropbox.team.GroupMemberInfo(profile=None, access_type=None)

Bases: dropbox.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

The role that the user has in the group.

Return type:team.GroupAccessType
profile

Profile of group member.

Return type:team.MemberProfile
class dropbox.team.GroupMemberSelector(group=None, user=None)

Bases: dropbox.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

Specify a group.

Return type:team.GroupSelector
user

Identity of a user that is a member of group.

Return type:team.UserSelectorArg
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('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('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

Group to which users will be added.

Return type:team.GroupSelector
members

List of users to be added to the group.

Return type:list of [team.MemberAccess]
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('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.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('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:team.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:team.GroupMembersAddError
user_must_be_active_to_be_owner = GroupMembersAddError('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:team.GroupMembersAddError
class dropbox.team.GroupMembersChangeResult(group_info=None, async_job_id=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(group_info=None, async_job_id=None)

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

async_job_id

An ID that can be used to obtain the status of granting/revoking group-owned resources.

Return type:str
group_info

The group info after member change operation has been performed.

Return type:team.GroupFullInfo
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

Group from which users will be removed.

Return type:team.GroupSelector
users

List of users to be removed from the group.

Return type:list of [team.UserSelectorArg]
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('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:team.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:team.GroupMembersRemoveError
class dropbox.team.GroupMembersSelector(group=None, users=None)

Bases: dropbox.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

Specify a group.

Return type:team.GroupSelector
users

A list of users that are members of group.

Return type:team.UsersSelectorArg
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('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

New group access type the user will have.

Return type:team.GroupAccessType
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.

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

Bases: dropbox.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:team.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:team.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: dropbox.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('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('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('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

Specify a group.

Return type:team.GroupSelector
new_group_external_id

Optional argument. New group external ID. If the argument is None, the group’s external_id won’t be updated. If the argument is empty string, the group’s external id will be cleared.

Return type:str
new_group_management_type

Set new group management type, if provided.

Return type:team_common.GroupManagementType
new_group_name

Optional argument. Set group name to this if provided.

Return type:str
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('external_id_already_in_use', None)
group_name_already_used = GroupUpdateError('group_name_already_used', None)
group_name_invalid = GroupUpdateError('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: dropbox.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('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('other', None)
class dropbox.team.GroupsGetInfoItem(tag, value=None)

Bases: dropbox.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:team.GroupFullInfo
get_id_not_found()

An ID that was provided as a parameter to dropbox.dropbox.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 (team.GroupFullInfo) –
Return type:team.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:team.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: dropbox.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

Number of results to return per call.

Return type:int
class dropbox.team.GroupsListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of groups.

Return type:str
class dropbox.team.GroupsListContinueError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.GroupsListResult(groups=None, cursor=None, has_more=None)

Bases: dropbox.stone_base.Struct

Variables:
  • team.GroupsListResult.cursor – Pass the cursor into dropbox.dropbox.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.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

Pass the cursor into dropbox.dropbox.Dropbox.team_groups_list_continue() to obtain the additional groups.

Return type:str
groups
Return type:list of [team_common.GroupSummary]
has_more

Is true if there are additional groups that have not been returned yet. An additional call to dropbox.dropbox.Dropbox.team_groups_list_continue() can retrieve them.

Return type:bool
class dropbox.team.GroupsMembersListArg(group=None, limit=None)

Bases: dropbox.stone_base.Struct

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

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

group

The group whose members are to be listed.

Return type:team.GroupSelector
limit

Number of results to return per call.

Return type:int
class dropbox.team.GroupsMembersListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of groups.

Return type:str
class dropbox.team.GroupsMembersListContinueError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.GroupsMembersListResult(members=None, cursor=None, has_more=None)

Bases: dropbox.stone_base.Struct

Variables:
  • team.GroupsMembersListResult.cursor – Pass the cursor into dropbox.dropbox.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.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

Pass the cursor into dropbox.dropbox.Dropbox.team_groups_members_list_continue() to obtain additional group members.

Return type:str
has_more

Is true if there are additional group members that have not been returned yet. An additional call to dropbox.dropbox.Dropbox.team_groups_members_list_continue() can retrieve them.

Return type:bool
members
Return type:list of [team.GroupMemberInfo]
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('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: dropbox.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:team.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:team.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: dropbox.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:team.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('other', None)
class dropbox.team.HasTeamSelectiveSyncValue(tag, value=None)

Bases: dropbox.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:team.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('other', None)
class dropbox.team.HasTeamSharedDropboxValue(tag, value=None)

Bases: dropbox.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:team.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('other', None)
class dropbox.team.IncludeMembersArg(return_members=None)

Bases: dropbox.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

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.

Return type:bool
class dropbox.team.ListMemberAppsArg(team_member_id=None)

Bases: dropbox.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

The team member id.

Return type:str
class dropbox.team.ListMemberAppsError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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('member_not_found', None)
other = ListMemberAppsError('other', None)
class dropbox.team.ListMemberAppsResult(linked_api_apps=None)

Bases: dropbox.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

List of third party applications linked by this team member.

Return type:list of [team.ApiApp]
class dropbox.team.ListMemberDevicesArg(team_member_id=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: dropbox.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

Whether to list linked desktop devices of the team’s member.

Return type:bool
include_mobile_clients

Whether to list linked mobile devices of the team’s member.

Return type:bool
include_web_sessions

Whether to list web sessions of the team’s member.

Return type:bool
team_member_id

The team’s member id.

Return type:str
class dropbox.team.ListMemberDevicesError(tag, value=None)

Bases: dropbox.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('member_not_found', None)
other = ListMemberDevicesError('other', None)
class dropbox.team.ListMemberDevicesResult(active_web_sessions=None, desktop_client_sessions=None, mobile_client_sessions=None)

Bases: dropbox.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

List of web sessions made by this team member.

Return type:list of [team.ActiveWebSession]
desktop_client_sessions

List of desktop clients used by this team member.

Return type:list of [team.DesktopClientSession]
mobile_client_sessions

List of mobile client used by this team member.

Return type:list of [team.MobileClientSession]
class dropbox.team.ListMembersAppsArg(cursor=None)

Bases: dropbox.stone_base.Struct

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

Variables:team.ListMembersAppsArg.cursor – At the first call to the dropbox.dropbox.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

At the first call to the dropbox.dropbox.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.

Return type:str
class dropbox.team.ListMembersAppsError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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.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('other', None)
reset = ListMembersAppsError('reset', None)
class dropbox.team.ListMembersAppsResult(apps=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

Information returned by dropbox.dropbox.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

The linked applications of each member of the team.

Return type:list of [team.MemberLinkedApps]
cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_linked_apps_list_members_linked_apps() to receive the next sub list of team’s applications.

Return type:str
has_more

If true, then there are more apps available. Pass the cursor to dropbox.dropbox.Dropbox.team_linked_apps_list_members_linked_apps() to retrieve the rest.

Return type:bool
class dropbox.team.ListMembersDevicesArg(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: dropbox.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

At the first call to the dropbox.dropbox.Dropbox.team_devices_list_members_devices() 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 team devices.

Return type:str
include_desktop_clients

Whether to list desktop clients of the team members.

Return type:bool
include_mobile_clients

Whether to list mobile clients of the team members.

Return type:bool
include_web_sessions

Whether to list web sessions of the team members.

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

Bases: dropbox.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.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('other', None)
reset = ListMembersDevicesError('reset', None)
class dropbox.team.ListMembersDevicesResult(devices=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

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

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

cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_devices_list_members_devices() to receive the next sub list of team’s devices.

Return type:str
devices

The devices of each member of the team.

Return type:list of [team.MemberDevices]
has_more

If true, then there are more devices available. Pass the cursor to dropbox.dropbox.Dropbox.team_devices_list_members_devices() to retrieve the rest.

Return type:bool
class dropbox.team.ListTeamAppsArg(cursor=None)

Bases: dropbox.stone_base.Struct

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

Variables:team.ListTeamAppsArg.cursor – At the first call to the dropbox.dropbox.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

At the first call to the dropbox.dropbox.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.

Return type:str
class dropbox.team.ListTeamAppsError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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.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('other', None)
reset = ListTeamAppsError('reset', None)
class dropbox.team.ListTeamAppsResult(apps=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

Information returned by dropbox.dropbox.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.Dropbox.team_linked_apps_list_team_linked_apps() to retrieve the rest.
  • team.ListTeamAppsResult.cursor – Pass the cursor into dropbox.dropbox.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

The linked applications of each member of the team.

Return type:list of [team.MemberLinkedApps]
cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_linked_apps_list_team_linked_apps() to receive the next sub list of team’s applications.

Return type:str
has_more

If true, then there are more apps available. Pass the cursor to dropbox.dropbox.Dropbox.team_linked_apps_list_team_linked_apps() to retrieve the rest.

Return type:bool
class dropbox.team.ListTeamDevicesArg(cursor=None, include_web_sessions=None, include_desktop_clients=None, include_mobile_clients=None)

Bases: dropbox.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

At the first call to the dropbox.dropbox.Dropbox.team_devices_list_team_devices() 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 team devices.

Return type:str
include_desktop_clients

Whether to list desktop clients of the team members.

Return type:bool
include_mobile_clients

Whether to list mobile clients of the team members.

Return type:bool
include_web_sessions

Whether to list web sessions of the team members.

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

Bases: dropbox.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.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('other', None)
reset = ListTeamDevicesError('reset', None)
class dropbox.team.ListTeamDevicesResult(devices=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

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

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

cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_devices_list_team_devices() to receive the next sub list of team’s devices.

Return type:str
devices

The devices of each member of the team.

Return type:list of [team.MemberDevices]
has_more

If true, then there are more devices available. Pass the cursor to dropbox.dropbox.Dropbox.team_devices_list_team_devices() to retrieve the rest.

Return type:bool
class dropbox.team.MemberAccess(user=None, access_type=None)

Bases: dropbox.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

Access type.

Return type:team.GroupAccessType
user

Identity of a user.

Return type:team.UserSelectorArg
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, role=None, is_directory_restricted=None)

Bases: dropbox.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, role=None, is_directory_restricted=None)

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

is_directory_restricted

Whether a user is directory restricted.

Return type:bool
member_email
Return type:str
member_external_id

External ID for member.

Return type:str
member_given_name

Member’s first name.

Return type:str
member_persistent_id

Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.

Return type:str
member_surname

Member’s last name.

Return type:str
role
Return type:team.AdminTier
send_welcome_email

Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.

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

Bases: dropbox.stone_base.Union

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:
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:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
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_success()

Describes a user that was successfully added to the team.

Only call this if is_success() is true.

Return type:team.TeamMemberInfo
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_success()

Check if the union tag is success.

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:team.MemberAddResult
classmethod success(val)

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

Parameters:val (team.TeamMemberInfo) –
Return type:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
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:team.MemberAddResult
class dropbox.team.MemberDevices(team_member_id=None, web_sessions=None, desktop_clients=None, mobile_clients=None)

Bases: dropbox.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

List of desktop clients by this team member.

Return type:list of [team.DesktopClientSession]
mobile_clients

List of mobile clients by this team member.

Return type:list of [team.MobileClientSession]
team_member_id

The member unique Id.

Return type:str
web_sessions

List of web sessions made by this team member.

Return type:list of [team.ActiveWebSession]
class dropbox.team.MemberLinkedApps(team_member_id=None, linked_api_apps=None)

Bases: dropbox.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

List of third party applications linked by this team member.

Return type:list of [team.ApiApp]
team_member_id

The member unique Id.

Return type:str
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, joined_on=None, persistent_id=None, is_directory_restricted=None)

Bases: dropbox.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, joined_on=None, persistent_id=None, is_directory_restricted=None)

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

account_id

A user’s account identifier.

Return type:str
email

Email address of user.

Return type:str
email_verified

Is true if the user’s email is verified to be owned by the user.

Return type:bool
external_id

External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.

Return type:str
is_directory_restricted

Whether the user is a directory restricted user.

Return type:bool
joined_on

The date and time the user joined as a member of a specific team.

Return type:datetime.datetime
membership_type

The user’s membership type: full (normal team member) vs limited (does not use a license; no access to the team’s shared quota).

Return type:team.TeamMembershipType
name

Representations for a person’s name.

Return type:users.Name
persistent_id

Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.

Return type:str
status

The user’s status as a member of a specific team.

Return type:team.TeamMemberStatus
team_member_id

ID of user as a member of a team.

Return type:str
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('user_not_in_team', None)
class dropbox.team.MembersAddArg(new_members=None, force_async=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(new_members=None, force_async=None)

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

force_async

Whether to force the add to happen asynchronously.

Return type:bool
new_members

Details of new members to be added to the team.

Return type:list of [team.MemberAddArg]
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 [team.MemberAddResult] val (list) –
Return type:team.MembersAddJobStatus
classmethod failed(val)

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

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

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

Only call this if is_complete() is true.

Return type:list of [team.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.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 [team.MemberAddResult] val (list) –
Return type:team.MembersAddLaunch
get_complete()

Only call this if is_complete() is true.

Return type:list of [team.MemberAddResult]
is_complete()

Check if the union tag is complete.

Return type:bool
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

Errors during the transfer process will be sent via email to this user.

Return type:team.UserSelectorArg
transfer_dest_id

Files from the deleted member account will be transferred to this user.

Return type:team.UserSelectorArg
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

If provided, controls if the user’s data will be deleted on their linked devices.

Return type:bool
class dropbox.team.MembersDeactivateBaseArg(user=None)

Bases: dropbox.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

Identity of user to remove/suspend/have their files moved.

Return type:team.UserSelectorArg
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('other', None)
user_not_in_team = MembersDeactivateError('user_not_in_team', None)
class dropbox.team.MembersGetInfoArgs(members=None)

Bases: dropbox.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

List of team members.

Return type:list of [team.UserSelectorArg]
class dropbox.team.MembersGetInfoError(tag, value=None)

Bases: dropbox.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('other', None)
class dropbox.team.MembersGetInfoItem(tag, value=None)

Bases: dropbox.stone_base.Union

Describes a result obtained for a single user whose id was specified in the parameter of dropbox.dropbox.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:
get_id_not_found()

An ID that was provided as a parameter to dropbox.dropbox.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
get_member_info()

Info about a team member.

Only call this if is_member_info() is true.

Return type:team.TeamMemberInfo
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:team.MembersGetInfoItem
is_id_not_found()

Check if the union tag is id_not_found.

Return type:bool
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 (team.TeamMemberInfo) –
Return type:team.MembersGetInfoItem
class dropbox.team.MembersListArg(limit=None, include_removed=None)

Bases: dropbox.stone_base.Struct

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

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

include_removed

Whether to return removed members.

Return type:bool
limit

Number of results to return per call.

Return type:int
class dropbox.team.MembersListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of members.

Return type:str
class dropbox.team.MembersListContinueError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.MembersListError(tag, value=None)

Bases: dropbox.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('other', None)
class dropbox.team.MembersListResult(members=None, cursor=None, has_more=None)

Bases: dropbox.stone_base.Struct

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

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

cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_members_list_continue() to obtain the additional members.

Return type:str
has_more

Is true if there are additional team members that have not been returned yet. An additional call to dropbox.dropbox.Dropbox.team_members_list_continue() can retrieve them.

Return type:bool
members

List of team members.

Return type:list of [team.TeamMemberInfo]
class dropbox.team.MembersRecoverArg(user=None)

Bases: dropbox.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

Identity of user to recover.

Return type:team.UserSelectorArg
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('other', None)
team_license_limit = MembersRecoverError('team_license_limit', None)
user_not_in_team = MembersRecoverError('user_not_in_team', None)
user_unrecoverable = MembersRecoverError('user_unrecoverable', None)
class dropbox.team.MembersRemoveArg(user=None, wipe_data=None, transfer_dest_id=None, transfer_admin_id=None, keep_account=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.
__init__(user=None, wipe_data=None, transfer_dest_id=None, transfer_admin_id=None, keep_account=None)

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

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.

Return type:bool
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.

Return type:team.UserSelectorArg
transfer_dest_id

If provided, files from the deleted member account will be transferred to this user.

Return type:team.UserSelectorArg
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:
cannot_keep_account_and_delete_data = MembersRemoveError('cannot_keep_account_and_delete_data', None)
cannot_keep_account_and_transfer = MembersRemoveError('cannot_keep_account_and_transfer', None)
cannot_keep_invited_user_account = MembersRemoveError('cannot_keep_invited_user_account', None)
email_address_too_long_to_be_disabled = MembersRemoveError('email_address_too_long_to_be_disabled', None)
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_invited_user_account()

Check if the union tag is cannot_keep_invited_user_account.

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('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('other', None)
class dropbox.team.MembersSetPermissionsArg(user=None, new_role=None)

Bases: dropbox.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

The new role of the member.

Return type:team.AdminTier
user

Identity of user whose role will be set.

Return type:team.UserSelectorArg
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('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('last_admin', None)
other = MembersSetPermissionsError('other', None)
team_license_limit = MembersSetPermissionsError('team_license_limit', None)
user_not_in_team = MembersSetPermissionsError('user_not_in_team', None)
class dropbox.team.MembersSetPermissionsResult(team_member_id=None, role=None)

Bases: dropbox.stone_base.Struct

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

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

role

The role after the change.

Return type:team.AdminTier
team_member_id

The member ID of the user to which the change was applied.

Return type:str
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: dropbox.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 email for member.

Return type:str
new_external_id

New external ID for member.

Return type:str
new_given_name

New given name for member.

Return type:str
new_is_directory_restricted

New value for whether the user is a directory restricted user.

Return type:bool
new_persistent_id

New persistent ID. This field only available to teams using persistent ID SAML configuration.

Return type:str
new_surname

New surname for member.

Return type:str
user

Identity of user whose profile will be set.

Return type:team.UserSelectorArg
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('directory_restricted_off', None)
email_reserved_for_other_user = MembersSetProfileError('email_reserved_for_other_user', None)
external_id_and_new_external_id_unsafe = MembersSetProfileError('external_id_and_new_external_id_unsafe', None)
external_id_used_by_other_user = MembersSetProfileError('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('no_new_data_specified', None)
other = MembersSetProfileError('other', None)
param_cannot_be_empty = MembersSetProfileError('param_cannot_be_empty', None)
persistent_id_disabled = MembersSetProfileError('persistent_id_disabled', None)
persistent_id_used_by_other_user = MembersSetProfileError('persistent_id_used_by_other_user', None)
set_profile_disallowed = MembersSetProfileError('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('suspend_inactive_user', None)
suspend_last_admin = MembersSuspendError('suspend_last_admin', None)
team_license_limit = MembersSuspendError('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('recipient_not_verified', None)
removed_and_transfer_admin_should_differ = MembersTransferFilesError('removed_and_transfer_admin_should_differ', None)
removed_and_transfer_dest_should_differ = MembersTransferFilesError('removed_and_transfer_dest_should_differ', None)
transfer_admin_is_not_admin = MembersTransferFilesError('transfer_admin_is_not_admin', None)
transfer_admin_user_not_found = MembersTransferFilesError('transfer_admin_user_not_found', None)
transfer_admin_user_not_in_team = MembersTransferFilesError('transfer_admin_user_not_in_team', None)
transfer_dest_user_not_found = MembersTransferFilesError('transfer_dest_user_not_found', None)
transfer_dest_user_not_in_team = MembersTransferFilesError('transfer_dest_user_not_in_team', None)
unspecified_transfer_admin_id = MembersTransferFilesError('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('user_data_already_transferred', None)
user_data_cannot_be_transferred = MembersTransferFormerMembersFilesError('user_data_cannot_be_transferred', None)
user_data_is_being_transferred = MembersTransferFormerMembersFilesError('user_data_is_being_transferred', None)
user_not_removed = MembersTransferFormerMembersFilesError('user_not_removed', None)
class dropbox.team.MembersUnsuspendArg(user=None)

Bases: dropbox.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

Identity of user to unsuspend.

Return type:team.UserSelectorArg
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('team_license_limit', None)
unsuspend_non_suspended_member = MembersUnsuspendError('unsuspend_non_suspended_member', None)
class dropbox.team.MobileClientPlatform(tag, value=None)

Bases: dropbox.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('android', None)
blackberry = MobileClientPlatform('blackberry', None)
ipad = MobileClientPlatform('ipad', None)
iphone = MobileClientPlatform('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('other', None)
windows_phone = MobileClientPlatform('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

The mobile application type.

Return type:team.MobileClientPlatform
client_version

The dropbox client version.

Return type:str
device_name

The device name.

Return type:str
last_carrier

last carrier used by the device.

Return type:str
os_version

The hosting OS version.

Return type:str
class dropbox.team.NamespaceMetadata(name=None, namespace_id=None, namespace_type=None, team_member_id=None)

Bases: dropbox.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

The name of this namespace.

Return type:str
namespace_id

The ID of this namespace.

Return type:str
namespace_type

The type of this namespace.

Return type:team.NamespaceType
team_member_id

If this is a team member or app folder, the ID of the owning team member. Otherwise, this field is not present.

Return type:str
class dropbox.team.NamespaceType(tag, value=None)

Bases: dropbox.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('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('other', None)
shared_folder = NamespaceType('shared_folder', None)
team_folder = NamespaceType('team_folder', None)
team_member_folder = NamespaceType('team_member_folder', None)
class dropbox.team.RemoveCustomQuotaResult(tag, value=None)

Bases: dropbox.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:team.UserSelectorArg
get_success()

Successfully removed user.

Only call this if is_success() is true.

Return type:team.UserSelectorArg
classmethod invalid_user(val)

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

Parameters:val (team.UserSelectorArg) –
Return type:team.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('other', None)
classmethod success(val)

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

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

Bases: dropbox.stone_base.Struct

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

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

is_disconnected

True if the team member’s account was converted to individual account.

Return type:bool
is_recoverable

True if the removed team member is recoverable.

Return type:bool
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

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).

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

Bases: dropbox.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 (team.RevokeDesktopClientArg) –
Return type:team.RevokeDeviceSessionArg
get_desktop_client()

Unlink a linked desktop device.

Only call this if is_desktop_client() is true.

Return type:team.RevokeDesktopClientArg
get_mobile_client()

Unlink a linked mobile device.

Only call this if is_mobile_client() is true.

Return type:team.DeviceSessionArg
get_web_session()

End an active session.

Only call this if is_web_session() is true.

Return type:team.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 (team.DeviceSessionArg) –
Return type:team.RevokeDeviceSessionArg
classmethod web_session(val)

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

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

Bases: dropbox.stone_base.Struct

__init__(revoke_devices=None)

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

revoke_devices
Return type:list of [team.RevokeDeviceSessionArg]
class dropbox.team.RevokeDeviceSessionBatchError(tag, value=None)

Bases: dropbox.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('other', None)
class dropbox.team.RevokeDeviceSessionBatchResult(revoke_devices_status=None)

Bases: dropbox.stone_base.Struct

__init__(revoke_devices_status=None)

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

revoke_devices_status
Return type:list of [team.RevokeDeviceSessionStatus]
class dropbox.team.RevokeDeviceSessionError(tag, value=None)

Bases: dropbox.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('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('member_not_found', None)
other = RevokeDeviceSessionError('other', None)
class dropbox.team.RevokeDeviceSessionStatus(success=None, error_type=None)

Bases: dropbox.stone_base.Struct

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

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

error_type

The error cause in case of a failure.

Return type:team.RevokeDeviceSessionError
success

Result of the revoking request.

Return type:bool
class dropbox.team.RevokeLinkedApiAppArg(app_id=None, team_member_id=None, keep_app_folder=None)

Bases: dropbox.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

The application’s unique id.

Return type:str
keep_app_folder

Whether to keep the application dedicated folder (in case the application uses one).

Return type:bool
team_member_id

The unique id of the member owning the device.

Return type:str
class dropbox.team.RevokeLinkedApiAppBatchArg(revoke_linked_app=None)

Bases: dropbox.stone_base.Struct

__init__(revoke_linked_app=None)

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

revoke_linked_app
Return type:list of [team.RevokeLinkedApiAppArg]
class dropbox.team.RevokeLinkedAppBatchError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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('other', None)
class dropbox.team.RevokeLinkedAppBatchResult(revoke_linked_app_status=None)

Bases: dropbox.stone_base.Struct

__init__(revoke_linked_app_status=None)

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

revoke_linked_app_status
Return type:list of [team.RevokeLinkedAppStatus]
class dropbox.team.RevokeLinkedAppError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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_not_found = RevokeLinkedAppError('app_not_found', None)
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('member_not_found', None)
other = RevokeLinkedAppError('other', None)
class dropbox.team.RevokeLinkedAppStatus(success=None, error_type=None)

Bases: dropbox.stone_base.Struct

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

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

error_type

The error cause in case of a failure.

Return type:team.RevokeLinkedAppError
success

Result of the revoking request.

Return type:bool
class dropbox.team.SetCustomQuotaArg(users_and_quotas=None)

Bases: dropbox.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

List of users and their custom quotas.

Return type:list of [team.UserCustomQuotaArg]
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('some_users_are_excluded', None)
class dropbox.team.StorageBucket(bucket=None, users=None)

Bases: dropbox.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

The name of the storage bucket. For example, ‘1G’ is a bucket of users with storage size up to 1 Giga.

Return type:str
users

The number of people whose storage is in the range of this storage bucket.

Return type:int
class dropbox.team.TeamFolderAccessError(tag, value=None)

Bases: dropbox.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('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('no_access', None)
other = TeamFolderAccessError('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

Whether to force the archive to happen synchronously.

Return type:bool
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 (team.TeamFolderMetadata) –
Return type:team.TeamFolderArchiveJobStatus
classmethod failed(val)

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

Parameters:val (team.TeamFolderArchiveError) –
Return type:team.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:team.TeamFolderMetadata
get_failed()

Error occurred while performing an asynchronous job from dropbox.dropbox.Dropbox.team_team_folder_archive().

Only call this if is_failed() is true.

Return type:team.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 (team.TeamFolderMetadata) –
Return type:team.TeamFolderArchiveLaunch
get_complete()

Only call this if is_complete() is true.

Return type:team.TeamFolderMetadata
is_complete()

Check if the union tag is complete.

Return type:bool
class dropbox.team.TeamFolderCreateArg(name=None, sync_setting=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(name=None, sync_setting=None)

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

name

Name for the new team folder.

Return type:str
sync_setting

The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled.

Return type:files.SyncSettingArg
class dropbox.team.TeamFolderCreateError(tag, value=None)

Bases: dropbox.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('folder_name_already_used', None)
folder_name_reserved = TeamFolderCreateError('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('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('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:team.TeamFolderCreateError
class dropbox.team.TeamFolderGetInfoItem(tag, value=None)

Bases: dropbox.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.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:team.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:team.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 (team.TeamFolderMetadata) –
Return type:team.TeamFolderGetInfoItem
class dropbox.team.TeamFolderIdArg(team_folder_id=None)

Bases: dropbox.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

The ID of the team folder.

Return type:str
class dropbox.team.TeamFolderIdListArg(team_folder_ids=None)

Bases: dropbox.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

The list of team folder IDs.

Return type:list of [str]
class dropbox.team.TeamFolderInvalidStatusError(tag, value=None)

Bases: dropbox.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('active', None)
archive_in_progress = TeamFolderInvalidStatusError('archive_in_progress', None)
archived = TeamFolderInvalidStatusError('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('other', None)
class dropbox.team.TeamFolderListArg(limit=None)

Bases: dropbox.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

The maximum number of results to return per request.

Return type:int
class dropbox.team.TeamFolderListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of team folders.

Return type:str
class dropbox.team.TeamFolderListContinueError(tag, value=None)

Bases: dropbox.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('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('other', None)
class dropbox.team.TeamFolderListError(access_error=None)

Bases: dropbox.stone_base.Struct

__init__(access_error=None)

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

access_error
Return type:team.TeamFolderAccessError
class dropbox.team.TeamFolderListResult(team_folders=None, cursor=None, has_more=None)

Bases: dropbox.stone_base.Struct

Result for dropbox.dropbox.Dropbox.team_team_folder_list() and dropbox.dropbox.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

Pass the cursor into dropbox.dropbox.Dropbox.team_team_folder_list_continue() to obtain additional team folders.

Return type:str
has_more

Is true if there are additional team folders that have not been returned yet. An additional call to dropbox.dropbox.Dropbox.team_team_folder_list_continue() can retrieve them.

Return type:bool
team_folders

List of all team folders in the authenticated team.

Return type:list of [team.TeamFolderMetadata]
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: dropbox.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

Sync settings applied to contents of this team folder.

Return type:list of [files.ContentSyncSetting]
is_team_shared_dropbox

True if this team folder is a shared team root.

Return type:bool
name

The name of the team folder.

Return type:str
status

The status of the team folder.

Return type:team.TeamFolderStatus
sync_setting

The sync setting applied to this team folder.

Return type:files.SyncSetting
team_folder_id

The ID of the team folder.

Return type:str
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

New team folder name.

Return type:str
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('folder_name_already_used', None)
folder_name_reserved = TeamFolderRenameError('folder_name_reserved', None)
invalid_folder_name = TeamFolderRenameError('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: dropbox.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('active', None)
archive_in_progress = TeamFolderStatus('archive_in_progress', None)
archived = TeamFolderStatus('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('other', None)
class dropbox.team.TeamFolderTeamSharedDropboxError(tag, value=None)

Bases: dropbox.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('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('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 settings to apply to contents of this team folder.

Return type:list of [files.ContentSyncSettingArg]
sync_setting

Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root.

Return type:files.SyncSettingArg
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
team.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:team.TeamFolderUpdateSyncSettingsError
class dropbox.team.TeamGetInfoResult(name=None, team_id=None, num_licensed_users=None, num_provisioned_users=None, policies=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(name=None, team_id=None, num_licensed_users=None, num_provisioned_users=None, policies=None)

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

name

The name of the team.

Return type:str
num_licensed_users

The number of licenses available to the team.

Return type:int
num_provisioned_users

The number of accounts that have been invited or are already active members of the team.

Return type:int
policies
Return type:team_policies.TeamMemberPolicies
team_id

The ID of the team.

Return type:str
class dropbox.team.TeamMemberInfo(profile=None, role=None)

Bases: dropbox.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

Profile of a user as a member of a team.

Return type:team.TeamMemberProfile
role

The user’s role in the team.

Return type:team.AdminTier
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, joined_on=None, persistent_id=None, is_directory_restricted=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, joined_on=None, persistent_id=None, is_directory_restricted=None)

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

groups

List of group IDs of groups that the user belongs to.

Return type:list of [str]
member_folder_id

The namespace id of the user’s root folder.

Return type:str
class dropbox.team.TeamMemberStatus(tag, value=None)

Bases: dropbox.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('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:team.RemovedStatus
invited = TeamMemberStatus('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 (team.RemovedStatus) –
Return type:team.TeamMemberStatus
suspended = TeamMemberStatus('suspended', None)
class dropbox.team.TeamMembershipType(tag, value=None)

Bases: dropbox.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('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('limited', None)
class dropbox.team.TeamNamespacesListArg(limit=None)

Bases: dropbox.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

Specifying a value here has no effect.

Return type:int
class dropbox.team.TeamNamespacesListContinueArg(cursor=None)

Bases: dropbox.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

Indicates from what point to get the next set of team-accessible namespaces.

Return type:str
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('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: dropbox.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('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('other', None)
class dropbox.team.TeamNamespacesListResult(namespaces=None, cursor=None, has_more=None)

Bases: dropbox.stone_base.Struct

Result for dropbox.dropbox.Dropbox.team_namespaces_list().

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

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

cursor

Pass the cursor into dropbox.dropbox.Dropbox.team_namespaces_list_continue() to obtain additional namespaces. Note that duplicate namespaces may be returned.

Return type:str
has_more

Is true if there are additional namespaces that have not been returned yet.

Return type:bool
namespaces

List of all namespaces the team can access.

Return type:list of [team.NamespaceMetadata]
class dropbox.team.TokenGetAuthenticatedAdminError(tag, value=None)

Bases: dropbox.stone_base.Union

Error returned by dropbox.dropbox.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('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('mapping_not_found', None)
other = TokenGetAuthenticatedAdminError('other', None)
class dropbox.team.TokenGetAuthenticatedAdminResult(admin_profile=None)

Bases: dropbox.stone_base.Struct

Results for dropbox.dropbox.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

The admin who authorized the token.

Return type:team.TeamMemberProfile
class dropbox.team.UploadApiRateLimitValue(tag, value=None)

Bases: dropbox.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:team.UploadApiRateLimitValue
other = UploadApiRateLimitValue('other', None)
unlimited = UploadApiRateLimitValue('unlimited', None)
class dropbox.team.UserCustomQuotaArg(user=None, quota_gb=None)

Bases: dropbox.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
Return type:int
user
Return type:team.UserSelectorArg
class dropbox.team.UserCustomQuotaResult(user=None, quota_gb=None)

Bases: dropbox.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
Return type:int
user
Return type:team.UserSelectorArg
class dropbox.team.UserSelectorArg(tag, value=None)

Bases: dropbox.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:team.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:team.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:team.UserSelectorArg
class dropbox.team.UserSelectorError(tag, value=None)

Bases: dropbox.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('user_not_found', None)
class dropbox.team.UsersSelectorArg(tag, value=None)

Bases: dropbox.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:team.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:team.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:team.UsersSelectorArg