Skip to content

Commit f52ae3f

Browse files
author
rob
committed
Updated spec
1 parent 64dece9 commit f52ae3f

File tree

13 files changed

+12226
-6102
lines changed

13 files changed

+12226
-6102
lines changed

‎dropbox/base.py

Lines changed: 313 additions & 54 deletions
Large diffs are not rendered by default.

‎dropbox/base_team.py

Lines changed: 151 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ def team_devices_list_member_devices(self,
4141
"""
4242
List all device sessions of a team's member.
4343
44-
:param str team_member_id: The team's member id
44+
:param str team_member_id: The team's member id.
4545
:param bool include_web_sessions: Whether to list web sessions of the
46-
team's member
46+
team's member.
4747
:param bool include_desktop_clients: Whether to list linked desktop
48-
devices of the team's member
48+
devices of the team's member.
4949
:param bool include_mobile_clients: Whether to list linked mobile
50-
devices of the team's member
50+
devices of the team's member.
5151
:rtype: :class:`dropbox.team.ListMemberDevicesResult`
5252
:raises: :class:`dropbox.exceptions.ApiError`
5353
@@ -78,13 +78,13 @@ def team_devices_list_members_devices(self,
7878
:meth:`team_devices_list_members_devices` the cursor shouldn't be
7979
passed. Then, if the result of the call includes a cursor, the
8080
following requests should include the received cursors in order to
81-
receive the next sub list of team devices
81+
receive the next sub list of team devices.
8282
:param bool include_web_sessions: Whether to list web sessions of the
83-
team members
83+
team members.
8484
:param bool include_desktop_clients: Whether to list desktop clients of
85-
the team members
85+
the team members.
8686
:param bool include_mobile_clients: Whether to list mobile clients of
87-
the team members
87+
the team members.
8888
:rtype: :class:`dropbox.team.ListMembersDevicesResult`
8989
:raises: :class:`dropbox.exceptions.ApiError`
9090
@@ -115,13 +115,13 @@ def team_devices_list_team_devices(self,
115115
:meth:`team_devices_list_team_devices` the cursor shouldn't be
116116
passed. Then, if the result of the call includes a cursor, the
117117
following requests should include the received cursors in order to
118-
receive the next sub list of team devices
118+
receive the next sub list of team devices.
119119
:param bool include_web_sessions: Whether to list web sessions of the
120-
team members
120+
team members.
121121
:param bool include_desktop_clients: Whether to list desktop clients of
122-
the team members
122+
the team members.
123123
:param bool include_mobile_clients: Whether to list mobile clients of
124-
the team members
124+
the team members.
125125
:rtype: :class:`dropbox.team.ListTeamDevicesResult`
126126
:raises: :class:`dropbox.exceptions.ApiError`
127127
@@ -147,7 +147,7 @@ def team_devices_list_team_devices(self,
147147
def team_devices_revoke_device_session(self,
148148
arg):
149149
"""
150-
Revoke a device session of a team's member
150+
Revoke a device session of a team's member.
151151
152152
:type arg: :class:`dropbox.team.RevokeDeviceSessionArg`
153153
:rtype: None
@@ -167,7 +167,7 @@ def team_devices_revoke_device_session(self,
167167
def team_devices_revoke_device_session_batch(self,
168168
revoke_devices):
169169
"""
170-
Revoke a list of device sessions of team members
170+
Revoke a list of device sessions of team members.
171171
172172
:type revoke_devices: list
173173
:rtype: :class:`dropbox.team.RevokeDeviceSessionBatchResult`
@@ -558,7 +558,7 @@ def team_linked_apps_list_member_linked_apps(self,
558558
List all linked applications of the team member. Note, this endpoint
559559
does not list any team-linked applications.
560560
561-
:param str team_member_id: The team member id
561+
:param str team_member_id: The team member id.
562562
:rtype: :class:`dropbox.team.ListMemberAppsResult`
563563
:raises: :class:`dropbox.exceptions.ApiError`
564564
@@ -584,7 +584,7 @@ def team_linked_apps_list_members_linked_apps(self,
584584
:meth:`team_linked_apps_list_members_linked_apps` the cursor
585585
shouldn't be passed. Then, if the result of the call includes a
586586
cursor, the following requests should include the received cursors
587-
in order to receive the next sub list of the team applications
587+
in order to receive the next sub list of the team applications.
588588
:rtype: :class:`dropbox.team.ListMembersAppsResult`
589589
:raises: :class:`dropbox.exceptions.ApiError`
590590
@@ -610,7 +610,7 @@ def team_linked_apps_list_team_linked_apps(self,
610610
:meth:`team_linked_apps_list_team_linked_apps` the cursor shouldn't
611611
be passed. Then, if the result of the call includes a cursor, the
612612
following requests should include the received cursors in order to
613-
receive the next sub list of the team applications
613+
receive the next sub list of the team applications.
614614
:rtype: :class:`dropbox.team.ListTeamAppsResult`
615615
:raises: :class:`dropbox.exceptions.ApiError`
616616
@@ -635,12 +635,13 @@ def team_linked_apps_revoke_linked_app(self,
635635
team_member_id,
636636
keep_app_folder=True):
637637
"""
638-
Revoke a linked application of the team member
638+
Revoke a linked application of the team member.
639639
640-
:param str app_id: The application's unique id
641-
:param str team_member_id: The unique id of the member owning the device
640+
:param str app_id: The application's unique id.
641+
:param str team_member_id: The unique id of the member owning the
642+
device.
642643
:param bool keep_app_folder: Whether to keep the application dedicated
643-
folder (in case the application uses one)
644+
folder (in case the application uses one).
644645
:rtype: None
645646
:raises: :class:`dropbox.exceptions.ApiError`
646647
@@ -661,7 +662,7 @@ def team_linked_apps_revoke_linked_app(self,
661662
def team_linked_apps_revoke_linked_app_batch(self,
662663
revoke_linked_app):
663664
"""
664-
Revoke a list of linked applications of the team members
665+
Revoke a list of linked applications of the team members.
665666
666667
:type revoke_linked_app: list
667668
:rtype: :class:`dropbox.team.RevokeLinkedAppBatchResult`
@@ -679,6 +680,72 @@ def team_linked_apps_revoke_linked_app_batch(self,
679680
)
680681
return r
681682

683+
def team_member_space_limits_get_custom_quota(self,
684+
users):
685+
"""
686+
Get users custom quota. Returns none as the custom quota if none was
687+
set. A maximum of 1000 members can be specified in a single call.
688+
689+
:param list users: List of users.
690+
:rtype: list
691+
:raises: :class:`dropbox.exceptions.ApiError`
692+
693+
If this raises, ApiError.reason is of type:
694+
:class:`dropbox.team.CustomQuotaError`
695+
"""
696+
arg = team.CustomQuotaUsersArg(users)
697+
r = self.request(
698+
team.member_space_limits_get_custom_quota,
699+
'team',
700+
arg,
701+
None,
702+
)
703+
return r
704+
705+
def team_member_space_limits_remove_custom_quota(self,
706+
users):
707+
"""
708+
Remove users custom quota. A maximum of 1000 members can be specified in
709+
a single call.
710+
711+
:param list users: List of users.
712+
:rtype: list
713+
:raises: :class:`dropbox.exceptions.ApiError`
714+
715+
If this raises, ApiError.reason is of type:
716+
:class:`dropbox.team.CustomQuotaError`
717+
"""
718+
arg = team.CustomQuotaUsersArg(users)
719+
r = self.request(
720+
team.member_space_limits_remove_custom_quota,
721+
'team',
722+
arg,
723+
None,
724+
)
725+
return r
726+
727+
def team_member_space_limits_set_custom_quota(self,
728+
users_and_quotas):
729+
"""
730+
Set users custom quota. Custom quota has to be at least 25GB. A maximum
731+
of 1000 members can be specified in a single call.
732+
733+
:param list users_and_quotas: List of users and their custom quotas.
734+
:rtype: list
735+
:raises: :class:`dropbox.exceptions.ApiError`
736+
737+
If this raises, ApiError.reason is of type:
738+
:class:`dropbox.team.CustomQuotaError`
739+
"""
740+
arg = team.SetCustomQuotaArg(users_and_quotas)
741+
r = self.request(
742+
team.member_space_limits_set_custom_quota,
743+
'team',
744+
arg,
745+
None,
746+
)
747+
return r
748+
682749
def team_members_add(self,
683750
new_members,
684751
force_async=False):
@@ -715,7 +782,7 @@ def team_members_add_job_status_get(self,
715782
"""
716783
Once an async_job_id is returned from :meth:`team_members_add` , use
717784
this to poll the status of the asynchronous request. Permission : Team
718-
member management
785+
member management.
719786
720787
:param str async_job_id: Id of the asynchronous job. This is the value
721788
of a response returned from the method that launched the job.
@@ -762,7 +829,7 @@ def team_members_list(self,
762829
limit=1000,
763830
include_removed=False):
764831
"""
765-
Lists members of a team. Permission : Team information
832+
Lists members of a team. Permission : Team information.
766833
767834
:param long limit: Number of results to return per call.
768835
:param bool include_removed: Whether to return removed members.
@@ -786,7 +853,8 @@ def team_members_list_continue(self,
786853
cursor):
787854
"""
788855
Once a cursor has been retrieved from :meth:`team_members_list`, use
789-
this to paginate through all team members. Permission : Team information
856+
this to paginate through all team members. Permission : Team
857+
information.
790858
791859
:param str cursor: Indicates from what point to get the next set of
792860
members.
@@ -882,7 +950,7 @@ def team_members_remove_job_status_get(self,
882950
"""
883951
Once an async_job_id is returned from :meth:`team_members_remove` , use
884952
this to poll the status of the asynchronous request. Permission : Team
885-
member management
953+
member management.
886954
887955
:param str async_job_id: Id of the asynchronous job. This is the value
888956
of a response returned from the method that launched the job.
@@ -930,7 +998,8 @@ def team_members_set_admin_permissions(self,
930998
user,
931999
new_role):
9321000
"""
933-
Updates a team member's permissions. Permission : Team member management
1001+
Updates a team member's permissions. Permission : Team member
1002+
management.
9341003
9351004
:param user: Identity of user whose role will be set.
9361005
:type user: :class:`dropbox.team.UserSelectorArg`
@@ -960,7 +1029,7 @@ def team_members_set_profile(self,
9601029
new_surname=None,
9611030
new_persistent_id=None):
9621031
"""
963-
Updates a team member's profile. Permission : Team member management
1032+
Updates a team member's profile. Permission : Team member management.
9641033
9651034
:param user: Identity of user whose profile will be set.
9661035
:type user: :class:`dropbox.team.UserSelectorArg`
@@ -1042,6 +1111,52 @@ def team_members_unsuspend(self,
10421111
)
10431112
return None
10441113

1114+
def team_namespaces_list(self,
1115+
limit=1000):
1116+
"""
1117+
Returns a list of all team-accessible namespaces. This list includes
1118+
team folders, shared folders containing team members, team members' home
1119+
namespaces, and team members' app folders. Home namespaces and app
1120+
folders are always owned by this team or members of the team, but shared
1121+
folders may be owned by other users or other teams. Duplicates may occur
1122+
in the list.
1123+
1124+
:param long limit: Specifying a value here has no effect.
1125+
:rtype: :class:`dropbox.team.TeamNamespacesListResult`
1126+
"""
1127+
arg = team.TeamNamespacesListArg(limit)
1128+
r = self.request(
1129+
team.namespaces_list,
1130+
'team',
1131+
arg,
1132+
None,
1133+
)
1134+
return r
1135+
1136+
def team_namespaces_list_continue(self,
1137+
cursor):
1138+
"""
1139+
Once a cursor has been retrieved from :meth:`team_namespaces_list`, use
1140+
this to paginate through all team-accessible namespaces. Duplicates may
1141+
occur in the list.
1142+
1143+
:param str cursor: Indicates from what point to get the next set of
1144+
team-accessible namespaces.
1145+
:rtype: :class:`dropbox.team.TeamNamespacesListResult`
1146+
:raises: :class:`dropbox.exceptions.ApiError`
1147+
1148+
If this raises, ApiError.reason is of type:
1149+
:class:`dropbox.team.TeamNamespacesListContinueError`
1150+
"""
1151+
arg = team.TeamNamespacesListContinueArg(cursor)
1152+
r = self.request(
1153+
team.namespaces_list_continue,
1154+
'team',
1155+
arg,
1156+
None,
1157+
)
1158+
return r
1159+
10451160
def team_properties_template_add(self,
10461161
name,
10471162
description,
@@ -1151,8 +1266,8 @@ def team_reports_get_activity(self,
11511266
"""
11521267
Retrieves reporting data about a team's user activity.
11531268
1154-
:param Nullable start_date: Optional starting date (inclusive)
1155-
:param Nullable end_date: Optional ending date (exclusive)
1269+
:param Nullable start_date: Optional starting date (inclusive).
1270+
:param Nullable end_date: Optional ending date (exclusive).
11561271
:rtype: :class:`dropbox.team.GetActivityReport`
11571272
:raises: :class:`dropbox.exceptions.ApiError`
11581273
@@ -1175,8 +1290,8 @@ def team_reports_get_devices(self,
11751290
"""
11761291
Retrieves reporting data about a team's linked devices.
11771292
1178-
:param Nullable start_date: Optional starting date (inclusive)
1179-
:param Nullable end_date: Optional ending date (exclusive)
1293+
:param Nullable start_date: Optional starting date (inclusive).
1294+
:param Nullable end_date: Optional ending date (exclusive).
11801295
:rtype: :class:`dropbox.team.GetDevicesReport`
11811296
:raises: :class:`dropbox.exceptions.ApiError`
11821297
@@ -1199,8 +1314,8 @@ def team_reports_get_membership(self,
11991314
"""
12001315
Retrieves reporting data about a team's membership.
12011316
1202-
:param Nullable start_date: Optional starting date (inclusive)
1203-
:param Nullable end_date: Optional ending date (exclusive)
1317+
:param Nullable start_date: Optional starting date (inclusive).
1318+
:param Nullable end_date: Optional ending date (exclusive).
12041319
:rtype: :class:`dropbox.team.GetMembershipReport`
12051320
:raises: :class:`dropbox.exceptions.ApiError`
12061321
@@ -1223,8 +1338,8 @@ def team_reports_get_storage(self,
12231338
"""
12241339
Retrieves reporting data about a team's storage usage.
12251340
1226-
:param Nullable start_date: Optional starting date (inclusive)
1227-
:param Nullable end_date: Optional ending date (exclusive)
1341+
:param Nullable start_date: Optional starting date (inclusive).
1342+
:param Nullable end_date: Optional ending date (exclusive).
12281343
:rtype: :class:`dropbox.team.GetStorageReport`
12291344
:raises: :class:`dropbox.exceptions.ApiError`
12301345

0 commit comments

Comments
 (0)