3.0.0 • Published 5 years ago

@datafire/dropbox_data v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/dropbox_data

Client library for Dropbox API

Installation and Usage

npm install --save @datafire/dropbox_data
let dropbox_data = require('@datafire/dropbox_data').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Dropbox API

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

dropbox_data.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

dropbox_data.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

team.reports.get_devices.post

Retrieves reporting data about a team's linked devices.

dropbox_data.team.reports.get_devices.post({}, context)

Input

  • input object
    • body object
      • start_date string: Optional starting date (inclusive). This field is optional.
      • end_date string: Optional ending date (exclusive). This field is optional.

Output

Output schema unknown

files.move.post

Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved.

dropbox_data.files.move.post({}, context)

Input

  • input object
    • body object
      • allow_ownership_transfer boolean: Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. The default for this field is False.
      • from_path string: Path in the user's Dropbox to be copied or moved.
      • to_path string: Path in the user's Dropbox that is the destination.
      • autorename boolean: If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. The default for this field is False.
      • allow_shared_folder boolean: If true, will copy contents in shared folder, otherwise RelocationError.cant_copy_shared_folder will be returned if from_path contains shared folder. This field is always true for . The default for this field is False.

Output

  • output object
    • name required string
    • client_modified required string
    • rev required string
    • .tag required string
    • path_display required string
    • has_explicit_shared_members required boolean
    • path_lower required string
    • server_modified required string
    • sharing_info required object
      • read_only required boolean
      • parent_shared_folder_id required string
      • modified_by required string
    • property_groups required array
      • items object
        • fields required array
          • items object
            • name required string
            • value required string
        • template_id required string
    • content_hash required string
    • id required string
    • size required integer

sharing.relinquish_file_membership.post

The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.

dropbox_data.sharing.relinquish_file_membership.post({}, context)

Input

  • input object
    • body object
      • file string: The path or id for the file.

Output

Output schema unknown

sharing.mount_folder.post

The current user mounts the designated folder. Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.

dropbox_data.sharing.mount_folder.post({}, context)

Input

  • input object
    • body object
      • shared_folder_id string: The ID of the shared folder to mount.

Output

  • output object
    • name required string
    • time_invited required string
    • preview_url required string
    • access_type required object
      • .tag required string
    • access_inheritance required object
      • .tag required string
    • shared_folder_id required string
    • path_lower required string
    • policy required object
      • resolved_member_policy required object
        • .tag required string
      • acl_update_policy required object
        • .tag required string
      • shared_link_policy required object
        • .tag required string
      • member_policy required object
        • .tag required string
    • is_inside_team_folder required boolean
    • permissions required array
    • is_team_folder required boolean
    • link_metadata required object
      • url required string
      • link_permissions required array
        • items object
          • action required object
            • .tag required string
          • allow required boolean
      • password_protected required boolean
      • current_audience required object
        • .tag required string
      • audience_options required array
        • items object
          • .tag required string

sharing.get_folder_metadata.post

Returns shared folder metadata by its folder ID.

dropbox_data.sharing.get_folder_metadata.post({}, context)

Input

  • input object
    • body object
      • shared_folder_id string: The ID for the shared folder.
      • actions string: A list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder. This field is optional. Change folder options, such as who can be invited to join the folder. Disable viewer information for this folder. Change or edit contents of the folder. Enable viewer information on the folder. Invite a user or group to join the folder with read and write permission. Invite a user or group to join the folder with read permission. Invite a user or group to join the folder with read permission but no comment permissions. Relinquish one's own membership in the folder. Unmount the folder. Stop sharing this folder. Keep a copy of the contents upon leaving or being kicked from the folder. Field is deprecated. Use create_link instead. Create a shared link for folder. Set whether the folder inherits permissions from its parent.

Output

  • output object
    • name required string
    • time_invited required string
    • preview_url required string
    • access_type required object
      • .tag required string
    • access_inheritance required object
      • .tag required string
    • shared_folder_id required string
    • path_lower required string
    • policy required object
      • resolved_member_policy required object
        • .tag required string
      • acl_update_policy required object
        • .tag required string
      • shared_link_policy required object
        • .tag required string
      • member_policy required object
        • .tag required string
    • is_inside_team_folder required boolean
    • permissions required array
    • is_team_folder required boolean
    • link_metadata required object
      • url required string
      • link_permissions required array
        • items object
          • action required object
            • .tag required string
          • allow required boolean
      • password_protected required boolean
      • current_audience required object
        • .tag required string
      • audience_options required array
        • items object
          • .tag required string

users.get_current_account.post

Get information about the current user's account.

dropbox_data.users.get_current_account.post(null, context)

Input

This action has no parameters

Output

  • output object
    • referral_link required string
    • account_type required object
      • .tag required string
    • account_id required string
    • locale required string
    • email_verified required boolean
    • team_member_id required string
    • root_info required object
      • root_namespace_id required string
      • .tag required string
      • home_namespace_id required string
    • disabled required boolean
    • is_paired required boolean
    • team required object
      • sharing_policies required object
        • shared_folder_join_policy required object
          • .tag required string
        • shared_folder_member_policy required object
          • .tag required string
        • shared_link_create_policy required object
          • .tag required string
      • office_addin_policy required object
        • .tag required string
      • id required string
      • name required string
    • country required string
    • email required string
    • name required object
      • familiar_name required string
      • display_name required string
      • surname required string
      • given_name required string
      • abbreviated_name required string

paper.docs.users.list.post

Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date. The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link.

dropbox_data.paper.docs.users.list.post({}, context)

Input

  • input object
    • body object
      • limit integer: Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error. The default for this field is 1000.
      • doc_id string: The Paper doc ID.
      • filter_by string: Specify this attribute if you want to obtain users that have already accessed the Paper doc. The default for this union is shared. all users who have visited the Paper doc. All uses who are shared on the Paper doc. This includes all users who have visited the Paper doc as well as those who have not.

Output

  • output object
    • cursor required object
      • expiration required string
      • value required string
    • has_more required boolean
    • doc_owner required object
      • team_member_id required string
      • same_team required boolean
      • display_name required string
      • email required string
      • account_id required string
    • users required array
      • items object
        • permission_level required object
          • .tag required string
        • user required object
          • team_member_id required string
          • same_team required boolean
          • display_name required string
          • email required string
          • account_id required string
    • invitees required array
      • items object
        • permission_level required object
          • .tag required string
        • invitee required object
          • .tag required string
          • email required string

users.get_space_usage.post

Get the space usage information for the current user's account.

dropbox_data.users.get_space_usage.post(null, context)

Input

This action has no parameters

Output

  • output object
    • allocation required object
      • .tag required string
      • allocated required integer
    • used required integer

paper.docs.sharing_policy.get.post

Gets the default sharing policy for the given Paper doc.

dropbox_data.paper.docs.sharing_policy.get.post({}, context)

Input

  • input object
    • body object
      • doc_id string: The Paper doc ID.

Output

  • output object
    • team_sharing_policy required object
      • .tag required string
    • public_sharing_policy required object
      • .tag required string

team.groups.update.post

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

dropbox_data.team.groups.update.post({}, context)

Input

  • input object
    • body object
      • return_members boolean: 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. The default for this field is True.
      • new_group_name string: Optional argument. Set group name to this if provided. This field is optional.
      • group string: Specify a group. Group ID. External ID of the group.
      • new_group_management_type string: Set new group management type, if provided. This field is optional. A group which is managed by selected users. A group which is managed by team admins only. A group which is managed automatically by Dropbox.
      • new_group_external_id string: 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. This field is optional.

Output

  • output object
    • member_count required integer
    • created required integer
    • group_management_type required object
      • .tag required string
    • group_name required string
    • members required array
      • items object
        • profile required object
          • status required object
            • .tag required string
          • membership_type required object
            • .tag required string
          • name required object
            • familiar_name required string
            • display_name required string
            • surname required string
            • given_name required string
            • abbreviated_name required string
          • email_verified required boolean
          • team_member_id required string
          • joined_on required string
          • email required string
          • account_id required string
        • access_type required object
          • .tag required string
    • group_id required string

sharing.revoke_shared_link.post

Revoke a shared link. Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the list_shared_links with the file as the ListSharedLinksArg.path argument.

dropbox_data.sharing.revoke_shared_link.post({}, context)

Input

  • input object
    • body object
      • url string: URL of the shared link.

Output

Output schema unknown

team.team_folder.permanently_delete.post

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

dropbox_data.team.team_folder.permanently_delete.post({}, context)

Input

  • input object
    • body object
      • team_folder_id string: The ID of the team folder.

Output

Output schema unknown

sharing.update_file_member.post

Changes a member's access on a shared file.

dropbox_data.sharing.update_file_member.post({}, context)

Input

  • input object
    • body object
      • member string: The member whose access we are changing. Dropbox account, team member, or group ID of member. E-mail address of member.
      • access_level string: The new access level for the member. The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder's policies using . The collaborator can both view and edit the shared folder. The collaborator can only view the shared folder. The collaborator can only view the shared folder and does not have any access to comments.
      • file string: File for which we are changing a member's access.

Output

Output schema unknown

team.members.send_welcome_email.post

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.

dropbox_data.team.members.send_welcome_email.post({}, context)

Input

  • input object
    • body object
      • team_member_id string
      • external_id string
      • email string

Output

Output schema unknown

team.members.suspend.post

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.

dropbox_data.team.members.suspend.post({}, context)

Input

  • input object
    • body object
      • user string: Identity of user to remove/suspend/have their files moved.
      • wipe_data boolean: If provided, controls if the user's data will be deleted on their linked devices. The default for this field is True.

Output

Output schema unknown

files.upload_session.finish_batch.check.post

Returns the status of an asynchronous job for upload_session/finish_batch . If success, it returns list of result for each entry.

dropbox_data.files.upload_session.finish_batch.check.post({}, context)

Input

  • input object
    • body object
      • async_job_id string: Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Output

  • output object
    • .tag required string
    • entries required array
      • items object
        • name required string
        • client_modified required string
        • rev required string
        • .tag required string
        • path_display required string
        • has_explicit_shared_members required boolean
        • path_lower required string
        • server_modified required string
        • sharing_info required object
          • read_only required boolean
          • parent_shared_folder_id required string
          • modified_by required string
        • property_groups required array
          • items object
            • fields required array
            • template_id required string
        • content_hash required string
        • id required string
        • size required integer

sharing.list_folder_members.continue.post

Once a cursor has been retrieved from list_folder_members , use this to paginate through all shared folder members.

dropbox_data.sharing.list_folder_members.continue.post({}, context)

Input

  • input object
    • body object
      • cursor string: The cursor returned by your last call to or .

Output

  • output object
    • cursor required string
    • users required array
      • items object
        • is_inherited required boolean
        • user required object
          • team_member_id required string
          • same_team required boolean
          • display_name required string
          • email required string
          • account_id required string
        • access_type required object
          • .tag required string
        • permissions required array
    • groups required array
      • items object
        • is_inherited required boolean
        • group required object
          • is_owner required boolean
          • member_count required integer
          • same_team required boolean
          • is_member required boolean
          • group_management_type required object
            • .tag required string
          • group_name required string
          • group_id required string
          • group_type required object
            • .tag required string
        • access_type required object
          • .tag required string
        • permissions required array
    • invitees required array
      • items object
        • invitee required object
          • .tag required string
          • email required string
        • is_inherited required boolean
        • access_type required object
          • .tag required string
        • permissions required array

team.members.list.post

Lists members of a team. Permission : Team information.

dropbox_data.team.members.list.post({}, context)

Input

  • input object
    • body object
      • include_removed boolean: Whether to return removed members. The default for this field is False.
      • limit integer: Number of results to return per call. The default for this field is 1000.

Output

  • output object
    • cursor required string
    • has_more required boolean
    • members required array
      • items object
        • profile required object
          • status required object
            • .tag required string
          • membership_type required object
            • .tag required string
          • name required object
            • familiar_name required string
            • display_name required string
            • surname required string
            • given_name required string
            • abbreviated_name required string
          • email_verified required boolean
          • team_member_id required string
          • member_folder_id required string
          • groups required array
            • items string
          • joined_on required string
          • external_id required string
          • email required string
          • account_id required string
        • role required object
          • .tag required string

deprecated.properties.template.list.post

dropbox_data.deprecated.properties.template.list.post(null, context)

Input

This action has no parameters

Output

  • output object
    • template_ids required array
      • items string

files.create_folder_batch.check.post

Returns the status of an asynchronous job for create_folder_batch . If success, it returns list of result for each entry.

dropbox_data.files.create_folder_batch.check.post({}, context)

Input

  • input object
    • body object
      • async_job_id string: Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Output

  • output object
    • .tag required string
    • entries required array
      • items object
        • .tag required string
        • metadata required object
          • name required string
          • path_display required string
          • path_lower required string
          • sharing_info required object
            • read_only required boolean
            • parent_shared_folder_id required string
            • traverse_only required boolean
            • no_access required boolean
          • property_groups required array
            • items object
          • id required string

team.devices.revoke_device_session_batch.post

Revoke a list of device sessions of team members.

dropbox_data.team.devices.revoke_device_session_batch.post({}, context)

Input

  • input object
    • body object
      • revoke_devices string: End an active session. The session id. The unique id of the member owning the device. Unlink a linked desktop device. The session id. The unique id of the member owning the device. 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). The default for this field is False. Unlink a linked mobile device. The session id. The unique id of the member owning the device.

Output

Output schema unknown

files.restore.post

Restore a specific revision of a file to the given path.

dropbox_data.files.restore.post({}, context)

Input

  • input object
    • body object
      • path string: The path to save the restored file.
      • rev string: The revision to restore.

Output

  • output object
    • name required string
    • client_modified required string
    • rev required string
    • path_display required string
    • has_explicit_shared_members required boolean
    • path_lower required string
    • server_modified required string
    • sharing_info required object
      • read_only required boolean
      • parent_shared_folder_id required string
      • modified_by required string
    • property_groups required array
      • items object
        • fields required array
          • items object
            • name required string
            • value required string
        • template_id required string
    • content_hash required string
    • id required string
    • size required integer

file_requests.update.post

Update a file request.

dropbox_data.file_requests.update.post({}, context)

Input

  • input object
    • body object
      • open boolean: Whether to set this file request as open or closed. This field is optional.
      • destination string: The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder. This field is optional.
      • deadline string: The new deadline for the file request. Deadlines can only be set by Professional and Business accounts. The default for this union is no_update. Do not change the file request's deadline. If None, the file request's deadline is cleared. This field is optional. The deadline for this file request. If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.
      • id string: The ID of the file request to update.
      • title string: The new title of the file request. Must not be empty. This field is optional.

Output

  • output object
    • created required string
    • url required string
    • title required string
    • destination required string
    • file_count required integer
    • is_open required boolean
    • id required string
    • deadline required object
      • deadline required string
      • allow_late_uploads required object
        • .tag required string

file_properties.templates.remove_for_team.post

Permanently removes the specified template created from templates/add_for_user . All properties associated with the template will also be removed. This action cannot be undone.

dropbox_data.file_properties.templates.remove_for_team.post({}, context)

Input

  • input object
    • body object
      • template_id string: An identifier for a template created by or .

Output

Output schema unknown

paper.docs.get_folder_info.post

Retrieves folder information for the given Paper doc. This includes: - folder sharing policy; permissions for subfolders are set by the top-level folder. - full 'filepath', i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc. Note: If the Paper doc is not in any folder (aka unfiled) the response will be empty.

dropbox_data.paper.docs.get_folder_info.post({}, context)

Input

  • input object
    • body object
      • doc_id string: The Paper doc ID.

Output

  • output object
    • folders required array
      • items object
        • id required string
        • name required string
    • folder_sharing_policy_type required object
      • .tag required string

files.copy_batch.post

Copy multiple files or folders to different locations at once in the user's Dropbox. This route will replace copy_batch . The main difference is this route will return stutus for each entry, while copy_batch raises failure if any entry fails. This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use copy_batch/check:2 to check the job status.

dropbox_data.files.copy_batch.post({}, context)

Input

  • input object
    • body object
      • autorename boolean: If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. The default for this field is False.
      • entries string: List of entries to be moved or copied. Each entry is RelocationPath. Path in the user's Dropbox to be copied or moved. Path in the user's Dropbox that is the destination.

Output

  • output object
    • .tag required string
    • entries required array
      • items object
        • metadata required object
          • name required string
          • client_modified required string
          • rev required string
          • .tag required string
          • path_display required string
          • has_explicit_shared_members required boolean
          • path_lower required string
          • server_modified required string
          • sharing_info required object
            • read_only required boolean
            • parent_shared_folder_id required string
            • modified_by required string
          • property_groups required array
            • items object
          • content_hash required string
          • id required string
          • size required integer

file_properties.properties.search.post

Search across property templates for particular property field values.

dropbox_data.file_properties.properties.search.post({}, context)

Input

  • input object
    • body object
      • template_filter string: Filter results to contain only properties associated with these template IDs. The default for this union is filter_none. Only templates with an ID in the supplied list will be returned (a subset of templates will be returned). No templates will be filtered from the result (all templates will be returned).
      • queries string: Queries to search. The property field value for which to search across templates. The mode with which to perform the search. Search for a value associated with this field name. The logical operator with which to append the query. The default for this union is or_operator. Append a query with an "or" operator.

Output

  • output object
    • matches required array
      • items object
        • path required string
        • is_deleted required boolean
        • id required string
        • property_groups required array
          • items object
            • fields required array
            • template_id required string

team.groups.delete.post

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

dropbox_data.team.groups.delete.post({}, context)

Input

  • input object
    • body object
      • group_external_id string: External ID of the group.
      • group_id string: Group ID.

Output

  • output object
    • .tag required string

team.linked_apps.revoke_linked_app.post

Revoke a linked application of the team member.

dropbox_data.team.linked_apps.revoke_linked_app.post({}, context)

Input

  • input object
    • body object
      • keep_app_folder boolean: Whether to keep the application dedicated folder (in case the application uses one). The default for this field is True.
      • team_member_id string: The unique id of the member owning the device.
      • app_id string: The application's unique id.

Output

Output schema unknown

team.groups.get_info.post

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

dropbox_data.team.groups.get_info.post({}, context)

Input

  • input object
    • body object
      • group_external_ids string: List of external IDs of groups.
      • group_ids string: List of group IDs.

Output

Output schema unknown

files.delete.post

Delete the file or folder at a given path. If the path is a folder, all its contents will be deleted too. A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

dropbox_data.files.delete.post({}, context)

Input

  • input object
    • body object
      • path string: Path in the user's Dropbox to delete.
      • parent_rev string: Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder. This field is optional.

Output

  • output object
    • name required string
    • client_modified required string
    • rev required string
    • .tag required string
    • path_display required string
    • has_explicit_shared_members required boolean
    • path_lower required string
    • server_modified required string
    • sharing_info required object
      • read_only required boolean
      • parent_shared_folder_id required string
      • modified_by required string
    • property_groups required array
      • items object
        • fields required array
          • items object
            • name required string
            • value required string
        • template_id required string
    • content_hash required string
    • id required string
    • size required integer

oauth2.authorize.get

This starts the OAuth 2.0 authorization flow. This isn't an API call—it's the web page that lets the user sign in to Dropbox and authorize your app. After the user decides whether or not to authorize your app, they will be redirected to the URI specified by redirect_uri . OAuth 2.0 supports two authorization flows: The code flow returns a code via the redirect_uri callback which should then be converted into a bearer token using the /oauth2/token call . This is the recommended flow for apps that are running on a server. The token or implicit grant flow returns the bearer token via the redirect_uri callback, rather than requiring your app to make a second call to a server. This is useful for pure client-side apps, such as mobile apps or JavaScript-based apps. For more information on the two flows, see Section 1.3 of the OAuth 2 spec . If the user isn't already signed in to the Dropbox web site, they will be prompted to do so on this web page. Note that some users use their Google account to sign in to Dropbox. In order to comply with Google's policy against processing the OAuth flow inside a web-view , you should not display this web page inside a web-view.

dropbox_data.oauth2.authorize.get({}, context)

Input

  • input object
    • response_type string: The grant type requested, either or .
    • client_id string: The app's key, found in the .
    • redirect_uri string: Where to redirect the user after authorization has completed. This must be the exact URI registered in the ; even 'localhost' must be listed if it is used for testing. All redirect URIs must be HTTPS except for localhost URIs. A redirect URI is required for the flow, but optional for the flow. If the redirect URI is omitted, the will be presented directly to the user and they will be invited to enter the information in your app.
    • state string: Up to 500 bytes of arbitrary data that will be passed back to your redirect URI. This parameter should be used to protect against cross-site request forgery (CSRF). See Sections and of the OAuth 2.0 threat model spec.
    • require_role string: If this parameter is specified, the user will be asked to authorize with a particular type of Dropbox account, either for a team account or for a personal account. Your app should still verify the type of Dropbox account after authorization since the user could modify or remove the parameter.
    • force_reapprove boolean: Whether or not to force the user to approve the app again if they've already done so. If (default), a user who has already approved the application may be automatically redirected to the URI specified by . If , the user will not be automatically redirected and will have to approve the app again.
    • disable_signup boolean: When true (default is false) users will not be able to sign up for a Dropbox account via the authorization page. Instead, the authorization page will show a link to the Dropbox iOS app in the App Store. This is only intended for use when necessary for compliance with App Store policies.
    • locale string: If the locale specified is a , Dropbox will direct users to a translated version of the authorization website. Locale tags should be .
    • force_reauthentication boolean: When (default is ) users will be signed out if they are currently signed in. This will make sure the user is brought to a page where they can create a new account or sign in to another account. This should only be used when there is a definite reason to believe that the user needs to sign in to a new or different account.

Output

Output schema unknown

sharing.check_share_job_status.post

Returns the status of an asynchronous job for sharing a folder.

dropbox_data.sharing.check_share_job_status.post({}, context)

Input

  • input object
    • body object
      • async_job_id string: Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Output

  • output object
    • name required string
    • time_invited required string
    • preview_url required string
    • access_type required object
      • .tag required string
    • access_inheritance required object
      • .tag required string
    • .tag required string
    • path_lower required string
    • policy required object
      • resolved_member_policy required object
        • .tag required string
      • acl_update_policy required object
        • .tag required string
      • shared_link_policy required object
        • .tag required string
      • member_policy required object
        • .tag required string
    • is_inside_team_folder required boolean
    • permissions required array
    • shared_folder_id required string
    • is_team_folder required boolean
    • link_metadata required object
      • url required string
      • link_permissions required array
        • items object
          • action required object
            • .tag required string
          • allow required boolean
      • password_protected required boolean
      • current_audience required object
        • .tag required string
      • audience_options required array
        • items object
          • .tag required string

files.get_thumbnail_batch.post

Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

dropbox_data.files.get_thumbnail_batch.post({}, context)

Input

  • input object
    • body object
      • entries string: List of files to get thumbnails. The path to the image file you want to thumbnail. The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. The default for this union is jpeg. The size for the thumbnail image. The default for this union is w64h64. 32 by 32 px. 64 by 64 px. 128 by 128 px. 256 by 256 px. 480 by 320 px. 640 by 480 px. 960 by 640 px. 1024 by 768 px. 2048 by 1536 px. How to resize and crop the image to achieve the desired size. The default for this union is strict. Scale down the image to fit within the given size. Scale down the image to fit within the given size or its transpose. Scale down the image to completely cover the given size or its transpose.

Output

  • output object
    • entries required array
      • items object
        • .tag required string
        • thumbnail required string
        • metadata required object
          • name required string
          • client_modified required string
          • rev required string
          • path_display required string
          • has_explicit_shared_members required boolean
          • path_lower required string
          • server_modified required string
          • sharing_info required object
            • read_only required boolean
            • parent_shared_folder_id required string
            • modified_by required string
          • property_groups required array
            • items object
          • content_hash required string
          • id required string
          • size required integer

sharing.remove_folder_member.post

Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.

dropbox_data.sharing.remove_folder_member.post({}, context)

Input

  • input object
    • body object
      • member string: The member to remove from the folder. Dropbox account, team member, or group ID of member. E-mail address of member.
      • shared_folder_id string: The ID for the shared folder.
      • leave_a_copy boolean: If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. Also, this must be set to false when kicking a group.

Output

  • output object
    • .tag required string
    • async_job_id required string

team.token.get_authenticated_admin.post

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

dropbox_data.team.token.get_authenticated_admin.post(null, context)

Input

This action has no parameters

Output

  • output object
    • admin_profile required object
      • status required object
        • .tag required string
      • membership_type required object
        • .tag required string
      • name required object
        • familiar_name required string
        • display_name required string
        • surname required string
        • given_name required string
        • abbreviated_name required string
      • email_verified required boolean
      • team_member_id required string
      • member_folder_id required string
      • groups required array
        • items string
      • joined_on required string
      • external_id required string
      • email required string
      • account_id required string

sharing.update_folder_member.post

Allows an owner or editor of a shared folder to update another member's permissions.

dropbox_data.sharing.update_folder_member.post({}, context)

Input

  • input object
    • body object
      • member string: The member of the shared folder to update. Only the MemberSelector.dropbox_id may be set at this time. Dropbox account, team member, or group ID of member. E-mail address of member.
      • access_level string: The new access level for member. AccessLevel.owner is disallowed. The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder's policies using . The collaborator can both view and edit the shared folder. The collaborator can only view the shared folder. The collaborator can only view the shared folder and does not have any access to comments.
      • shared_folder_id string: The ID for the shared folder.

Output

Output schema unknown

sharing.create_shared_link_with_settings.post

Create a shared link with custom settings. If no settings are given then the default visibility is RequestedVisibility.public (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).

dropbox_data.sharing.create_shared_link_with_settings.post({}, context)

Input

  • input object
    • body object
      • path string: The path to be shared by the shared link.
      • settings string: The requested settings for the newly created shared link. This field is optional. The requested access for this shared link. This field is optional. Anyone who has received the link can access it. No login required. Only members of the same team can access the link. Login is required. A link-specific password is required to access the link. Login is not required. If requested_visibility is RequestedVisibility.password this is needed to specify the password to access the link. This field is optional. Expiration time of the shared link. By default the link won't expire. This field is optional.

Output

  • output object
    • name required string
    • url required string
    • client_modified required string
    • rev required string
    • .tag required string
    • path_lower required string
    • server_modified required string
    • link_permissions required object
      • resolved_visibility required object
        • .tag required string
      • can_revoke required boolean
      • revoke_failure_reason required object
        • .tag required string
    • team_member_info required object
      • member_id required string
      • display_name required string
      • team_info required object
        • id required string
        • name required string
    • id required string
    • size required integer

file_properties.properties.update.post

Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of properties/overwrite when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas properties/overwrite will delete any fields that are omitted from a property group.

dropbox_data.file_properties.properties.update.post({}, context)

Input

  • input object
    • body object
      • path string: A unique identifier for the file or folder.
      • update_property_groups string: The property groups "delta" updates to apply. A unique identifier for a property template. Property fields to update. If the property field already exists, it is updated. If the property field doesn't exist, the property group is added. This field is optional. Key of the property field associated with a file and template. Keys can be up to 256 bytes. Value of the property field associated with a file and template. Values can be up to 1024 bytes. Property fields to remove (by name), provided they exist. This field is optional.

Output

Output schema unknown

team_log.get_events.continue.post

Once a cursor has been retrieved from get_events , use this to paginate through all events. Permission : Team Auditing.

dropbox_data.team_log.get_events.continue.post({}, context)

Input

  • input object
    • body object
      • cursor string: Indicates from what point to get the next set of events.

Output

  • output object
    • cursor required string
    • has_more required boolean
    • events required array
      • items object
        • origin required object
          • geo_location required object
            • city required string
            • region required string
            • ip_address required string
            • country required string
          • access_method required object
            • .tag required string
            • end_user required object
        • event_type required object
          • .tag required string
          • description required string
        • timestamp required string
        • actor required object
          • .tag required string
          • user required object
            • display_name required string
            • account_id required string
            • team_member_id required string
            • .tag required string
            • member_external_id required string
            • email required string
        • participants required array
          • items object
            • .tag required string
            • user required object
        • event_category required object
          • .tag required string
        • context required object
          • display_name required string
          • account_id required string
          • team_member_id required string
          • .tag required string
          • member_external_id required string
          • email required string
        • details required object
          • shared_content_owner required object
            • display_name required string
            • account_id required string
            • team_member_id required string
            • .tag required string
            • member_external_id required string
            • email required string
          • .tag required string
          • shared_content_link required string
          • shared_content_access_level required object
            • .tag required string
        • assets required array
          • items object
            • path required object
            • .tag required string
            • display_name required string
            • file_id required string
        • involve_non_team_member required boolean

team.members.add.post

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

dropbox_data.team.members.add.post({}, context)

Input

  • input object
    • body object
      • new_members string: Details of new members to be added to the team. Member's first name. This field is optional. Member's last name. This field is optional. External ID for member. This field is optional. Persistent ID for member. This field is only available to teams using persistent ID SAML configuration. This field is optional. 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. The default for this field is True. The default for this union is member_only. User is an administrator of the team - has all permissions. User can do most user provisioning, de-provisioning and management. User can do a limited set of common support tasks for existing users. User is not an admin of the team. Whether a user is directory restricted. This field is optional.
      • force_async boolean: Whether to force the add to happen asynchronously. The default for this field is False.

Output

  • output object
    • .tag required string
    • complete required array
      • items object
        • profile required object
          • status required object
            • .tag required string
          • membership_type required object
            • .tag required string
          • name required object
            • familiar_name required string
            • display_name required string
            • surname required string
            • given_name required string
            • abbreviated_name required string
          • email_verified required boolean
          • team_member_id required string
          • member_folder_id required string
          • groups required array
            • items string
          • joined_on required string
          • external_id required string
          • email required string
          • account_id required string
        • .tag required string
        • role required object
          • .tag required string

team.namespaces.list.post

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.

dropbox_data.team.namespaces.list.post({}, context)

Input

  • input object
    • body object
      • limit deprecated integer: Field is deprecated. Specifying a value here has no effect. The default for this field is 1000.

Output

  • output object
    • cursor required string
    • has_more required boolean
    • namespaces required array
      • items object
        • team_member_id string
        • namespace_id required string
        • name required string
        • namespace_type required object
          • .tag required string

team.team_folder.archive.post

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

dropbox_data.team.team_folder.archive.post({}, context)

Input

  • input object
    • body object
      • team_folder_id string: The ID of the team folder.
      • force_async_off boolean: Whether to force the archive to happen synchronously. The default for this field is False.

Output

  • output object
    • status required object
      • .tag required string
    • name required string
    • team_folder_id required string
    • is_team_shared_dropbox required boolean
    • .tag required string
    • sync_setting required object
      • .tag required string
    • content_sync_settings required array
      • items object
        • sync_setting required object
          • .tag required string
        • id required string

sharing.unmount_folder.post

The current user unmounts the designated folder. They can re-mount the folder at a later time using mount_folder .

dropbox_data.sharing.unmount_folder.post({}, context)

Input

  • input object
    • body object
      • shared_folder_id string: The ID for the shared folder.

Output

Output schema unknown

sharing.list_received_files.post

Returns a list of all files shared with current user. Does not include files the user has received via shared folders, and does not include unclaimed invitations.

dropbox_data.sharing.list_received_files.post({}, context)

Input

  • input object
    • body object
      • limit integer: Number of files to return max per query. Defaults to 100 if no limit is specified. The default for this field is 100.
      • actions string: A list of FileActions corresponding to FilePermissions that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file. This field is optional. Disable viewer information on the file. Change or edit contents of the file. Enable viewer information on the file. Add a member with view permissions. Add a member with view permissions but no comment permissions. Add a member with edit permissions. Stop sharing this file. Relinquish one's own membership to the file. Field is deprecated. Use create_link instead. Create a shared link to the file.

Output

  • output object
    • cursor required string
    • entries required array
      • items object
        • owner_team required object
          • id required string
          • name required string
        • name required string
        • time_invited required string
        • preview_url required string
        • access_type required object
          • .tag required string
        • owner_display_names required array
          • items string
        • path_display required string
        • path_lower required string
        • policy required object
          • resolved_member_policy required object
            • .tag required string
          • acl_update_policy required object
            • .tag required string
          • shared_link_policy required object
            • .tag required string
          • member_policy required object
            • .tag required string
        • id required string
        • permissions required array

team.member_space_limits.excluded_users.add.post

Add users to member space limits excluded users list.

dropbox_data.team.member_space_limits.excluded_users.add.post({}, context)

Input

  • input object
    • body object
      • users string: List of users to be added/removed. This field is optional.

Output

  • output object
    • status required object
      • .tag required string

paper.docs.sharing_policy.set.post

Sets the default sharing policy for the given Paper doc. The default 'team_sharing_policy' can be changed only by teams, omit this field for personal accounts. Note: 'public_sharing_policy' cannot be set to the value 'disabled' because this setting can be changed only via the team admin console.

dropbox_data.paper.docs.sharing_policy.set.post({}, context)

Input

  • input object
    • body object
      • doc_id string: The Paper doc ID.
      • sharing_policy string: The default sharing policy to be set for the Paper doc. This value applies to the non-team members. This field is optional. Users who have a link to this doc can edit it. Users who have a link to this doc can view and comment on it. Users must be explicitly invited to this doc. Value used to indicate that doc sharing is enabled only within team. This value applies to the team members only. The value is null for all personal accounts. This field is optional. Users who have a link to this doc can edit it. Users who have a link to this doc can view and comment on it. Users must be explicitly invited to this doc.

Output

Output schema unknown

file_requests.get.post

Returns the specified file request.

dropbox_data.file_requests.get.post({}, context)

Input

  • input object
    • body object
      • id string: The ID of the file request to retrieve.

Output

  • output object
    • created required string
    • url required string
    • title required string
    • destination required string
    • file_count required integer
    • is_open required boolean
    • id required string
    • deadline required object
      • deadline required string
      • allow_late_uploads required object
        • .tag required string

file_requests.create.post

Creates a file request for this user.

dropbox_data.file_requests.create.post({}, context)

Input

  • input object
    • body object
      • open boolean: Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later. The default for this field is True.
      • destination string: The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
      • deadline string: The deadline for the file request. Deadlines can only be set by Professional and Business accounts. This field is optional. The deadline for this file request. If set, allow uploads after the deadline has passed. These uploads will be marked overdue. This field is optional.
      • title string: The title of the file request. Must not be empty.

Output

  • output object
    • created required string
    • url required string
    • title required string
    • destination required string
    • file_count required integer
    • is_open required boolean
    • id required string
    • deadline required object
      • deadline required string
      • allow_late_uploads required object
        • .tag required string

files.copy_batch.check.post

Returns the status of an asynchronous job for copy_batch:2 . It returns list of results for each entry.

dropbox_data.files.copy_batch.check.post({}, context)

Input

  • input object
    • body object
      • async_job_id string: Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Output

  • output object
    • .tag required string
    • entries required array
      • items object
        • metadata required object
          • name required string
          • client_modified required string
          • rev required string
          • .tag required string
          • path_display required string
          • has_explicit_shared_members required boolean
          • path_lower required string
          • server_modified required string
          • sharing_info required object
            • read_only required boolean
            • parent_shared_folder_id required string
            • modified_by required string
          • property_groups required array
            • items object
          • content_hash required string
          • id required string
          • size required integer

files.move_batch.check.post

Returns the status of an asynchronous job for move_batch:2 . It returns list of results for each entry.

dropbox_data.files.move_batch.check.post({}, context)

Input

  • input object
    • body object
      • async_job_id string: Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Output

  • output object
    • .tag required string
    • entries required array
      • items object
        • metadata required object
          • name required string
          • client_modified required string
          • rev required string
          • .tag required string
          • path_display required string
          • has_explicit_shared_members required boolean
          • path_lower required string
          • server_modified required string
          • sharing_info required object
            • read_only required boolean
            • parent_shared_folder_id required string
            • modified_by required string
          • property_groups required array
            • items object
          • content_hash required string
          • id required string
          • size required integer

deprecated.remove_file_member.post

Identical to remove_file_member_2 but with less information returned.

dropbox_data.deprecated.remove_file_member.post({}, context)

Input

  • input object
    • body object
      • member string: Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Dropbox account, team member, or group ID of member. E-mail address of member.
      • file string: File from which to remove members.

Output

  • output object
    • .tag required string

team.namespaces.list.continue.post

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

dropbox_data.team.namespaces.list.continue.post({}, context)

Input

  • input object
    • body object
      • cursor string: Indicates from what po
datafire
@everything-registry/sub-chunk-221@infinitebrahmanuniverse/nolb-_datafire_d@zalastax/nolb-_datafire_d
3.0.0

5 years ago

2.0.0

7 years ago