Skip to content

Commit de474e1

Browse files
DropboxBotEugene Che
andauthored
Automated Spec Update (#351)
85f2eff045cf6df883f269ed6ecd9b39457077ed Change Notes: team_log_generated Namespace - Add MemberTransferredInternalFields structs team_members Namespace - Add members/set_profile_photo:2, members/delete_profile_photo:2, members/add/job_status/get:2, members/add:2, members/list/continue:2, members/get_info:2, members/set_profile:2, members/list:2 routes - Add TeamMemberInfoV2, TeamMemberInfoV2Result, MembersListV2Result, MembersGetInfoV2Arg, MembersGetInfoArgs, MembersGetInfoV2Result, MemberAddArgBase, MemberAddArg extends MemberAddArgBase, MemberAddV2Arg extends MemberAddArgBase, MembersAddArgBase, MembersAddV2Arg extends MembersAddArgBase, MembersAddArg extends MembersAddArgBase structs - Add MembersGetInfoItemV2 extends MembersGetInfoItemBase, MemberAddV2Result extends MemberAddResultBase, MembersAddLaunchV2Result extends async.LaunchResultBase, MembersAddJobStatusV2Result extends async.PollResultBase unions - Remove MembersGetInfoArgs, MemberAddArg, MembersAddArg structs Co-authored-by: Eugene Che <eugeneyche@dropbox.com> Co-authored-by: DropboxBot <DropboxBot@users.noreply.github.com> Co-authored-by: Eugene Che <eugeneyche@dropbox.com>
1 parent 0ed9550 commit de474e1

File tree

4 files changed

+1214
-180
lines changed

4 files changed

+1214
-180
lines changed

dropbox/base_team.py

Lines changed: 219 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1197,6 +1197,36 @@ def team_member_space_limits_set_custom_quota(self,
11971197
)
11981198
return r
11991199

1200+
def team_members_add_v2(self,
1201+
new_members,
1202+
force_async=False):
1203+
"""
1204+
Adds members to a team. Permission : Team member management A maximum of
1205+
20 members can be specified in a single call. If no Dropbox account
1206+
exists with the email address specified, a new Dropbox account will be
1207+
created with the given email address, and that account will be invited
1208+
to the team. If a personal Dropbox account exists with the email address
1209+
specified in the call, this call will create a placeholder Dropbox
1210+
account for the user on the team and send an email inviting the user to
1211+
migrate their existing personal account onto the team. Team member
1212+
management apps are required to set an initial given_name and surname
1213+
for a user to use in the team invitation and for 'Perform as team
1214+
member' actions taken on the user before they become 'active'.
1215+
1216+
:param List[:class:`dropbox.team.MemberAddV2Arg`] new_members: Details
1217+
of new members to be added to the team.
1218+
:rtype: :class:`dropbox.team.MembersAddLaunchV2Result`
1219+
"""
1220+
arg = team.MembersAddV2Arg(new_members,
1221+
force_async)
1222+
r = self.request(
1223+
team.members_add_v2,
1224+
'team',
1225+
arg,
1226+
None,
1227+
)
1228+
return r
1229+
12001230
def team_members_add(self,
12011231
new_members,
12021232
force_async=False):
@@ -1215,8 +1245,6 @@ def team_members_add(self,
12151245
12161246
:param List[:class:`dropbox.team.MemberAddArg`] new_members: Details of
12171247
new members to be added to the team.
1218-
:param bool force_async: Whether to force the add to happen
1219-
asynchronously.
12201248
:rtype: :class:`dropbox.team.MembersAddLaunch`
12211249
"""
12221250
arg = team.MembersAddArg(new_members,
@@ -1229,6 +1257,30 @@ def team_members_add(self,
12291257
)
12301258
return r
12311259

1260+
def team_members_add_job_status_get_v2(self,
1261+
async_job_id):
1262+
"""
1263+
Once an async_job_id is returned from :meth:`team_members_add_v2` , use
1264+
this to poll the status of the asynchronous request. Permission : Team
1265+
member management.
1266+
1267+
:param str async_job_id: Id of the asynchronous job. This is the value
1268+
of a response returned from the method that launched the job.
1269+
:rtype: :class:`dropbox.team.MembersAddJobStatusV2Result`
1270+
:raises: :class:`.exceptions.ApiError`
1271+
1272+
If this raises, ApiError will contain:
1273+
:class:`dropbox.team.PollError`
1274+
"""
1275+
arg = async_.PollArg(async_job_id)
1276+
r = self.request(
1277+
team.members_add_job_status_get_v2,
1278+
'team',
1279+
arg,
1280+
None,
1281+
)
1282+
return r
1283+
12321284
def team_members_add_job_status_get(self,
12331285
async_job_id):
12341286
"""
@@ -1253,6 +1305,29 @@ def team_members_add_job_status_get(self,
12531305
)
12541306
return r
12551307

1308+
def team_members_delete_profile_photo_v2(self,
1309+
user):
1310+
"""
1311+
Deletes a team member's profile photo. Permission : Team member
1312+
management.
1313+
1314+
:param user: Identity of the user whose profile photo will be deleted.
1315+
:type user: :class:`dropbox.team.UserSelectorArg`
1316+
:rtype: :class:`dropbox.team.TeamMemberInfoV2Result`
1317+
:raises: :class:`.exceptions.ApiError`
1318+
1319+
If this raises, ApiError will contain:
1320+
:class:`dropbox.team.MembersDeleteProfilePhotoError`
1321+
"""
1322+
arg = team.MembersDeleteProfilePhotoArg(user)
1323+
r = self.request(
1324+
team.members_delete_profile_photo_v2,
1325+
'team',
1326+
arg,
1327+
None,
1328+
)
1329+
return r
1330+
12561331
def team_members_delete_profile_photo(self,
12571332
user):
12581333
"""
@@ -1293,6 +1368,31 @@ def team_members_get_available_team_member_roles(self):
12931368
)
12941369
return r
12951370

1371+
def team_members_get_info_v2(self,
1372+
members):
1373+
"""
1374+
Returns information about multiple team members. Permission : Team
1375+
information This endpoint will return
1376+
``MembersGetInfoItem.id_not_found``, for IDs (or emails) that cannot be
1377+
matched to a valid team member.
1378+
1379+
:param List[:class:`dropbox.team.UserSelectorArg`] members: List of team
1380+
members.
1381+
:rtype: :class:`dropbox.team.MembersGetInfoV2Result`
1382+
:raises: :class:`.exceptions.ApiError`
1383+
1384+
If this raises, ApiError will contain:
1385+
:class:`dropbox.team.MembersGetInfoError`
1386+
"""
1387+
arg = team.MembersGetInfoV2Arg(members)
1388+
r = self.request(
1389+
team.members_get_info_v2,
1390+
'team',
1391+
arg,
1392+
None,
1393+
)
1394+
return r
1395+
12961396
def team_members_get_info(self,
12971397
members):
12981398
"""
@@ -1318,6 +1418,30 @@ def team_members_get_info(self,
13181418
)
13191419
return r
13201420

1421+
def team_members_list_v2(self,
1422+
limit=1000,
1423+
include_removed=False):
1424+
"""
1425+
Lists members of a team. Permission : Team information.
1426+
1427+
:param int limit: Number of results to return per call.
1428+
:param bool include_removed: Whether to return removed members.
1429+
:rtype: :class:`dropbox.team.MembersListV2Result`
1430+
:raises: :class:`.exceptions.ApiError`
1431+
1432+
If this raises, ApiError will contain:
1433+
:class:`dropbox.team.MembersListError`
1434+
"""
1435+
arg = team.MembersListArg(limit,
1436+
include_removed)
1437+
r = self.request(
1438+
team.members_list_v2,
1439+
'team',
1440+
arg,
1441+
None,
1442+
)
1443+
return r
1444+
13211445
def team_members_list(self,
13221446
limit=1000,
13231447
include_removed=False):
@@ -1342,6 +1466,30 @@ def team_members_list(self,
13421466
)
13431467
return r
13441468

1469+
def team_members_list_continue_v2(self,
1470+
cursor):
1471+
"""
1472+
Once a cursor has been retrieved from :meth:`team_members_list_v2`, use
1473+
this to paginate through all team members. Permission : Team
1474+
information.
1475+
1476+
:param str cursor: Indicates from what point to get the next set of
1477+
members.
1478+
:rtype: :class:`dropbox.team.MembersListV2Result`
1479+
:raises: :class:`.exceptions.ApiError`
1480+
1481+
If this raises, ApiError will contain:
1482+
:class:`dropbox.team.MembersListContinueError`
1483+
"""
1484+
arg = team.MembersListContinueArg(cursor)
1485+
r = self.request(
1486+
team.members_list_continue_v2,
1487+
'team',
1488+
arg,
1489+
None,
1490+
)
1491+
return r
1492+
13451493
def team_members_list_continue(self,
13461494
cursor):
13471495
"""
@@ -1679,6 +1827,48 @@ def team_members_set_admin_permissions(self,
16791827
)
16801828
return r
16811829

1830+
def team_members_set_profile_v2(self,
1831+
user,
1832+
new_email=None,
1833+
new_external_id=None,
1834+
new_given_name=None,
1835+
new_surname=None,
1836+
new_persistent_id=None,
1837+
new_is_directory_restricted=None):
1838+
"""
1839+
Updates a team member's profile. Permission : Team member management.
1840+
1841+
:param user: Identity of user whose profile will be set.
1842+
:type user: :class:`dropbox.team.UserSelectorArg`
1843+
:param Nullable[str] new_email: New email for member.
1844+
:param Nullable[str] new_external_id: New external ID for member.
1845+
:param Nullable[str] new_given_name: New given name for member.
1846+
:param Nullable[str] new_surname: New surname for member.
1847+
:param Nullable[str] new_persistent_id: New persistent ID. This field
1848+
only available to teams using persistent ID SAML configuration.
1849+
:param Nullable[bool] new_is_directory_restricted: New value for whether
1850+
the user is a directory restricted user.
1851+
:rtype: :class:`dropbox.team.TeamMemberInfoV2Result`
1852+
:raises: :class:`.exceptions.ApiError`
1853+
1854+
If this raises, ApiError will contain:
1855+
:class:`dropbox.team.MembersSetProfileError`
1856+
"""
1857+
arg = team.MembersSetProfileArg(user,
1858+
new_email,
1859+
new_external_id,
1860+
new_given_name,
1861+
new_surname,
1862+
new_persistent_id,
1863+
new_is_directory_restricted)
1864+
r = self.request(
1865+
team.members_set_profile_v2,
1866+
'team',
1867+
arg,
1868+
None,
1869+
)
1870+
return r
1871+
16821872
def team_members_set_profile(self,
16831873
user,
16841874
new_email=None,
@@ -1721,6 +1911,33 @@ def team_members_set_profile(self,
17211911
)
17221912
return r
17231913

1914+
def team_members_set_profile_photo_v2(self,
1915+
user,
1916+
photo):
1917+
"""
1918+
Updates a team member's profile photo. Permission : Team member
1919+
management.
1920+
1921+
:param user: Identity of the user whose profile photo will be set.
1922+
:type user: :class:`dropbox.team.UserSelectorArg`
1923+
:param photo: Image to set as the member's new profile photo.
1924+
:type photo: :class:`dropbox.team.PhotoSourceArg`
1925+
:rtype: :class:`dropbox.team.TeamMemberInfoV2Result`
1926+
:raises: :class:`.exceptions.ApiError`
1927+
1928+
If this raises, ApiError will contain:
1929+
:class:`dropbox.team.MembersSetProfilePhotoError`
1930+
"""
1931+
arg = team.MembersSetProfilePhotoArg(user,
1932+
photo)
1933+
r = self.request(
1934+
team.members_set_profile_photo_v2,
1935+
'team',
1936+
arg,
1937+
None,
1938+
)
1939+
return r
1940+
17241941
def team_members_set_profile_photo(self,
17251942
user,
17261943
photo):

0 commit comments

Comments
 (0)