TeamRoutes

open class TeamRoutes

Copyright © 2016 Dropbox, Inc. All rights reserved.

Auto-generated by Stone, do not modify.

Routes for the team namespace

  • List all device sessions of a team’s member.

    Declaration

    Swift

    @discardableResult
    open func devicesListMemberDevices(teamMemberId: String, includeWebSessions: Bool = true, includeDesktopClients: Bool = true, includeMobileClients: Bool = true) -> RpcRequest<Team.ListMemberDevicesResultSerializer, Team.ListMemberDevicesErrorSerializer>

    Parameters

    teamMemberId

    The team’s member id.

    includeWebSessions

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

    includeDesktopClients

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

    includeMobileClients

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

    Return Value

    Through the response callback, the caller will receive a Team.ListMemberDevicesResult object on success or a Team.ListMemberDevicesError object on failure.

  • List all device sessions of a team. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func devicesListMembersDevices(cursor: String? = nil, includeWebSessions: Bool = true, includeDesktopClients: Bool = true, includeMobileClients: Bool = true) -> RpcRequest<Team.ListMembersDevicesResultSerializer, Team.ListMembersDevicesErrorSerializer>

    Parameters

    cursor

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

    includeWebSessions

    Whether to list web sessions of the team members.

    includeDesktopClients

    Whether to list desktop clients of the team members.

    includeMobileClients

    Whether to list mobile clients of the team members.

    Return Value

    Through the response callback, the caller will receive a Team.ListMembersDevicesResult object on success or a Team.ListMembersDevicesError object on failure.

  • Revoke a device session of a team’s member.

    Declaration

    Swift

    @discardableResult
    open func devicesRevokeDeviceSession(revokeDeviceSessionArg: Team.RevokeDeviceSessionArg) -> RpcRequest<VoidSerializer, Team.RevokeDeviceSessionErrorSerializer>

    Parameters

    revokeDeviceSessionArg

    The RevokeDeviceSessionArg union

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.RevokeDeviceSessionError object on failure.

  • Revoke a list of device sessions of team members.

    Declaration

    Swift

    @discardableResult
    open func devicesRevokeDeviceSessionBatch(revokeDevices: Array<Team.RevokeDeviceSessionArg>) -> RpcRequest<Team.RevokeDeviceSessionBatchResultSerializer, Team.RevokeDeviceSessionBatchErrorSerializer>

    Return Value

    Through the response callback, the caller will receive a Team.RevokeDeviceSessionBatchResult object on success or a Team.RevokeDeviceSessionBatchError object on failure.

  • Get the values for one or more featues. This route allows you to check your account’s capability for what feature you can access or what value you have for certain features. Permission : Team information.

    Declaration

    Swift

    @discardableResult
    open func featuresGetValues(features: Array<Team.Feature>) -> RpcRequest<Team.FeaturesGetValuesBatchResultSerializer, Team.FeaturesGetValuesBatchErrorSerializer>

    Parameters

    features

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

    Return Value

    Through the response callback, the caller will receive a Team.FeaturesGetValuesBatchResult object on success or a Team.FeaturesGetValuesBatchError object on failure.

  • Retrieves information about a team.

    Declaration

    Swift

    @discardableResult
    open func getInfo() -> RpcRequest<Team.TeamGetInfoResultSerializer, VoidSerializer>

    Return Value

    Through the response callback, the caller will receive a Team.TeamGetInfoResult object on success or a Void object on failure.

  • Creates a new, empty group, with a requested name. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsCreate(groupName: String, groupExternalId: String? = nil, groupManagementType: TeamCommon.GroupManagementType? = nil) -> RpcRequest<Team.GroupFullInfoSerializer, Team.GroupCreateErrorSerializer>

    Parameters

    groupName

    Group name.

    groupExternalId

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

    groupManagementType

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

    Return Value

    Through the response callback, the caller will receive a Team.GroupFullInfo object on success or a Team.GroupCreateError object on failure.

  • Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsDelete(groupSelector: Team.GroupSelector) -> RpcRequest<Async.LaunchEmptyResultSerializer, Team.GroupDeleteErrorSerializer>

    Parameters

    groupSelector

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

    Return Value

    Through the response callback, the caller will receive a Async.LaunchEmptyResult object on success or a Team.GroupDeleteError object on failure.

  • Retrieves information about one or more groups. Note that the optional field members in GroupFullInfo is not returned for system-managed groups. Permission : Team Information.

    Declaration

    Swift

    @discardableResult
    open func groupsGetInfo(groupsSelector: Team.GroupsSelector) -> RpcRequest<ArraySerializer<Team.GroupsGetInfoItemSerializer>, Team.GroupsGetInfoErrorSerializer>

    Parameters

    groupsSelector

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

    Return Value

    Through the response callback, the caller will receive a Array<Team.GroupsGetInfoItem> object on success or a Team.GroupsGetInfoError object on failure.

  • Once an async_job_id is returned from groupsDelete, groupsMembersAdd , or groupsMembersRemove use this method to poll the status of granting/revoking group members’ access to group-owned resources. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsJobStatusGet(asyncJobId: String) -> RpcRequest<Async.PollEmptyResultSerializer, Team.GroupsPollErrorSerializer>

    Parameters

    asyncJobId

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

    Return Value

    Through the response callback, the caller will receive a Async.PollEmptyResult object on success or a Team.GroupsPollError object on failure.

  • Lists groups on a team. Permission : Team Information.

    Declaration

    Swift

    @discardableResult
    open func groupsList(limit: UInt32 = 1000) -> RpcRequest<Team.GroupsListResultSerializer, VoidSerializer>

    Parameters

    limit

    Number of results to return per call.

    Return Value

    Through the response callback, the caller will receive a Team.GroupsListResult object on success or a Void object on failure.

  • Once a cursor has been retrieved from groupsList, use this to paginate through all groups. Permission : Team Information.

    Declaration

    Swift

    @discardableResult
    open func groupsListContinue(cursor: String) -> RpcRequest<Team.GroupsListResultSerializer, Team.GroupsListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.GroupsListResult object on success or a Team.GroupsListContinueError object on failure.

  • Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsMembersAdd(group: Team.GroupSelector, members: Array<Team.MemberAccess>, returnMembers: Bool = true) -> RpcRequest<Team.GroupMembersChangeResultSerializer, Team.GroupMembersAddErrorSerializer>

    Parameters

    group

    Group to which users will be added.

    members

    List of users to be added to the group.

    Return Value

    Through the response callback, the caller will receive a Team.GroupMembersChangeResult object on success or a Team.GroupMembersAddError object on failure.

  • Lists members of a group. Permission : Team Information.

    Declaration

    Swift

    @discardableResult
    open func groupsMembersList(group: Team.GroupSelector, limit: UInt32 = 1000) -> RpcRequest<Team.GroupsMembersListResultSerializer, Team.GroupSelectorErrorSerializer>

    Parameters

    group

    The group whose members are to be listed.

    limit

    Number of results to return per call.

    Return Value

    Through the response callback, the caller will receive a Team.GroupsMembersListResult object on success or a Team.GroupSelectorError object on failure.

  • Once a cursor has been retrieved from groupsMembersList, use this to paginate through all members of the group. Permission : Team information.

    Declaration

    Swift

    @discardableResult
    open func groupsMembersListContinue(cursor: String) -> RpcRequest<Team.GroupsMembersListResultSerializer, Team.GroupsMembersListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.GroupsMembersListResult object on success or a Team.GroupsMembersListContinueError object on failure.

  • Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsMembersRemove(group: Team.GroupSelector, users: Array<Team.UserSelectorArg>, returnMembers: Bool = true) -> RpcRequest<Team.GroupMembersChangeResultSerializer, Team.GroupMembersRemoveErrorSerializer>

    Parameters

    group

    Group from which users will be removed.

    users

    List of users to be removed from the group.

    Return Value

    Through the response callback, the caller will receive a Team.GroupMembersChangeResult object on success or a Team.GroupMembersRemoveError object on failure.

  • Sets a member’s access type in a group. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsMembersSetAccessType(group: Team.GroupSelector, user: Team.UserSelectorArg, accessType: Team.GroupAccessType, returnMembers: Bool = true) -> RpcRequest<ArraySerializer<Team.GroupsGetInfoItemSerializer>, Team.GroupMemberSetAccessTypeErrorSerializer>

    Parameters

    accessType

    New group access type the user will have.

    returnMembers

    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 Value

    Through the response callback, the caller will receive a Array<Team.GroupsGetInfoItem> object on success or a Team.GroupMemberSetAccessTypeError object on failure.

  • Updates a group’s name and/or external ID. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func groupsUpdate(group: Team.GroupSelector, returnMembers: Bool = true, newGroupName: String? = nil, newGroupExternalId: String? = nil, newGroupManagementType: TeamCommon.GroupManagementType? = nil) -> RpcRequest<Team.GroupFullInfoSerializer, Team.GroupUpdateErrorSerializer>

    Parameters

    group

    Specify a group.

    newGroupName

    Optional argument. Set group name to this if provided.

    newGroupExternalId

    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.

    newGroupManagementType

    Set new group management type, if provided.

    Return Value

    Through the response callback, the caller will receive a Team.GroupFullInfo object on success or a Team.GroupUpdateError object on failure.

  • List all linked applications of the team member. Note, this endpoint does not list any team-linked applications.

    Declaration

    Swift

    @discardableResult
    open func linkedAppsListMemberLinkedApps(teamMemberId: String) -> RpcRequest<Team.ListMemberAppsResultSerializer, Team.ListMemberAppsErrorSerializer>

    Parameters

    teamMemberId

    The team member id.

    Return Value

    Through the response callback, the caller will receive a Team.ListMemberAppsResult object on success or a Team.ListMemberAppsError object on failure.

  • List all applications linked to the team members’ accounts. Note, this endpoint does not list any team-linked applications.

    Declaration

    Swift

    @discardableResult
    open func linkedAppsListMembersLinkedApps(cursor: String? = nil) -> RpcRequest<Team.ListMembersAppsResultSerializer, Team.ListMembersAppsErrorSerializer>

    Parameters

    cursor

    At the first call to the linkedAppsListMembersLinkedApps 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 Value

    Through the response callback, the caller will receive a Team.ListMembersAppsResult object on success or a Team.ListMembersAppsError object on failure.

  • Revoke a linked application of the team member.

    Declaration

    Swift

    @discardableResult
    open func linkedAppsRevokeLinkedApp(appId: String, teamMemberId: String, keepAppFolder: Bool = true) -> RpcRequest<VoidSerializer, Team.RevokeLinkedAppErrorSerializer>

    Parameters

    appId

    The application’s unique id.

    teamMemberId

    The unique id of the member owning the device.

    keepAppFolder

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

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.RevokeLinkedAppError object on failure.

  • Revoke a list of linked applications of the team members.

    Declaration

    Swift

    @discardableResult
    open func linkedAppsRevokeLinkedAppBatch(revokeLinkedApp: Array<Team.RevokeLinkedApiAppArg>) -> RpcRequest<Team.RevokeLinkedAppBatchResultSerializer, Team.RevokeLinkedAppBatchErrorSerializer>

    Return Value

    Through the response callback, the caller will receive a Team.RevokeLinkedAppBatchResult object on success or a Team.RevokeLinkedAppBatchError object on failure.

  • Add users to member space limits excluded users list.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsExcludedUsersAdd(users: Array<Team.UserSelectorArg>? = nil) -> RpcRequest<Team.ExcludedUsersUpdateResultSerializer, Team.ExcludedUsersUpdateErrorSerializer>

    Parameters

    users

    List of users to be added/removed.

    Return Value

    Through the response callback, the caller will receive a Team.ExcludedUsersUpdateResult object on success or a Team.ExcludedUsersUpdateError object on failure.

  • List member space limits excluded users.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsExcludedUsersList(limit: UInt32 = 1000) -> RpcRequest<Team.ExcludedUsersListResultSerializer, Team.ExcludedUsersListErrorSerializer>

    Parameters

    limit

    Number of results to return per call.

    Return Value

    Through the response callback, the caller will receive a Team.ExcludedUsersListResult object on success or a Team.ExcludedUsersListError object on failure.

  • Continue listing member space limits excluded users.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsExcludedUsersListContinue(cursor: String) -> RpcRequest<Team.ExcludedUsersListResultSerializer, Team.ExcludedUsersListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.ExcludedUsersListResult object on success or a Team.ExcludedUsersListContinueError object on failure.

  • Remove users from member space limits excluded users list.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsExcludedUsersRemove(users: Array<Team.UserSelectorArg>? = nil) -> RpcRequest<Team.ExcludedUsersUpdateResultSerializer, Team.ExcludedUsersUpdateErrorSerializer>

    Parameters

    users

    List of users to be added/removed.

    Return Value

    Through the response callback, the caller will receive a Team.ExcludedUsersUpdateResult object on success or a Team.ExcludedUsersUpdateError object on failure.

  • Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsGetCustomQuota(users: Array<Team.UserSelectorArg>) -> RpcRequest<ArraySerializer<Team.CustomQuotaResultSerializer>, Team.CustomQuotaErrorSerializer>

    Parameters

    users

    List of users.

    Return Value

    Through the response callback, the caller will receive a Array<Team.CustomQuotaResult> object on success or a Team.CustomQuotaError object on failure.

  • Remove users custom quota. A maximum of 1000 members can be specified in a single call.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsRemoveCustomQuota(users: Array<Team.UserSelectorArg>) -> RpcRequest<ArraySerializer<Team.RemoveCustomQuotaResultSerializer>, Team.CustomQuotaErrorSerializer>

    Parameters

    users

    List of users.

    Return Value

    Through the response callback, the caller will receive a Array<Team.RemoveCustomQuotaResult> object on success or a Team.CustomQuotaError object on failure.

  • Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.

    Declaration

    Swift

    @discardableResult
    open func memberSpaceLimitsSetCustomQuota(usersAndQuotas: Array<Team.UserCustomQuotaArg>) -> RpcRequest<ArraySerializer<Team.CustomQuotaResultSerializer>, Team.SetCustomQuotaErrorSerializer>

    Parameters

    usersAndQuotas

    List of users and their custom quotas.

    Return Value

    Through the response callback, the caller will receive a Array<Team.CustomQuotaResult> object on success or a Team.SetCustomQuotaError object on failure.

  • Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for ‘Perform as team member’ actions taken on the user before they become ‘active’.

    Declaration

    Swift

    @discardableResult
    open func membersAdd(newMembers: Array<Team.MemberAddArg>, forceAsync: Bool = false) -> RpcRequest<Team.MembersAddLaunchSerializer, VoidSerializer>

    Parameters

    newMembers

    Details of new members to be added to the team.

    forceAsync

    Whether to force the add to happen asynchronously.

    Return Value

    Through the response callback, the caller will receive a Team.MembersAddLaunch object on success or a Void object on failure.

  • Once an async_job_id is returned from membersAdd , use this to poll the status of the asynchronous request. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersAddJobStatusGet(asyncJobId: String) -> RpcRequest<Team.MembersAddJobStatusSerializer, Async.PollErrorSerializer>

    Parameters

    asyncJobId

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

    Return Value

    Through the response callback, the caller will receive a Team.MembersAddJobStatus object on success or a Async.PollError object on failure.

  • Returns information about multiple team members. Permission : Team information This endpoint will return idNotFound in MembersGetInfoItem, for IDs (or emails) that cannot be matched to a valid team member.

    Declaration

    Swift

    @discardableResult
    open func membersGetInfo(members: Array<Team.UserSelectorArg>) -> RpcRequest<ArraySerializer<Team.MembersGetInfoItemSerializer>, Team.MembersGetInfoErrorSerializer>

    Parameters

    members

    List of team members.

    Return Value

    Through the response callback, the caller will receive a Array<Team.MembersGetInfoItem> object on success or a Team.MembersGetInfoError object on failure.

  • Lists members of a team. Permission : Team information.

    Declaration

    Swift

    @discardableResult
    open func membersList(limit: UInt32 = 1000, includeRemoved: Bool = false) -> RpcRequest<Team.MembersListResultSerializer, Team.MembersListErrorSerializer>

    Parameters

    limit

    Number of results to return per call.

    includeRemoved

    Whether to return removed members.

    Return Value

    Through the response callback, the caller will receive a Team.MembersListResult object on success or a Team.MembersListError object on failure.

  • Once a cursor has been retrieved from membersList, use this to paginate through all team members. Permission : Team information.

    Declaration

    Swift

    @discardableResult
    open func membersListContinue(cursor: String) -> RpcRequest<Team.MembersListResultSerializer, Team.MembersListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.MembersListResult object on success or a Team.MembersListContinueError object on failure.

  • Moves removed member’s files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll membersMoveFormerMemberFilesJobStatusCheck. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersMoveFormerMemberFiles(user: Team.UserSelectorArg, transferDestId: Team.UserSelectorArg, transferAdminId: Team.UserSelectorArg) -> RpcRequest<Async.LaunchEmptyResultSerializer, Team.MembersTransferFormerMembersFilesErrorSerializer>

    Parameters

    transferDestId

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

    transferAdminId

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

    Return Value

    Through the response callback, the caller will receive a Async.LaunchEmptyResult object on success or a Team.MembersTransferFormerMembersFilesError object on failure.

  • Once an async_job_id is returned from membersMoveFormerMemberFiles , use this to poll the status of the asynchronous request. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersMoveFormerMemberFilesJobStatusCheck(asyncJobId: String) -> RpcRequest<Async.PollEmptyResultSerializer, Async.PollErrorSerializer>

    Parameters

    asyncJobId

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

    Return Value

    Through the response callback, the caller will receive a Async.PollEmptyResult object on success or a Async.PollError object on failure.

  • Recover a deleted member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    Declaration

    Swift

    @discardableResult
    open func membersRecover(user: Team.UserSelectorArg) -> RpcRequest<VoidSerializer, Team.MembersRecoverErrorSerializer>

    Parameters

    user

    Identity of user to recover.

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.MembersRecoverError object on failure.

  • Removes a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. Accounts can be recovered via membersRecover for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling membersAdd while a user is still recoverable on your team will return with userAlreadyOnTeam in MemberAddResult. Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (120 days for most teams). This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll membersRemoveJobStatusGet.

    Declaration

    Swift

    @discardableResult
    open func membersRemove(user: Team.UserSelectorArg, wipeData: Bool = true, transferDestId: Team.UserSelectorArg? = nil, transferAdminId: Team.UserSelectorArg? = nil, keepAccount: Bool = false) -> RpcRequest<Async.LaunchEmptyResultSerializer, Team.MembersRemoveErrorSerializer>

    Parameters

    transferDestId

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

    transferAdminId

    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.

    keepAccount

    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 Value

    Through the response callback, the caller will receive a Async.LaunchEmptyResult object on success or a Team.MembersRemoveError object on failure.

  • Once an async_job_id is returned from membersRemove , use this to poll the status of the asynchronous request. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersRemoveJobStatusGet(asyncJobId: String) -> RpcRequest<Async.PollEmptyResultSerializer, Async.PollErrorSerializer>

    Parameters

    asyncJobId

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

    Return Value

    Through the response callback, the caller will receive a Async.PollEmptyResult object on success or a Async.PollError object on failure.

  • Sends welcome email to pending team member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. No-op if team member is not pending.

    Declaration

    Swift

    @discardableResult
    open func membersSendWelcomeEmail(userSelectorArg: Team.UserSelectorArg) -> RpcRequest<VoidSerializer, Team.MembersSendWelcomeErrorSerializer>

    Parameters

    userSelectorArg

    Argument for selecting a single user, either by team_member_id, external_id or email.

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.MembersSendWelcomeError object on failure.

  • Updates a team member’s permissions. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersSetAdminPermissions(user: Team.UserSelectorArg, newRole: Team.AdminTier) -> RpcRequest<Team.MembersSetPermissionsResultSerializer, Team.MembersSetPermissionsErrorSerializer>

    Parameters

    user

    Identity of user whose role will be set.

    newRole

    The new role of the member.

    Return Value

    Through the response callback, the caller will receive a Team.MembersSetPermissionsResult object on success or a Team.MembersSetPermissionsError object on failure.

  • Updates a team member’s profile. Permission : Team member management.

    Declaration

    Swift

    @discardableResult
    open func membersSetProfile(user: Team.UserSelectorArg, newEmail: String? = nil, newExternalId: String? = nil, newGivenName: String? = nil, newSurname: String? = nil, newPersistentId: String? = nil, newIsDirectoryRestricted: Bool? = nil) -> RpcRequest<Team.TeamMemberInfoSerializer, Team.MembersSetProfileErrorSerializer>

    Parameters

    user

    Identity of user whose profile will be set.

    newEmail

    New email for member.

    newExternalId

    New external ID for member.

    newGivenName

    New given name for member.

    newSurname

    New surname for member.

    newPersistentId

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

    newIsDirectoryRestricted

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

    Return Value

    Through the response callback, the caller will receive a Team.TeamMemberInfo object on success or a Team.MembersSetProfileError object on failure.

  • Suspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    Declaration

    Swift

    @discardableResult
    open func membersSuspend(user: Team.UserSelectorArg, wipeData: Bool = true) -> RpcRequest<VoidSerializer, Team.MembersSuspendErrorSerializer>

    Parameters

    wipeData

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

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.MembersSuspendError object on failure.

  • Unsuspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    Declaration

    Swift

    @discardableResult
    open func membersUnsuspend(user: Team.UserSelectorArg) -> RpcRequest<VoidSerializer, Team.MembersUnsuspendErrorSerializer>

    Parameters

    user

    Identity of user to unsuspend.

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.MembersUnsuspendError object on failure.

  • Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members’ home namespaces, and team members’ app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.

    Declaration

    Swift

    @discardableResult
    open func namespacesList(limit: UInt32 = 1000) -> RpcRequest<Team.TeamNamespacesListResultSerializer, Team.TeamNamespacesListErrorSerializer>

    Parameters

    limit

    Specifying a value here has no effect.

    Return Value

    Through the response callback, the caller will receive a Team.TeamNamespacesListResult object on success or a Team.TeamNamespacesListError object on failure.

  • Once a cursor has been retrieved from namespacesList, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.

    Declaration

    Swift

    @discardableResult
    open func namespacesListContinue(cursor: String) -> RpcRequest<Team.TeamNamespacesListResultSerializer, Team.TeamNamespacesListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.TeamNamespacesListResult object on success or a Team.TeamNamespacesListContinueError object on failure.

  • Retrieves reporting data about a team’s user activity.

    Declaration

    Swift

    @discardableResult
    open func reportsGetActivity(startDate: Date? = nil, endDate: Date? = nil) -> RpcRequest<Team.GetActivityReportSerializer, Team.DateRangeErrorSerializer>

    Parameters

    startDate

    Optional starting date (inclusive).

    endDate

    Optional ending date (exclusive).

    Return Value

    Through the response callback, the caller will receive a Team.GetActivityReport object on success or a Team.DateRangeError object on failure.

  • Retrieves reporting data about a team’s linked devices.

    Declaration

    Swift

    @discardableResult
    open func reportsGetDevices(startDate: Date? = nil, endDate: Date? = nil) -> RpcRequest<Team.GetDevicesReportSerializer, Team.DateRangeErrorSerializer>

    Parameters

    startDate

    Optional starting date (inclusive).

    endDate

    Optional ending date (exclusive).

    Return Value

    Through the response callback, the caller will receive a Team.GetDevicesReport object on success or a Team.DateRangeError object on failure.

  • Retrieves reporting data about a team’s membership.

    Declaration

    Swift

    @discardableResult
    open func reportsGetMembership(startDate: Date? = nil, endDate: Date? = nil) -> RpcRequest<Team.GetMembershipReportSerializer, Team.DateRangeErrorSerializer>

    Parameters

    startDate

    Optional starting date (inclusive).

    endDate

    Optional ending date (exclusive).

    Return Value

    Through the response callback, the caller will receive a Team.GetMembershipReport object on success or a Team.DateRangeError object on failure.

  • Retrieves reporting data about a team’s storage usage.

    Declaration

    Swift

    @discardableResult
    open func reportsGetStorage(startDate: Date? = nil, endDate: Date? = nil) -> RpcRequest<Team.GetStorageReportSerializer, Team.DateRangeErrorSerializer>

    Parameters

    startDate

    Optional starting date (inclusive).

    endDate

    Optional ending date (exclusive).

    Return Value

    Through the response callback, the caller will receive a Team.GetStorageReport object on success or a Team.DateRangeError object on failure.

  • Sets an archived team folder’s status to active. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderActivate(teamFolderId: String) -> RpcRequest<Team.TeamFolderMetadataSerializer, Team.TeamFolderActivateErrorSerializer>

    Parameters

    teamFolderId

    The ID of the team folder.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderMetadata object on success or a Team.TeamFolderActivateError object on failure.

  • Sets an active team folder’s status to archived and removes all folder and file members. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderArchive(teamFolderId: String, forceAsyncOff: Bool = false) -> RpcRequest<Team.TeamFolderArchiveLaunchSerializer, Team.TeamFolderArchiveErrorSerializer>

    Parameters

    forceAsyncOff

    Whether to force the archive to happen synchronously.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderArchiveLaunch object on success or a Team.TeamFolderArchiveError object on failure.

  • Returns the status of an asynchronous job for archiving a team folder. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderArchiveCheck(asyncJobId: String) -> RpcRequest<Team.TeamFolderArchiveJobStatusSerializer, Async.PollErrorSerializer>

    Parameters

    asyncJobId

    Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderArchiveJobStatus object on success or a Async.PollError object on failure.

  • Creates a new, active, team folder with no members. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderCreate(name: String, syncSetting: Files.SyncSettingArg? = nil) -> RpcRequest<Team.TeamFolderMetadataSerializer, Team.TeamFolderCreateErrorSerializer>

    Parameters

    name

    Name for the new team folder.

    syncSetting

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

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderMetadata object on success or a Team.TeamFolderCreateError object on failure.

  • Retrieves metadata for team folders. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderGetInfo(teamFolderIds: Array<String>) -> RpcRequest<ArraySerializer<Team.TeamFolderGetInfoItemSerializer>, VoidSerializer>

    Parameters

    teamFolderIds

    The list of team folder IDs.

    Return Value

    Through the response callback, the caller will receive a Array<Team.TeamFolderGetInfoItem> object on success or a Void object on failure.

  • Lists all team folders. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderList(limit: UInt32 = 1000) -> RpcRequest<Team.TeamFolderListResultSerializer, Team.TeamFolderListErrorSerializer>

    Parameters

    limit

    The maximum number of results to return per request.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderListResult object on success or a Team.TeamFolderListError object on failure.

  • Once a cursor has been retrieved from teamFolderList, use this to paginate through all team folders. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderListContinue(cursor: String) -> RpcRequest<Team.TeamFolderListResultSerializer, Team.TeamFolderListContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderListResult object on success or a Team.TeamFolderListContinueError object on failure.

  • Permanently deletes an archived team folder. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderPermanentlyDelete(teamFolderId: String) -> RpcRequest<VoidSerializer, Team.TeamFolderPermanentlyDeleteErrorSerializer>

    Parameters

    teamFolderId

    The ID of the team folder.

    Return Value

    Through the response callback, the caller will receive a Void object on success or a Team.TeamFolderPermanentlyDeleteError object on failure.

  • Changes an active team folder’s name. Permission : Team member file access.

    Declaration

    Swift

    @discardableResult
    open func teamFolderRename(teamFolderId: String, name: String) -> RpcRequest<Team.TeamFolderMetadataSerializer, Team.TeamFolderRenameErrorSerializer>

    Parameters

    name

    New team folder name.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderMetadata object on success or a Team.TeamFolderRenameError object on failure.

  • Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

    Declaration

    Swift

    @discardableResult
    open func teamFolderUpdateSyncSettings(teamFolderId: String, syncSetting: Files.SyncSettingArg? = nil, contentSyncSettings: Array<Files.ContentSyncSettingArg>? = nil) -> RpcRequest<Team.TeamFolderMetadataSerializer, Team.TeamFolderUpdateSyncSettingsErrorSerializer>

    Parameters

    syncSetting

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

    contentSyncSettings

    Sync settings to apply to contents of this team folder.

    Return Value

    Through the response callback, the caller will receive a Team.TeamFolderMetadata object on success or a Team.TeamFolderUpdateSyncSettingsError object on failure.

  • Returns the member profile of the admin who generated the team access token used to make the call.

    Declaration

    Swift

    @discardableResult
    open func tokenGetAuthenticatedAdmin() -> RpcRequest<Team.TokenGetAuthenticatedAdminResultSerializer, Team.TokenGetAuthenticatedAdminErrorSerializer>

    Return Value

    Through the response callback, the caller will receive a Team.TokenGetAuthenticatedAdminResult object on success or a Team.TokenGetAuthenticatedAdminError object on failure.